diff --git a/Auth0.podspec b/Auth0.podspec index 092b5601d..2706d2215 100644 --- a/Auth0.podspec +++ b/Auth0.podspec @@ -1,6 +1,6 @@ Pod::Spec.new do |s| s.name = 'Auth0' - s.version = '2.15.1' + s.version = '2.16.0' s.summary = "Auth0 SDK for Apple platforms" s.description = <<-DESC Auth0 SDK for iOS, macOS, tvOS, watchOS and visionOS apps. diff --git a/Auth0/Info.plist b/Auth0/Info.plist index cc701b063..c1fa97415 100644 --- a/Auth0/Info.plist +++ b/Auth0/Info.plist @@ -15,7 +15,7 @@ CFBundlePackageType FMWK CFBundleShortVersionString - 2.15.1 + 2.16.0 CFBundleSignature ???? CFBundleVersion diff --git a/Auth0/Version.swift b/Auth0/Version.swift index 0b94062a2..61d0943f3 100644 --- a/Auth0/Version.swift +++ b/Auth0/Version.swift @@ -1 +1 @@ -let version = "2.15.1" +let version = "2.16.0" diff --git a/CHANGELOG.md b/CHANGELOG.md index 857d68d41..b78f605e0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,22 @@ # Change Log +## [2.16.0](https://github.com/auth0/Auth0.swift/tree/2.16.0) (2025-12-11) +[Full Changelog](https://github.com/auth0/Auth0.swift/compare/2.15.1...2.16.0) + +**Added** +- Org support for custom token exchange [\#1035](https://github.com/auth0/Auth0.swift/pull/1035) ([NandanPrabhu](https://github.com/NandanPrabhu)) +- chore: Add OSLog support for better SDK debugging/DX and redact sensitive tokens logging. [\#1030](https://github.com/auth0/Auth0.swift/pull/1030) ([sanchitmehta94](https://github.com/sanchitmehta94)) +- Added Agents.md file [\#1027](https://github.com/auth0/Auth0.swift/pull/1027) ([NandanPrabhu](https://github.com/NandanPrabhu)) +- feat: Add configurable biometric authentication policies for CredentialsManager [\#1019](https://github.com/auth0/Auth0.swift/pull/1019) ([subhankarmaiti](https://github.com/subhankarmaiti)) +- refactor: Added two new fields to passkey authentication [\#1020](https://github.com/auth0/Auth0.swift/pull/1020) ([pmathew92](https://github.com/pmathew92)) +- docs: Add Ask DeepWiki badge to README [\#1014](https://github.com/auth0/Auth0.swift/pull/1014) ([arpit-jn](https://github.com/arpit-jn)) + +**Changed** +- refactor: updated the key logic for storing MRRT token [\#1031](https://github.com/auth0/Auth0.swift/pull/1031) ([pmathew92](https://github.com/pmathew92)) + +**Fixed** +- fix: Ensure biometric prompt is shown reliably with fresh LAContext for non-default policies [\#1028](https://github.com/auth0/Auth0.swift/pull/1028) ([subhankarmaiti](https://github.com/subhankarmaiti)) + ## [2.15.1](https://github.com/auth0/Auth0.swift/tree/2.15.1) (2025-10-03) [Full Changelog](https://github.com/auth0/Auth0.swift/compare/2.15.0...2.15.1) diff --git a/Gemfile.lock b/Gemfile.lock index 7c421c514..b38f1f51b 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -1,11 +1,9 @@ GEM remote: https://rubygems.org/ specs: - CFPropertyList (3.0.7) - base64 - nkf - rexml - activesupport (7.2.2.2) + CFPropertyList (3.0.8) + abbrev (0.1.2) + activesupport (7.2.3) base64 benchmark (>= 0.3) bigdecimal @@ -17,16 +15,16 @@ GEM minitest (>= 5.1) securerandom (>= 0.3) tzinfo (~> 2.0, >= 2.0.5) - addressable (2.8.7) - public_suffix (>= 2.0.2, < 7.0) + addressable (2.8.8) + public_suffix (>= 2.0.2, < 8.0) algoliasearch (1.27.5) httpclient (~> 2.8, >= 2.8.3) json (>= 1.5.1) artifactory (3.0.17) atomos (0.1.3) aws-eventstream (1.4.0) - aws-partitions (1.1168.0) - aws-sdk-core (3.233.0) + aws-partitions (1.1192.0) + aws-sdk-core (3.239.2) aws-eventstream (~> 1, >= 1.3.0) aws-partitions (~> 1, >= 1.992.0) aws-sigv4 (~> 1.9) @@ -34,19 +32,19 @@ GEM bigdecimal jmespath (~> 1, >= 1.6.1) logger - aws-sdk-kms (1.113.0) - aws-sdk-core (~> 3, >= 3.231.0) + aws-sdk-kms (1.118.0) + aws-sdk-core (~> 3, >= 3.239.1) aws-sigv4 (~> 1.5) - aws-sdk-s3 (1.199.1) - aws-sdk-core (~> 3, >= 3.231.0) + aws-sdk-s3 (1.206.0) + aws-sdk-core (~> 3, >= 3.234.0) aws-sdk-kms (~> 1) aws-sigv4 (~> 1.5) aws-sigv4 (1.12.1) aws-eventstream (~> 1, >= 1.0.2) babosa (1.0.4) base64 (0.3.0) - benchmark (0.4.1) - bigdecimal (3.2.3) + benchmark (0.5.0) + bigdecimal (3.3.1) claide (1.1.0) clamp (1.3.3) cocoapods (1.16.2) @@ -91,7 +89,8 @@ GEM commander (4.6.0) highline (~> 2.0.0) concurrent-ruby (1.3.5) - connection_pool (2.5.4) + connection_pool (3.0.2) + csv (3.3.5) declarative (0.0.20) digest-crc (0.7.0) rake (>= 12.0.0, < 14.0.0) @@ -100,8 +99,9 @@ GEM drb (2.2.3) emoji_regex (3.2.3) escape (0.0.4) - ethon (0.17.0) + ethon (0.18.0) ffi (>= 1.15.0) + logger excon (0.112.0) faraday (1.10.4) faraday-em_http (~> 1.0) @@ -115,9 +115,9 @@ GEM faraday-rack (~> 1.0) faraday-retry (~> 1.0) ruby2_keywords (>= 0.0.4) - faraday-cookie_jar (0.0.7) + faraday-cookie_jar (0.0.8) faraday (>= 0.8.0) - http-cookie (~> 1.0.0) + http-cookie (>= 1.0.0) faraday-em_http (1.0.0) faraday-em_synchrony (1.0.1) faraday-excon (1.1.0) @@ -132,8 +132,9 @@ GEM faraday_middleware (1.2.1) faraday (~> 1.0) fastimage (2.4.0) - fastlane (2.228.0) + fastlane (2.229.0) CFPropertyList (>= 2.3, < 4.0.0) + abbrev (~> 0.1.2) addressable (>= 2.8, < 3.0.0) artifactory (~> 3.0) aws-sdk-s3 (~> 1.0) @@ -141,6 +142,7 @@ GEM bundler (>= 1.12.0, < 3.0.0) colored (~> 1.2) commander (~> 4.6) + csv (~> 3.3) dotenv (>= 2.1.1, < 3.0.0) emoji_regex (>= 0.1, < 4.0) excon (>= 0.71.0, < 1.0.0) @@ -160,6 +162,7 @@ GEM jwt (>= 2.1.0, < 3) mini_magick (>= 4.9.4, < 5.0.0) multipart-post (>= 2.0.0, < 3.0.0) + mutex_m (~> 0.3.0) naturally (~> 2.2) optparse (>= 0.1.1, < 1.0.0) plist (>= 3.1.0, < 4.0.0) @@ -227,32 +230,31 @@ GEM i18n (1.14.7) concurrent-ruby (~> 1.0) jmespath (1.6.2) - json (2.15.0) + json (2.17.1) jwt (2.10.2) base64 logger (1.7.0) mini_magick (4.13.2) mini_mime (1.1.5) - minitest (5.25.5) + minitest (5.26.2) molinillo (0.8.0) - multi_json (1.17.0) + multi_json (1.18.0) multipart-post (2.4.1) mutex_m (0.3.0) nanaimo (0.4.0) nap (1.1.0) naturally (2.3.0) netrc (0.11.0) - nkf (0.2.0) nokogiri (1.18.10-arm64-darwin) racc (~> 1.4) nokogiri (1.18.10-x86_64-darwin) racc (~> 1.4) - optparse (0.6.0) + optparse (0.8.1) os (1.1.4) plist (3.7.2) public_suffix (4.0.7) racc (1.8.1) - rake (13.3.0) + rake (13.3.1) representable (3.2.0) declarative (< 0.1.0) trailblazer-option (>= 0.1.1, < 0.2.0) diff --git a/README.md b/README.md index c685fe885..21dced377 100644 --- a/README.md +++ b/README.md @@ -56,7 +56,7 @@ Then, select the dependency rule and press **Add Package**. Add the following line to your `Podfile`: ```ruby -pod 'Auth0', '~> 2.15' +pod 'Auth0', '~> 2.16' ``` Then, run `pod install`. @@ -66,7 +66,7 @@ Then, run `pod install`. Add the following line to your `Cartfile`: ```text -github "auth0/Auth0.swift" ~> 2.15 +github "auth0/Auth0.swift" ~> 2.16 ``` Then, run `carthage bootstrap --use-xcframeworks`. diff --git a/docs/data/documentation/auth0.json b/docs/data/documentation/auth0.json index cd41262b6..0115a054a 100644 --- a/docs/data/documentation/auth0.json +++ b/docs/data/documentation/auth0.json @@ -1 +1 @@ -{"metadata":{"symbolKind":"module","externalID":"Auth0","roleHeading":"Framework","modules":[{"name":"Auth0"}],"title":"Auth0","role":"collection"},"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserAgents","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens"],"anchor":"Articles","title":"Articles","generated":true},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"],"anchor":"Classes","title":"Classes","generated":true},{"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\/LoginPasskey","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccount","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountClient","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/NewPasskey","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SenderConstraining","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SignupPasskey","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"],"anchor":"Protocols","title":"Protocols","generated":true},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethods","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\/DPoP","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/EmailEnrollmentChallenge","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factor","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factors","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\/MyAccountError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PhoneEnrollmentChallenge","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RecoveryCodeEnrollmentChallenge","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge","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"],"anchor":"Structures","title":"Structures","generated":true},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/defaultScope"],"anchor":"Variables","title":"Variables","generated":true},{"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\/myAccount(token:domain:session:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/myAccount(token: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:)"],"anchor":"Functions","title":"Functions","generated":true},{"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\/MyAccountResult","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProvider","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProviderCallback","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult"],"anchor":"Type-Aliases","title":"Type Aliases","generated":true},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod"],"anchor":"Enumerations","title":"Enumerations","generated":true},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationServices","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift"],"anchor":"Extended-Modules","title":"Extended Modules","generated":true}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0"]}],"kind":"symbol","hierarchy":{"paths":[[]]},"abstract":[{"type":"text","text":"SDK for Apple platforms."}],"schemaVersion":{"patch":0,"major":0,"minor":3},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0"},"sections":[],"primaryContentSections":[{"content":[{"level":2,"anchor":"Overview","text":"Overview","type":"heading"},{"items":[{"content":[{"type":"paragraph","inlineContent":[{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","type":"reference","isActive":true},{"text":": Web-based authentication client.","type":"text"}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","isActive":true},{"type":"text","text":": Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain."}]}]},{"content":[{"type":"paragraph","inlineContent":[{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","type":"reference"},{"type":"text","text":": Client for the "},{"isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference"},{"type":"text","text":"."}]}]},{"content":[{"type":"paragraph","inlineContent":[{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccount","isActive":true,"type":"reference"},{"text":": Client for the My Account API.","type":"text"}]}]},{"content":[{"type":"paragraph","inlineContent":[{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"},{"type":"text","text":": Client for the Users endpoints of the "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"type":"text","text":"."}]}]}],"type":"unorderedList"}],"kind":"content"}],"references":{"https://auth0.com/docs/api/authentication":{"url":"https:\/\/auth0.com\/docs\/api\/authentication","title":"Authentication API","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","titleInlineContent":[{"type":"text","text":"Authentication API"}]},"doc://com.auth0.Auth0/documentation/Auth0/defaultScope":{"title":"defaultScope","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/defaultScope","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"defaultScope","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"kind":"symbol","abstract":[{"type":"text","text":"Default scope value used across Auth0.swift. Equals to "},{"type":"codeVoice","code":"openid profile email"},{"type":"text","text":"."}],"url":"\/documentation\/auth0\/defaultscope","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/webAuth(clientId:domain:session:)":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"webAuth"},{"kind":"text","text":"("},{"kind":"externalParam","text":"clientId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"domain"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"session"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSURLSession","text":"URLSession"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07WebAuthP","text":"WebAuth"}],"title":"webAuth(clientId:domain:session:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/webAuth(clientId:domain:session:)","kind":"symbol","abstract":[{"identifier":"https:\/\/auth0.com\/docs\/authenticate\/login\/auth0-universal-login","isActive":true,"type":"reference"},{"text":" client for performing web-based","type":"text"},{"text":" ","type":"text"},{"text":"authentication.","type":"text"}],"url":"\/documentation\/auth0\/webauth(clientid:domain:session:)","role":"symbol","type":"topic"},"https://auth0.com/docs/api/management/v2":{"url":"https:\/\/auth0.com\/docs\/api\/management\/v2","title":"Management API v2","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","titleInlineContent":[{"type":"text","text":"Management API v2"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationResult":{"type":"topic","kind":"symbol","navigatorTitle":[{"text":"AuthenticationResult","kind":"identifier"}],"url":"\/documentation\/auth0\/authenticationresult","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationResult","kind":"identifier"}],"abstract":[{"code":"Result","type":"codeVoice"},{"type":"text","text":" wrapper for Authentication API operations."}],"title":"AuthenticationResult","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationResult","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/DatabaseUser":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DatabaseUser","fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"text":"DatabaseUser","kind":"identifier"}],"url":"\/documentation\/auth0\/databaseuser","kind":"symbol","title":"DatabaseUser","abstract":[{"type":"text","text":"A newly created database user (just the email, username, and email verified flag)."}],"role":"symbol","navigatorTitle":[{"text":"DatabaseUser","kind":"identifier"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error":{"url":"\/documentation\/auth0\/auth0error","title":"Auth0Error","kind":"symbol","type":"topic","abstract":[{"type":"text","text":"Generic representation of Auth0 errors."}],"role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Auth0Error"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","navigatorTitle":[{"kind":"identifier","text":"Auth0Error"}]},"doc://com.auth0.Auth0/documentation/Auth0/authentication(session:bundle:)":{"title":"authentication(session:bundle:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"authentication"},{"kind":"text","text":"("},{"kind":"externalParam","text":"session"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSURLSession","text":"URLSession"},{"kind":"text","text":", "},{"kind":"externalParam","text":"bundle"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSBundle","text":"Bundle"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth014AuthenticationP","text":"Authentication"}],"kind":"symbol","url":"\/documentation\/auth0\/authentication(session:bundle:)","type":"topic","abstract":[{"type":"reference","isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"type":"text","text":" client to authenticate a user with Database, Social,"},{"type":"text","text":" "},{"type":"text","text":"Enterprise or Passwordless connections."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/authentication(session:bundle:)","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Telemetry":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Telemetry","kind":"identifier"}],"title":"Telemetry","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","url":"\/documentation\/auth0\/telemetry","kind":"symbol","abstract":[{"text":"Generates and sets the ","type":"text"},{"type":"codeVoice","code":"Auth0-Client"},{"text":" header.","type":"text"}],"role":"symbol","navigatorTitle":[{"text":"Telemetry","kind":"identifier"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/users(token:session:bundle:)":{"type":"topic","url":"\/documentation\/auth0\/users(token:session:bundle:)","abstract":[{"type":"reference","isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"type":"text","text":" client for performing operations with the Users endpoints."}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"users","kind":"identifier"},{"text":"(","kind":"text"},{"text":"token","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","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":"externalParam","text":"bundle"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSBundle","text":"Bundle"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth05UsersP","text":"Users"}],"title":"users(token:session:bundle:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/users(token:session:bundle:)","kind":"symbol","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserAgents":{"title":"ASWebAuthenticationSession vs SFSafariViewController (iOS)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserAgents","abstract":[],"kind":"article","type":"topic","role":"article","url":"\/documentation\/auth0\/useragents"},"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"required":true,"kind":"symbol","url":"\/documentation\/auth0\/users\/patch(_:attributes:)","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"patch"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"attributes"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","kind":"typeIdentifier","text":"UserPatchAttributes"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError"},{"kind":"text","text":">"}],"deprecated":true,"title":"patch(_:attributes:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","abstract":[{"type":"text","text":"Updates a user’s root values (those which are allowed to be updated)."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/EmailEnrollmentChallenge":{"title":"EmailEnrollmentChallenge","navigatorTitle":[{"text":"EmailEnrollmentChallenge","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/EmailEnrollmentChallenge","role":"symbol","abstract":[{"text":"A Email enrollment challenge.","type":"text"}],"type":"topic","url":"\/documentation\/auth0\/emailenrollmentchallenge","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"EmailEnrollmentChallenge","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/authentication(clientId:domain:session:)":{"abstract":[{"type":"reference","isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"type":"text","text":" client to authenticate a user with Database, Social,"},{"type":"text","text":" "},{"type":"text","text":"Enterprise or Passwordless connections."}],"title":"authentication(clientId:domain:session:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authentication","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"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"session","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"URLSession","preciseIdentifier":"c:objc(cs)NSURLSession","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Authentication","preciseIdentifier":"s:5Auth014AuthenticationP","kind":"typeIdentifier"}],"url":"\/documentation\/auth0\/authentication(clientid:domain:session:)","type":"topic","kind":"symbol","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/authentication(clientId:domain:session:)"},"doc://com.auth0.Auth0/documentation/Auth0/RecoveryCodeEnrollmentChallenge":{"title":"RecoveryCodeEnrollmentChallenge","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RecoveryCodeEnrollmentChallenge","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"RecoveryCodeEnrollmentChallenge","kind":"identifier"}],"navigatorTitle":[{"text":"RecoveryCodeEnrollmentChallenge","kind":"identifier"}],"abstract":[{"type":"text","text":"A Recovery code enrollment challenge."}],"kind":"symbol","role":"symbol","url":"\/documentation\/auth0\/recoverycodeenrollmentchallenge"},"doc://com.auth0.Auth0/documentation/Auth0/JWKS":{"navigatorTitle":[{"text":"JWKS","kind":"identifier"}],"title":"JWKS","role":"symbol","url":"\/documentation\/auth0\/jwks","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS","abstract":[{"text":"The JSON Web Key Set (JWKS) of your Auth0 tenant.","type":"text"}],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"JWKS","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationServices":{"abstract":[],"url":"\/documentation\/auth0\/authenticationservices","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationServices","kind":"symbol","title":"AuthenticationServices","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/DPoP":{"role":"symbol","type":"topic","title":"DPoP","kind":"symbol","url":"\/documentation\/auth0\/dpop","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"DPoP","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP","abstract":[{"text":"Utilities for securing requests with DPoP (Demonstrating Proof of Possession) as described in","type":"text"},{"text":" ","type":"text"},{"type":"reference","identifier":"https:\/\/datatracker.ietf.org\/doc\/html\/rfc9449","isActive":true},{"text":".","type":"text"}],"navigatorTitle":[{"text":"DPoP","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/LoginPasskey":{"role":"symbol","url":"\/documentation\/auth0\/loginpasskey","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"LoginPasskey"}],"navigatorTitle":[{"kind":"identifier","text":"LoginPasskey"}],"title":"LoginPasskey","abstract":[{"type":"text","text":"The login passkey credential obtained from the "},{"isActive":true,"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate"},{"type":"text","text":" delegate."},{"type":"text","text":" "},{"type":"text","text":"Contains the subset of relevant properties from "},{"isActive":true,"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialassertion"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey"},"https://auth0.com/docs/authenticate/login/auth0-universal-login":{"url":"https:\/\/auth0.com\/docs\/authenticate\/login\/auth0-universal-login","title":"Universal Login","type":"link","identifier":"https:\/\/auth0.com\/docs\/authenticate\/login\/auth0-universal-login","titleInlineContent":[{"type":"text","text":"Universal Login"}]},"https://developer.apple.com/documentation/authenticationservices/asauthorizationplatformpublickeycredentialassertion":{"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialassertion","title":"ASAuthorizationPlatformPublicKeyCredentialAssertion","type":"link","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialassertion","titleInlineContent":[{"type":"codeVoice","code":"ASAuthorizationPlatformPublicKeyCredentialAssertion"}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"type":"topic","url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","kind":"symbol","title":"ManagementError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/myAccount(token:session:bundle:)":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"myAccount","kind":"identifier"},{"text":"(","kind":"text"},{"text":"token","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"session","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"URLSession","preciseIdentifier":"c:objc(cs)NSURLSession","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"bundle","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Bundle","preciseIdentifier":"c:objc(cs)NSBundle","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"MyAccount","preciseIdentifier":"s:5Auth09MyAccountP","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/myAccount(token:session:bundle:)","title":"myAccount(token:session:bundle:)","role":"symbol","type":"topic","url":"\/documentation\/auth0\/myaccount(token:session:bundle:)","abstract":[{"type":"text","text":"Auth0 My Account API client for managing the current user’s account."}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"title":"WebAuth","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"url":"\/documentation\/auth0\/webauth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Logger":{"navigatorTitle":[{"kind":"identifier","text":"Logger"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger","role":"symbol","abstract":[{"type":"text","text":"Logger for debugging purposes."}],"kind":"symbol","url":"\/documentation\/auth0\/logger","type":"topic","title":"Logger","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Logger"}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountClient":{"type":"topic","title":"MyAccountClient","kind":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountClient","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountClient","navigatorTitle":[{"text":"MyAccountClient","kind":"identifier"}],"role":"symbol","abstract":[{"type":"text","text":"A client for the My Account API."},{"type":"text","text":" "},{"type":"text","text":"Adopting types could be either the root client or a leaf sub-client."}],"url":"\/documentation\/auth0\/myaccountclient"},"doc://com.auth0.Auth0/documentation/Auth0/PhoneEnrollmentChallenge":{"navigatorTitle":[{"kind":"identifier","text":"PhoneEnrollmentChallenge"}],"type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"PhoneEnrollmentChallenge"}],"kind":"symbol","role":"symbol","abstract":[{"text":"A Phone enrollment challenge.","type":"text"}],"url":"\/documentation\/auth0\/phoneenrollmentchallenge","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PhoneEnrollmentChallenge","title":"PhoneEnrollmentChallenge"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthentication":{"title":"WebAuthentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication","role":"symbol","abstract":[{"text":"Utility methods needed when using a custom Web Auth provider.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthentication"}],"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/webauthentication","navigatorTitle":[{"kind":"identifier","text":"WebAuthentication"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccount":{"fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccount","kind":"identifier"}],"type":"topic","kind":"symbol","url":"\/documentation\/auth0\/myaccount","navigatorTitle":[{"text":"MyAccount","kind":"identifier"}],"abstract":[{"type":"text","text":"My Account API client for managing the current user’s account."}],"title":"MyAccount","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccount"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent":{"title":"WebAuthUserAgent","url":"\/documentation\/auth0\/webauthuseragent","navigatorTitle":[{"kind":"identifier","text":"WebAuthUserAgent"}],"abstract":[{"type":"text","text":"The external user agent used to perform a web-based operation."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","kind":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthUserAgent"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"abstract":[{"text":"Cryptographic public key of your Auth0 tenant.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"JWK"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"JWK"}],"url":"\/documentation\/auth0\/jwk","role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","title":"JWK","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/SSOCredentials":{"url":"\/documentation\/auth0\/ssocredentials","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"SSOCredentials","kind":"identifier"}],"abstract":[{"type":"text","text":"Credentials obtained from Auth0 to perform web single sign-on (SSO)."}],"role":"symbol","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials","title":"SSOCredentials","type":"topic","navigatorTitle":[{"text":"SSOCredentials","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyLoginChallenge":{"title":"PasskeyLoginChallenge","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasskeyLoginChallenge"}],"navigatorTitle":[{"kind":"identifier","text":"PasskeyLoginChallenge"}],"abstract":[{"text":"A passkey login challenge.","type":"text"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge","url":"\/documentation\/auth0\/passkeyloginchallenge","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes":{"url":"\/documentation\/auth0\/userpatchattributes","kind":"symbol","role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserPatchAttributes","kind":"identifier"}],"navigatorTitle":[{"text":"UserPatchAttributes","kind":"identifier"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","title":"UserPatchAttributes","abstract":[{"type":"text","text":"User attributes that can be updated using the "},{"type":"reference","isActive":true,"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"},{"type":"text","text":"."}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthProvider":{"type":"topic","navigatorTitle":[{"kind":"identifier","text":"WebAuthProvider"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProvider","kind":"symbol","title":"WebAuthProvider","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"},{"text":" to perform a web-based operation.","type":"text"},{"text":" ","type":"text"},{"text":"The ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","isActive":true,"type":"reference"},{"text":" opens the URL in an external user agent and then invokes the callback when done.","type":"text"}],"fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthProvider"}],"url":"\/documentation\/auth0\/webauthprovider"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit","title":"CryptoKit","kind":"symbol","type":"topic","role":"collection","abstract":[],"url":"\/documentation\/auth0\/cryptokit"},"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","url":"\/documentation\/auth0\/trackable","role":"symbol","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Trackable"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable","title":"Trackable","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Trackable"}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","type":"topic","kind":"symbol","abstract":[{"text":"Represents an error during a request to the Auth0 My Account API.","type":"text"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountError","kind":"identifier"}],"navigatorTitle":[{"text":"MyAccountError","kind":"identifier"}],"url":"\/documentation\/auth0\/myaccounterror","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementObject":{"type":"topic","title":"ManagementObject","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","role":"symbol","kind":"symbol","navigatorTitle":[{"text":"ManagementObject","kind":"identifier"}],"fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ManagementObject","kind":"identifier"}],"url":"\/documentation\/auth0\/managementobject","abstract":[{"text":"A dictionary containing a user profile.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyEnrollmentChallenge":{"title":"PasskeyEnrollmentChallenge","role":"symbol","url":"\/documentation\/auth0\/passkeyenrollmentchallenge","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyEnrollmentChallenge","kind":"identifier"}],"type":"topic","navigatorTitle":[{"text":"PasskeyEnrollmentChallenge","kind":"identifier"}],"abstract":[{"type":"text","text":"A passkey enrollment challenge."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Factor":{"url":"\/documentation\/auth0\/factor","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factor","kind":"symbol","abstract":[],"type":"topic","title":"Factor","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Factor"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Factor"}]},"doc://com.auth0.Auth0/documentation/Auth0/Loggable":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","abstract":[{"type":"text","text":"A type that can log statements for debugging purposes."}],"fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Loggable","kind":"identifier"}],"kind":"symbol","title":"Loggable","type":"topic","role":"symbol","navigatorTitle":[{"text":"Loggable","kind":"identifier"}],"url":"\/documentation\/auth0\/loggable"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"text":"UserInfo","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/userinfo","type":"topic","title":"UserInfo","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"},"doc://com.auth0.Auth0/documentation/Auth0/PreferredAuthenticationMethod":{"abstract":[],"role":"symbol","url":"\/documentation\/auth0\/preferredauthenticationmethod","title":"PreferredAuthenticationMethod","navigatorTitle":[{"kind":"identifier","text":"PreferredAuthenticationMethod"}],"type":"topic","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PreferredAuthenticationMethod"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage":{"title":"CredentialsStorage","kind":"symbol","navigatorTitle":[{"text":"CredentialsStorage","kind":"identifier"}],"role":"symbol","url":"\/documentation\/auth0\/credentialsstorage","abstract":[{"text":"Generic storage API for storing credentials.","type":"text"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsStorage","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyDeviceType":{"type":"topic","kind":"symbol","url":"\/documentation\/auth0\/passkeydevicetype","abstract":[{"text":"Kind of device the passkey is stored on as defined by backup eligibility.","type":"text"}],"role":"symbol","title":"PasskeyDeviceType","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyDeviceType","kind":"identifier"}],"navigatorTitle":[{"text":"PasskeyDeviceType","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethods":{"title":"AuthenticationMethods","navigatorTitle":[{"text":"AuthenticationMethods","kind":"identifier"}],"role":"symbol","abstract":[{"type":"text","text":"List of authentication methods belonging to the authenticated user."}],"url":"\/documentation\/auth0\/authenticationmethods","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationMethods","kind":"identifier"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethods"},"doc://com.auth0.Auth0/documentation/Auth0/PushEnrollmentChallenge":{"title":"PushEnrollmentChallenge","abstract":[{"type":"text","text":"A Push enrollment challenge."}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PushEnrollmentChallenge","kind":"identifier"}],"navigatorTitle":[{"text":"PushEnrollmentChallenge","kind":"identifier"}],"url":"\/documentation\/auth0\/pushenrollmentchallenge","role":"symbol"},"https://developer.apple.com/documentation/authenticationservices/asauthorizationplatformpublickeycredentialregistration":{"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialregistration","title":"ASAuthorizationPlatformPublicKeyCredentialRegistration","type":"link","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialregistration","titleInlineContent":[{"type":"codeVoice","code":"ASAuthorizationPlatformPublicKeyCredentialRegistration"}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountResult":{"url":"\/documentation\/auth0\/myaccountresult","role":"symbol","navigatorTitle":[{"text":"MyAccountResult","kind":"identifier"}],"type":"topic","abstract":[{"code":"Result","type":"codeVoice"},{"text":" wrapper for My Account API operations.","type":"text"}],"kind":"symbol","title":"MyAccountResult","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountResult","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountResult","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"abstract":[{"text":"Represents an error during a Web Auth operation.","type":"text"}],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"type":"topic","role":"symbol","navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","title":"WebAuthError","url":"\/documentation\/auth0\/webautherror"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"type":"topic","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Users","kind":"identifier"}],"title":"Users","navigatorTitle":[{"text":"Users","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","url":"\/documentation\/auth0\/users","kind":"symbol","abstract":[{"type":"text","text":"Client for the Users endpoints of the Auth0 "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"type":"text","text":"."}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementResult":{"abstract":[{"type":"codeVoice","code":"Result"},{"type":"text","text":" wrapper for Management API operations."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementResult","role":"symbol","url":"\/documentation\/auth0\/managementresult","title":"ManagementResult","type":"topic","kind":"symbol","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ManagementResult","kind":"identifier"}],"navigatorTitle":[{"text":"ManagementResult","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"type":"topic","role":"symbol","title":"Authentication","abstract":[{"text":"Client for the ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"text":".","type":"text"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"doc://com.auth0.Auth0/documentation/Auth0/PasskeySignupChallenge":{"type":"topic","abstract":[{"type":"text","text":"A passkey signup challenge."}],"kind":"symbol","title":"PasskeySignupChallenge","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge","role":"symbol","url":"\/documentation\/auth0\/passkeysignupchallenge","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasskeySignupChallenge"}],"navigatorTitle":[{"kind":"identifier","text":"PasskeySignupChallenge"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthProviderCallback":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProviderCallback","url":"\/documentation\/auth0\/webauthprovidercallback","role":"symbol","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthProviderCallback"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuthProviderCallback"}],"type":"topic","abstract":[{"type":"text","text":"Callback invoked by the "},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent"},{"type":"text","text":" when the web-based operation concludes."}],"title":"WebAuthProviderCallback","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"url":"\/documentation\/auth0\/passwordlesstype","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasswordlessType"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","type":"topic","navigatorTitle":[{"kind":"identifier","text":"PasswordlessType"}],"kind":"symbol","title":"PasswordlessType","abstract":[{"type":"text","text":"Types of passwordless authentication."}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods":{"url":"\/documentation\/auth0\/myaccountauthenticationmethods","kind":"symbol","type":"topic","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountAuthenticationMethods","kind":"identifier"}],"navigatorTitle":[{"text":"MyAccountAuthenticationMethods","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods","title":"MyAccountAuthenticationMethods","abstract":[{"type":"text","text":"My Account API sub-client for managing the current user’s authentication methods."}]},"doc://com.auth0.Auth0/documentation/Auth0/NewPasskey":{"role":"symbol","title":"NewPasskey","abstract":[{"text":"The signup passkey credential obtained from the ","type":"text"},{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","isActive":true,"type":"reference"},{"text":" delegate.","type":"text"},{"text":" ","type":"text"},{"text":"Contains the subset of relevant properties from ","type":"text"},{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialregistration","isActive":true,"type":"reference"},{"text":".","type":"text"}],"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/newpasskey","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/NewPasskey","navigatorTitle":[{"text":"NewPasskey","kind":"identifier"}],"fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"NewPasskey","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyCredential":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"PasskeyCredential"}],"type":"topic","role":"symbol","url":"\/documentation\/auth0\/passkeycredential","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasskeyCredential"}],"abstract":[{"type":"text","text":"A passkey credential."}],"title":"PasskeyCredential","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential"},"doc://com.auth0.Auth0/documentation/Auth0/Challenge":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Challenge","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge","title":"Challenge","url":"\/documentation\/auth0\/challenge","navigatorTitle":[{"text":"Challenge","kind":"identifier"}],"type":"topic","kind":"symbol","abstract":[{"type":"text","text":"A multi-factor challenge."}]},"https://datatracker.ietf.org/doc/html/rfc9449":{"url":"https:\/\/datatracker.ietf.org\/doc\/html\/rfc9449","title":"RFC 9449","type":"link","identifier":"https:\/\/datatracker.ietf.org\/doc\/html\/rfc9449","titleInlineContent":[{"type":"text","text":"RFC 9449"}]},"doc://com.auth0.Auth0/documentation/Auth0/myAccount(token:domain:session:)":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/myAccount(token:domain:session:)","role":"symbol","abstract":[{"text":"Auth0 My Account API client for managing the current user’s account.","type":"text"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"myAccount","kind":"identifier"},{"text":"(","kind":"text"},{"text":"token","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"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"},{"text":"URLSession","kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSURLSession"},{"text":") -> ","kind":"text"},{"text":"MyAccount","kind":"typeIdentifier","preciseIdentifier":"s:5Auth09MyAccountP"}],"kind":"symbol","title":"myAccount(token:domain:session:)","url":"\/documentation\/auth0\/myaccount(token:domain:session:)"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError":{"kind":"symbol","abstract":[{"type":"text","text":"Represents an error during a DPoP operation."}],"navigatorTitle":[{"text":"DPoPError","kind":"identifier"}],"title":"DPoPError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"DPoPError","kind":"identifier"}],"url":"\/documentation\/auth0\/dpoperror","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Factors":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factors","abstract":[{"type":"text","text":"List of factors enabled for the Auth0 tenant and available for enrollment by this user."}],"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Factors"}],"title":"Factors","type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Factors","kind":"identifier"}],"url":"\/documentation\/auth0\/factors","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/RefreshTokens":{"url":"\/documentation\/auth0\/refreshtokens","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens","kind":"article","title":"Refresh Tokens: Common Errors","type":"topic","abstract":[],"role":"article"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","type":"topic","url":"\/documentation\/auth0\/auth0apierror","title":"Auth0APIError","abstract":[{"type":"text","text":"Generic representation of Auth0 API errors."}],"role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Auth0APIError","kind":"identifier"}],"kind":"symbol","navigatorTitle":[{"text":"Auth0APIError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Swift":{"url":"\/documentation\/auth0\/swift","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift","abstract":[],"kind":"symbol","role":"collection","title":"Swift"},"doc://com.auth0.Auth0/documentation/Auth0/Foundation":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation","kind":"symbol","url":"\/documentation\/auth0\/foundation","role":"collection","abstract":[],"title":"Foundation"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain":{"type":"topic","title":"SimpleKeychain","url":"\/documentation\/auth0\/simplekeychain","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain","role":"collection","abstract":[],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/SignupPasskey":{"type":"topic","kind":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"SignupPasskey","kind":"identifier"}],"url":"\/documentation\/auth0\/signuppasskey","abstract":[{"type":"text","text":"The signup passkey credential obtained from the "},{"isActive":true,"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","type":"reference"},{"type":"text","text":" delegate."},{"type":"text","text":" "},{"type":"text","text":"Contains the subset of relevant properties from "},{"isActive":true,"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialregistration","type":"reference"},{"type":"text","text":"."}],"role":"symbol","navigatorTitle":[{"text":"SignupPasskey","kind":"identifier"}],"title":"SignupPasskey","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SignupPasskey"},"https://developer.apple.com/documentation/authenticationservices/asauthorizationcontrollerdelegate":{"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","title":"ASAuthorizationControllerDelegate","type":"link","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","titleInlineContent":[{"type":"codeVoice","code":"ASAuthorizationControllerDelegate"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"url":"\/documentation\/auth0\/credentialsmanagererror","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}],"title":"CredentialsManagerError","kind":"symbol","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManager","kind":"identifier"}],"navigatorTitle":[{"text":"CredentialsManager","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","abstract":[{"type":"text","text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain."}],"kind":"symbol","title":"CredentialsManager","url":"\/documentation\/auth0\/credentialsmanager","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/request","kind":"symbol","abstract":[{"type":"text","text":"Auth0 API request."}]},"doc://com.auth0.Auth0/documentation/Auth0/APICredentials":{"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0 for a specific API as the result of exchanging a refresh token."}],"title":"APICredentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials","role":"symbol","navigatorTitle":[{"text":"APICredentials","kind":"identifier"}],"url":"\/documentation\/auth0\/apicredentials","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"APICredentials","kind":"identifier"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/users(token:domain:session:)":{"kind":"symbol","title":"users(token:domain:session:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"users"},{"kind":"text","text":"("},{"kind":"externalParam","text":"token"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"domain"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"session"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSURLSession","text":"URLSession"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth05UsersP","text":"Users"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/users(token:domain:session:)","abstract":[{"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","type":"reference","isActive":true},{"type":"text","text":" client for performing operations with the Users endpoints."}],"url":"\/documentation\/auth0\/users(token:domain:session:)","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/SenderConstraining":{"navigatorTitle":[{"kind":"identifier","text":"SenderConstraining"}],"role":"symbol","kind":"symbol","abstract":[{"text":"A type that can use DPoP for securing requests.","type":"text"}],"url":"\/documentation\/auth0\/senderconstraining","type":"topic","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"SenderConstraining"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SenderConstraining","title":"SenderConstraining"},"doc://com.auth0.Auth0/documentation/Auth0/webAuth(session:bundle:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/webAuth(session:bundle:)","kind":"symbol","url":"\/documentation\/auth0\/webauth(session:bundle:)","abstract":[{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/authenticate\/login\/auth0-universal-login","isActive":true},{"type":"text","text":" client for performing web-based"},{"type":"text","text":" "},{"type":"text","text":"authentication."}],"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"webAuth"},{"kind":"text","text":"("},{"kind":"externalParam","text":"session"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"URLSession","preciseIdentifier":"c:objc(cs)NSURLSession"},{"kind":"text","text":", "},{"kind":"externalParam","text":"bundle"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bundle","preciseIdentifier":"c:objc(cs)NSBundle"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"WebAuth","preciseIdentifier":"s:5Auth07WebAuthP"}],"type":"topic","title":"webAuth(session:bundle:)"},"doc://com.auth0.Auth0/documentation/Auth0/TOTPEnrollmentChallenge":{"kind":"symbol","navigatorTitle":[{"text":"TOTPEnrollmentChallenge","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge","url":"\/documentation\/auth0\/totpenrollmentchallenge","title":"TOTPEnrollmentChallenge","type":"topic","abstract":[{"type":"text","text":"A TOTP enrollment challenge."}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"TOTPEnrollmentChallenge","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyAuthenticationMethod":{"role":"symbol","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod","type":"topic","navigatorTitle":[{"text":"PasskeyAuthenticationMethod","kind":"identifier"}],"title":"PasskeyAuthenticationMethod","url":"\/documentation\/auth0\/passkeyauthenticationmethod","abstract":[{"text":"A passkey authentication method.","type":"text"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyAuthenticationMethod","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationMethod","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod","navigatorTitle":[{"text":"AuthenticationMethod","kind":"identifier"}],"abstract":[],"title":"AuthenticationMethod","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/authenticationmethod"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"url":"\/documentation\/auth0\/credentials","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"role":"symbol","type":"topic","abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthResult":{"url":"\/documentation\/auth0\/webauthresult","navigatorTitle":[{"text":"WebAuthResult","kind":"identifier"}],"title":"WebAuthResult","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult","abstract":[{"code":"Result","type":"codeVoice"},{"text":" wrapper for Web Auth operations.","type":"text"}],"type":"topic","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthResult","kind":"identifier"}],"kind":"symbol","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerResult":{"type":"topic","abstract":[{"type":"codeVoice","code":"Result"},{"type":"text","text":" wrapper for Credentials Manager operations."}],"kind":"symbol","role":"symbol","navigatorTitle":[{"text":"CredentialsManagerResult","kind":"identifier"}],"title":"CredentialsManagerResult","url":"\/documentation\/auth0\/credentialsmanagerresult","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerResult","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerResult"}}} \ No newline at end of file +{"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"content","content":[{"level":2,"anchor":"Overview","type":"heading","text":"Overview"},{"type":"unorderedList","items":[{"content":[{"type":"paragraph","inlineContent":[{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","isActive":true},{"type":"text","text":": Web-based authentication client."}]}]},{"content":[{"type":"paragraph","inlineContent":[{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"},{"type":"text","text":": Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain."}]}]},{"content":[{"type":"paragraph","inlineContent":[{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"},{"type":"text","text":": Client for the "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"type":"text","text":"."}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccount","isActive":true},{"type":"text","text":": Client for the My Account API."}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","isActive":true},{"type":"text","text":": Client for the Users endpoints of the "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","isActive":true},{"type":"text","text":"."}]}]}]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0"]}],"kind":"symbol","metadata":{"title":"Auth0","symbolKind":"module","roleHeading":"Framework","role":"collection","externalID":"Auth0","modules":[{"name":"Auth0"}]},"schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"type":"text","text":"SDK for Apple platforms."}],"topicSections":[{"title":"Articles","generated":true,"anchor":"Articles","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserAgents","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens"]},{"title":"Classes","generated":true,"anchor":"Classes","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"]},{"title":"Protocols","generated":true,"anchor":"Protocols","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccount","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountClient","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/NewPasskey","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Requestable","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SenderConstraining","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SignupPasskey","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":"Structures","generated":true,"anchor":"Structures","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethods","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\/DPoP","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/EmailEnrollmentChallenge","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factor","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factors","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\/MyAccountError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PhoneEnrollmentChallenge","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RecoveryCodeEnrollmentChallenge","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication"]},{"title":"Variables","generated":true,"anchor":"Variables","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/defaultScope"]},{"title":"Functions","generated":true,"anchor":"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\/myAccount(token:domain:session:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/myAccount(token: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","generated":true,"anchor":"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\/MyAccountResult","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\/BiometricPolicy","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod"],"anchor":"Enumerations","generated":true},{"generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationServices","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift"],"title":"Extended Modules","anchor":"Extended-Modules"}],"hierarchy":{"paths":[[]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"title":"ManagementError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountClient":{"title":"MyAccountClient","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountClient","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccountClient"}],"abstract":[{"text":"A client for the My Account API.","type":"text"},{"text":" ","type":"text"},{"text":"Adopting types could be either the root client or a leaf sub-client.","type":"text"}],"url":"\/documentation\/auth0\/myaccountclient","navigatorTitle":[{"kind":"identifier","text":"MyAccountClient"}]},"doc://com.auth0.Auth0/documentation/Auth0/SenderConstraining":{"kind":"symbol","abstract":[{"text":"A type that can use DPoP for securing requests.","type":"text"}],"type":"topic","title":"SenderConstraining","url":"\/documentation\/auth0\/senderconstraining","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"SenderConstraining"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SenderConstraining","navigatorTitle":[{"kind":"identifier","text":"SenderConstraining"}]},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyCredential":{"role":"symbol","title":"PasskeyCredential","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyCredential","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"PasskeyCredential"}],"abstract":[{"text":"A passkey credential.","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/passkeycredential","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"role":"symbol","title":"CredentialsManagerError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerError"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}],"abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","url":"\/documentation\/auth0\/credentialsmanagererror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Telemetry":{"kind":"symbol","abstract":[{"text":"Generates and sets the ","type":"text"},{"code":"Auth0-Client","type":"codeVoice"},{"text":" header.","type":"text"}],"type":"topic","title":"Telemetry","url":"\/documentation\/auth0\/telemetry","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Telemetry"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","navigatorTitle":[{"kind":"identifier","text":"Telemetry"}]},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error":{"url":"\/documentation\/auth0\/auth0error","title":"Auth0Error","abstract":[{"type":"text","text":"Generic representation of Auth0 errors."}],"navigatorTitle":[{"kind":"identifier","text":"Auth0Error"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Auth0Error"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PushEnrollmentChallenge":{"type":"topic","title":"PushEnrollmentChallenge","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge","kind":"symbol","abstract":[{"type":"text","text":"A Push enrollment challenge."}],"url":"\/documentation\/auth0\/pushenrollmentchallenge","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"PushEnrollmentChallenge"}],"navigatorTitle":[{"kind":"identifier","text":"PushEnrollmentChallenge"}]},"doc://com.auth0.Auth0/documentation/Auth0/JWKS":{"role":"symbol","title":"JWKS","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"JWKS"}],"navigatorTitle":[{"kind":"identifier","text":"JWKS"}],"abstract":[{"type":"text","text":"The JSON Web Key Set (JWKS) of your Auth0 tenant."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS","url":"\/documentation\/auth0\/jwks","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","abstract":[{"type":"text","text":"Client for the "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","isActive":true},{"type":"text","text":"."}],"type":"topic","title":"Authentication","url":"\/documentation\/auth0\/authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthProvider":{"role":"symbol","title":"WebAuthProvider","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthProvider"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuthProvider"}],"abstract":[{"type":"text","text":"Thunk that returns a function that creates and returns a "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","isActive":true,"type":"reference"},{"text":" to perform a web-based operation.","type":"text"},{"type":"text","text":" "},{"type":"text","text":"The "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","isActive":true},{"text":" opens the URL in an external user agent and then invokes the callback when done.","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/webauthprovider","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProvider","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Requestable":{"kind":"symbol","abstract":[],"type":"topic","url":"\/documentation\/auth0\/requestable","title":"Requestable","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Requestable","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Requestable","navigatorTitle":[{"text":"Requestable","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/RefreshTokens":{"title":"Refresh Tokens: Common Errors","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens","role":"article","kind":"article","abstract":[],"url":"\/documentation\/auth0\/refreshtokens"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementResult":{"url":"\/documentation\/auth0\/managementresult","title":"ManagementResult","abstract":[{"type":"codeVoice","code":"Result"},{"text":" wrapper for Management API operations.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"ManagementResult"}],"fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementResult"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementResult","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"url":"\/documentation\/auth0\/webautherror","abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"title":"WebAuthError","navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"title":"CredentialsManager","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManager"}],"abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanager","navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods":{"role":"symbol","title":"MyAccountAuthenticationMethods","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"MyAccountAuthenticationMethods"}],"navigatorTitle":[{"text":"MyAccountAuthenticationMethods","kind":"identifier"}],"abstract":[{"type":"text","text":"My Account API sub-client for managing the current user’s authentication methods."}],"kind":"symbol","url":"\/documentation\/auth0\/myaccountauthenticationmethods","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthResult":{"url":"\/documentation\/auth0\/webauthresult","title":"WebAuthResult","abstract":[{"code":"Result","type":"codeVoice"},{"type":"text","text":" wrapper for Web Auth operations."}],"navigatorTitle":[{"text":"WebAuthResult","kind":"identifier"}],"fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthResult","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult","role":"symbol","kind":"symbol","type":"topic"},"https://auth0.com/docs/authenticate/login/auth0-universal-login":{"type":"link","titleInlineContent":[{"type":"text","text":"Universal Login"}],"identifier":"https:\/\/auth0.com\/docs\/authenticate\/login\/auth0-universal-login","title":"Universal Login","url":"https:\/\/auth0.com\/docs\/authenticate\/login\/auth0-universal-login"},"doc://com.auth0.Auth0/documentation/Auth0/NewPasskey":{"title":"NewPasskey","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/NewPasskey","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"NewPasskey"}],"abstract":[{"type":"text","text":"The signup passkey credential obtained from the "},{"isActive":true,"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate"},{"type":"text","text":" delegate."},{"type":"text","text":" "},{"type":"text","text":"Contains the subset of relevant properties from "},{"isActive":true,"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialregistration"},{"type":"text","text":"."}],"url":"\/documentation\/auth0\/newpasskey","navigatorTitle":[{"kind":"identifier","text":"NewPasskey"}]},"doc://com.auth0.Auth0/documentation/Auth0/Foundation":{"title":"Foundation","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation","role":"collection","kind":"symbol","abstract":[],"url":"\/documentation\/auth0\/foundation"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyLoginChallenge":{"title":"PasskeyLoginChallenge","role":"symbol","navigatorTitle":[{"text":"PasskeyLoginChallenge","kind":"identifier"}],"kind":"symbol","abstract":[{"text":"A passkey login challenge.","type":"text"}],"url":"\/documentation\/auth0\/passkeyloginchallenge","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"PasskeyLoginChallenge"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/APICredentials":{"role":"symbol","title":"APICredentials","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"APICredentials"}],"navigatorTitle":[{"kind":"identifier","text":"APICredentials"}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0 for a specific API as the result of exchanging a refresh token."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials","url":"\/documentation\/auth0\/apicredentials","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/DPoP":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP","type":"topic","title":"DPoP","role":"symbol","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"DPoP","kind":"identifier"}],"abstract":[{"type":"text","text":"Utilities for securing requests with DPoP (Demonstrating Proof of Possession) as described in"},{"type":"text","text":" "},{"isActive":true,"type":"reference","identifier":"https:\/\/datatracker.ietf.org\/doc\/html\/rfc9449"},{"type":"text","text":"."}],"url":"\/documentation\/auth0\/dpop","navigatorTitle":[{"text":"DPoP","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Factor":{"title":"Factor","role":"symbol","navigatorTitle":[{"text":"Factor","kind":"identifier"}],"kind":"symbol","abstract":[],"url":"\/documentation\/auth0\/factor","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factor","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Factor"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent":{"kind":"symbol","abstract":[{"type":"text","text":"The external user agent used to perform a web-based operation."}],"type":"topic","url":"\/documentation\/auth0\/webauthuseragent","title":"WebAuthUserAgent","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthUserAgent"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","navigatorTitle":[{"kind":"identifier","text":"WebAuthUserAgent"}]},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError":{"role":"symbol","title":"DPoPError","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"DPoPError","kind":"identifier"}],"navigatorTitle":[{"text":"DPoPError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a DPoP operation."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError","url":"\/documentation\/auth0\/dpoperror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod":{"role":"symbol","title":"AuthenticationMethod","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationMethod"}],"navigatorTitle":[{"text":"AuthenticationMethod","kind":"identifier"}],"abstract":[],"kind":"symbol","url":"\/documentation\/auth0\/authenticationmethod","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain","type":"topic","title":"SimpleKeychain","role":"collection","kind":"symbol","abstract":[],"url":"\/documentation\/auth0\/simplekeychain"},"doc://com.auth0.Auth0/documentation/Auth0/Loggable":{"role":"symbol","title":"Loggable","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Loggable"}],"navigatorTitle":[{"text":"Loggable","kind":"identifier"}],"abstract":[{"text":"A type that can log statements for debugging purposes.","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/loggable","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationResult":{"title":"AuthenticationResult","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationResult","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationResult"}],"abstract":[{"type":"codeVoice","code":"Result"},{"type":"text","text":" wrapper for Authentication API operations."}],"url":"\/documentation\/auth0\/authenticationresult","navigatorTitle":[{"kind":"identifier","text":"AuthenticationResult"}]},"doc://com.auth0.Auth0/documentation/Auth0/PreferredAuthenticationMethod":{"url":"\/documentation\/auth0\/preferredauthenticationmethod","abstract":[],"title":"PreferredAuthenticationMethod","navigatorTitle":[{"text":"PreferredAuthenticationMethod","kind":"identifier"}],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PreferredAuthenticationMethod"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeySignupChallenge":{"title":"PasskeySignupChallenge","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge","role":"symbol","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"PasskeySignupChallenge","kind":"identifier"}],"abstract":[{"text":"A passkey signup challenge.","type":"text"}],"url":"\/documentation\/auth0\/passkeysignupchallenge","navigatorTitle":[{"text":"PasskeySignupChallenge","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/RecoveryCodeEnrollmentChallenge":{"title":"RecoveryCodeEnrollmentChallenge","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RecoveryCodeEnrollmentChallenge","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"RecoveryCodeEnrollmentChallenge"}],"abstract":[{"type":"text","text":"A Recovery code enrollment challenge."}],"url":"\/documentation\/auth0\/recoverycodeenrollmentchallenge","navigatorTitle":[{"text":"RecoveryCodeEnrollmentChallenge","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/BiometricPolicy":{"kind":"symbol","abstract":[{"text":"Defines the policy for when a biometric prompt should be shown when using the Credentials Manager.","type":"text"}],"type":"topic","url":"\/documentation\/auth0\/biometricpolicy","title":"BiometricPolicy","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"BiometricPolicy","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/BiometricPolicy","navigatorTitle":[{"text":"BiometricPolicy","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccountError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 My Account API."}],"url":"\/documentation\/auth0\/myaccounterror","navigatorTitle":[{"kind":"identifier","text":"MyAccountError"}]},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError":{"url":"\/documentation\/auth0\/auth0apierror","abstract":[{"type":"text","text":"Generic representation of Auth0 API errors."}],"title":"Auth0APIError","navigatorTitle":[{"kind":"identifier","text":"Auth0APIError"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Auth0APIError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","role":"symbol","kind":"symbol","type":"topic"},"https://auth0.com/docs/api/management/v2":{"titleInlineContent":[{"text":"Management API v2","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/management\/v2","type":"link","title":"Management API v2","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthProviderCallback":{"title":"WebAuthProviderCallback","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProviderCallback","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthProviderCallback"}],"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"}],"url":"\/documentation\/auth0\/webauthprovidercallback","navigatorTitle":[{"kind":"identifier","text":"WebAuthProviderCallback"}]},"doc://com.auth0.Auth0/documentation/Auth0/Swift":{"title":"Swift","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift","role":"collection","kind":"symbol","abstract":[],"url":"\/documentation\/auth0\/swift"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyAuthenticationMethod":{"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyAuthenticationMethod","kind":"identifier"}],"navigatorTitle":[{"text":"PasskeyAuthenticationMethod","kind":"identifier"}],"title":"PasskeyAuthenticationMethod","type":"topic","role":"symbol","abstract":[{"type":"text","text":"A passkey authentication method."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod","url":"\/documentation\/auth0\/passkeyauthenticationmethod"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthentication":{"title":"WebAuthentication","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthentication"}],"abstract":[{"text":"Utility methods needed when using a custom Web Auth provider.","type":"text"}],"url":"\/documentation\/auth0\/webauthentication","navigatorTitle":[{"kind":"identifier","text":"WebAuthentication"}]},"doc://com.auth0.Auth0/documentation/Auth0/Challenge":{"title":"Challenge","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Challenge"}],"abstract":[{"text":"A multi-factor challenge.","type":"text"}],"url":"\/documentation\/auth0\/challenge","navigatorTitle":[{"kind":"identifier","text":"Challenge"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/myAccount(token:session:bundle:)":{"title":"myAccount(token:session:bundle:)","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/myAccount(token:session:bundle:)","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"myAccount"},{"kind":"text","text":"("},{"kind":"externalParam","text":"token"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"session"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSURLSession","text":"URLSession"},{"kind":"text","text":", "},{"kind":"externalParam","text":"bundle"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSBundle","text":"Bundle"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth09MyAccountP","text":"MyAccount"}],"abstract":[{"text":"Auth0 My Account API client for managing the current user’s account.","type":"text"}],"url":"\/documentation\/auth0\/myaccount(token:session:bundle:)"},"doc://com.auth0.Auth0/documentation/Auth0/EmailEnrollmentChallenge":{"title":"EmailEnrollmentChallenge","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/EmailEnrollmentChallenge","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"EmailEnrollmentChallenge"}],"abstract":[{"text":"A Email enrollment challenge.","type":"text"}],"url":"\/documentation\/auth0\/emailenrollmentchallenge","navigatorTitle":[{"kind":"identifier","text":"EmailEnrollmentChallenge"}]},"doc://com.auth0.Auth0/documentation/Auth0/defaultScope":{"title":"defaultScope","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/defaultScope","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"defaultScope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"abstract":[{"text":"Default scope value used across Auth0.swift. Equals to ","type":"text"},{"code":"openid profile email","type":"codeVoice"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/defaultscope"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationServices":{"title":"AuthenticationServices","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationServices","role":"collection","kind":"symbol","abstract":[],"url":"\/documentation\/auth0\/authenticationservices"},"doc://com.auth0.Auth0/documentation/Auth0/LoginPasskey":{"title":"LoginPasskey","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"LoginPasskey"}],"abstract":[{"text":"The login passkey credential obtained from the ","type":"text"},{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","isActive":true,"type":"reference"},{"text":" delegate.","type":"text"},{"text":" ","type":"text"},{"text":"Contains the subset of relevant properties from ","type":"text"},{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialassertion","isActive":true,"type":"reference"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/loginpasskey","navigatorTitle":[{"kind":"identifier","text":"LoginPasskey"}]},"doc://com.auth0.Auth0/documentation/Auth0/authentication(clientId:domain:session:)":{"title":"authentication(clientId:domain:session:)","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/authentication(clientId:domain:session:)","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"authentication"},{"kind":"text","text":"("},{"kind":"externalParam","text":"clientId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"domain"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"session"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSURLSession","text":"URLSession"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth014AuthenticationP","text":"Authentication"}],"abstract":[{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","isActive":true,"type":"reference"},{"text":" client to authenticate a user with Database, Social,","type":"text"},{"text":" ","type":"text"},{"text":"Enterprise or Passwordless connections.","type":"text"}],"url":"\/documentation\/auth0\/authentication(clientid:domain:session:)"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit":{"title":"CryptoKit","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit","role":"collection","kind":"symbol","abstract":[],"url":"\/documentation\/auth0\/cryptokit"},"doc://com.auth0.Auth0/documentation/Auth0/users(token:domain:session:)":{"title":"users(token:domain:session:)","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/users(token:domain:session:)","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"users"},{"kind":"text","text":"("},{"kind":"externalParam","text":"token"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"domain"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"session"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSURLSession","text":"URLSession"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth05UsersP","text":"Users"}],"abstract":[{"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","isActive":true,"type":"reference"},{"text":" client for performing operations with the Users endpoints.","type":"text"}],"url":"\/documentation\/auth0\/users(token:domain:session:)"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"navigatorTitle":[{"kind":"identifier","text":"PasswordlessType"}],"kind":"symbol","url":"\/documentation\/auth0\/passwordlesstype","role":"symbol","abstract":[{"type":"text","text":"Types of passwordless authentication."}],"type":"topic","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasswordlessType"}],"title":"PasswordlessType","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"},"doc://com.auth0.Auth0/documentation/Auth0/Trackable":{"title":"Trackable","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Trackable"}],"abstract":[{"text":"A type that can send the ","type":"text"},{"code":"Auth0-Client","type":"codeVoice"},{"text":" header on every request to Auth0.","type":"text"}],"url":"\/documentation\/auth0\/trackable","navigatorTitle":[{"kind":"identifier","text":"Trackable"}]},"doc://com.auth0.Auth0/documentation/Auth0/Logger":{"title":"Logger","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Logger"}],"abstract":[{"text":"Logger for debugging purposes.","type":"text"}],"url":"\/documentation\/auth0\/logger","navigatorTitle":[{"kind":"identifier","text":"Logger"}]},"https://developer.apple.com/documentation/authenticationservices/asauthorizationcontrollerdelegate":{"titleInlineContent":[{"code":"ASAuthorizationControllerDelegate","type":"codeVoice"}],"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","type":"link","title":"ASAuthorizationControllerDelegate","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes":{"title":"UserPatchAttributes","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"UserPatchAttributes"}],"abstract":[{"text":"User attributes that can be updated using the ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","isActive":true,"type":"reference"},{"text":" method of ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","isActive":true,"type":"reference"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/userpatchattributes","navigatorTitle":[{"kind":"identifier","text":"UserPatchAttributes"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"title":"UserInfo","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"UserInfo"}],"abstract":[{"text":"OIDC Standard Claims user information.","type":"text"}],"url":"\/documentation\/auth0\/userinfo","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]},"doc://com.auth0.Auth0/documentation/Auth0/SignupPasskey":{"title":"SignupPasskey","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SignupPasskey","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"SignupPasskey"}],"abstract":[{"text":"The signup passkey credential obtained from the ","type":"text"},{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","isActive":true,"type":"reference"},{"text":" delegate.","type":"text"},{"text":" ","type":"text"},{"text":"Contains the subset of relevant properties from ","type":"text"},{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialregistration","isActive":true,"type":"reference"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/signuppasskey","navigatorTitle":[{"kind":"identifier","text":"SignupPasskey"}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountResult":{"title":"MyAccountResult","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountResult","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccountResult"}],"abstract":[{"code":"Result","type":"codeVoice"},{"text":" wrapper for My Account API operations.","type":"text"}],"url":"\/documentation\/auth0\/myaccountresult","navigatorTitle":[{"kind":"identifier","text":"MyAccountResult"}]},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyDeviceType":{"navigatorTitle":[{"kind":"identifier","text":"PasskeyDeviceType"}],"kind":"symbol","url":"\/documentation\/auth0\/passkeydevicetype","role":"symbol","abstract":[{"text":"Kind of device the passkey is stored on as defined by backup eligibility.","type":"text"}],"type":"topic","fragments":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"text":"PasskeyDeviceType","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType","title":"PasskeyDeviceType"},"doc://com.auth0.Auth0/documentation/Auth0/TOTPEnrollmentChallenge":{"title":"TOTPEnrollmentChallenge","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"TOTPEnrollmentChallenge"}],"abstract":[{"text":"A TOTP enrollment challenge.","type":"text"}],"url":"\/documentation\/auth0\/totpenrollmentchallenge","navigatorTitle":[{"kind":"identifier","text":"TOTPEnrollmentChallenge"}]},"https://datatracker.ietf.org/doc/html/rfc9449":{"titleInlineContent":[{"text":"RFC 9449","type":"text"}],"url":"https:\/\/datatracker.ietf.org\/doc\/html\/rfc9449","type":"link","title":"RFC 9449","identifier":"https:\/\/datatracker.ietf.org\/doc\/html\/rfc9449"},"doc://com.auth0.Auth0/documentation/Auth0/users(token:session:bundle:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/users(token:session:bundle:)","type":"topic","title":"users(token:session:bundle:)","role":"symbol","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"users"},{"kind":"text","text":"("},{"kind":"externalParam","text":"token"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"session"},{"text":": ","kind":"text"},{"text":"URLSession","preciseIdentifier":"c:objc(cs)NSURLSession","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"bundle","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSBundle","text":"Bundle"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth05UsersP","text":"Users"}],"abstract":[{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"type":"text","text":" client for performing operations with the Users endpoints."}],"url":"\/documentation\/auth0\/users(token:session:bundle:)"},"https://developer.apple.com/documentation/authenticationservices/asauthorizationplatformpublickeycredentialassertion":{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialassertion","url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialassertion","titleInlineContent":[{"type":"codeVoice","code":"ASAuthorizationPlatformPublicKeyCredentialAssertion"}],"type":"link","title":"ASAuthorizationPlatformPublicKeyCredentialAssertion"},"https://developer.apple.com/documentation/authenticationservices/asauthorizationplatformpublickeycredentialregistration":{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialregistration","url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialregistration","titleInlineContent":[{"code":"ASAuthorizationPlatformPublicKeyCredentialRegistration","type":"codeVoice"}],"type":"link","title":"ASAuthorizationPlatformPublicKeyCredentialRegistration"},"doc://com.auth0.Auth0/documentation/Auth0/webAuth(clientId:domain:session:)":{"url":"\/documentation\/auth0\/webauth(clientid:domain:session:)","title":"webAuth(clientId:domain:session:)","abstract":[{"identifier":"https:\/\/auth0.com\/docs\/authenticate\/login\/auth0-universal-login","isActive":true,"type":"reference"},{"text":" client for performing web-based","type":"text"},{"text":" ","type":"text"},{"text":"authentication.","type":"text"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"webAuth","kind":"identifier"},{"text":"(","kind":"text"},{"text":"clientId","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"domain","kind":"externalParam"},{"text":": ","kind":"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"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07WebAuthP","text":"WebAuth","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/webAuth(clientId:domain:session:)","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PhoneEnrollmentChallenge":{"url":"\/documentation\/auth0\/phoneenrollmentchallenge","title":"PhoneEnrollmentChallenge","abstract":[{"type":"text","text":"A Phone enrollment challenge."}],"navigatorTitle":[{"text":"PhoneEnrollmentChallenge","kind":"identifier"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"PhoneEnrollmentChallenge"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PhoneEnrollmentChallenge","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Factors":{"title":"Factors","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factors","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Factors"}],"abstract":[{"type":"text","text":"List of factors enabled for the Auth0 tenant and available for enrollment by this user."}],"url":"\/documentation\/auth0\/factors","navigatorTitle":[{"kind":"identifier","text":"Factors"}]},"doc://com.auth0.Auth0/documentation/Auth0/myAccount(token:domain:session:)":{"title":"myAccount(token:domain:session:)","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/myAccount(token:domain:session:)","role":"symbol","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"myAccount","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"token"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"domain"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"session","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSURLSession","text":"URLSession"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth09MyAccountP","text":"MyAccount"}],"abstract":[{"text":"Auth0 My Account API client for managing the current user’s account.","type":"text"}],"url":"\/documentation\/auth0\/myaccount(token:domain:session:)"},"doc://com.auth0.Auth0/documentation/Auth0/UserAgents":{"title":"ASWebAuthenticationSession vs SFSafariViewController (iOS)","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserAgents","role":"article","kind":"article","abstract":[],"url":"\/documentation\/auth0\/useragents"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage":{"title":"CredentialsStorage","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","role":"symbol","kind":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsStorage","kind":"identifier"}],"abstract":[{"text":"Generic storage API for storing credentials.","type":"text"}],"url":"\/documentation\/auth0\/credentialsstorage","navigatorTitle":[{"text":"CredentialsStorage","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementObject":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"ManagementObject"}],"title":"ManagementObject","role":"symbol","fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementObject"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","abstract":[{"text":"A dictionary containing a user profile.","type":"text"}],"url":"\/documentation\/auth0\/managementobject"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"title":"Request","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"abstract":[{"text":"Auth0 API request.","type":"text"}],"url":"\/documentation\/auth0\/request","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"https://auth0.com/docs/api/authentication":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","url":"https:\/\/auth0.com\/docs\/api\/authentication","titleInlineContent":[{"type":"text","text":"Authentication API"}],"type":"link","title":"Authentication API"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"url":"\/documentation\/auth0\/webauth","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"title":"WebAuth","navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerResult":{"kind":"symbol","abstract":[{"code":"Result","type":"codeVoice"},{"text":" wrapper for Credentials Manager operations.","type":"text"}],"type":"topic","title":"CredentialsManagerResult","url":"\/documentation\/auth0\/credentialsmanagerresult","role":"symbol","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerResult"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerResult","navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerResult"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"Credentials","kind":"identifier"}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccount":{"url":"\/documentation\/auth0\/myaccount","abstract":[{"type":"text","text":"My Account API client for managing the current user’s account."}],"title":"MyAccount","navigatorTitle":[{"text":"MyAccount","kind":"identifier"}],"fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccount"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccount","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyEnrollmentChallenge":{"role":"symbol","title":"PasskeyEnrollmentChallenge","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyEnrollmentChallenge","kind":"identifier"}],"navigatorTitle":[{"text":"PasskeyEnrollmentChallenge","kind":"identifier"}],"abstract":[{"type":"text","text":"A passkey enrollment challenge."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge","url":"\/documentation\/auth0\/passkeyenrollmentchallenge","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"url":"\/documentation\/auth0\/users","title":"Users","abstract":[{"type":"text","text":"Client for the Users endpoints of the Auth0 "},{"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","type":"reference","isActive":true},{"text":".","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"Users"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Users"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/authentication(session:bundle:)":{"role":"symbol","title":"authentication(session:bundle:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authentication","kind":"identifier"},{"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"},{"preciseIdentifier":"c:objc(cs)NSBundle","text":"Bundle","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth014AuthenticationP","text":"Authentication","kind":"typeIdentifier"}],"abstract":[{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","isActive":true},{"type":"text","text":" client to authenticate a user with Database, Social,"},{"type":"text","text":" "},{"type":"text","text":"Enterprise or Passwordless connections."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/authentication(session:bundle:)","url":"\/documentation\/auth0\/authentication(session:bundle:)","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"role":"symbol","title":"patch(_:attributes:)","deprecated":true,"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"patch","kind":"identifier"},{"text":"(","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"attributes","kind":"externalParam"},{"kind":"text","text":": "},{"text":"UserPatchAttributes","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError","kind":"typeIdentifier"},{"kind":"text","text":">"}],"abstract":[{"type":"text","text":"Updates a user’s root values (those which are allowed to be updated)."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","url":"\/documentation\/auth0\/users\/patch(_:attributes:)","required":true,"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/SSOCredentials":{"title":"SSOCredentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials","navigatorTitle":[{"kind":"identifier","text":"SSOCredentials"}],"url":"\/documentation\/auth0\/ssocredentials","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"SSOCredentials"}],"abstract":[{"type":"text","text":"Credentials obtained from Auth0 to perform web single sign-on (SSO)."}],"kind":"symbol","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethods":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethods","type":"topic","title":"AuthenticationMethods","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationMethods"}],"abstract":[{"type":"text","text":"List of authentication methods belonging to the authenticated user."}],"url":"\/documentation\/auth0\/authenticationmethods","navigatorTitle":[{"kind":"identifier","text":"AuthenticationMethods"}]},"doc://com.auth0.Auth0/documentation/Auth0/DatabaseUser":{"url":"\/documentation\/auth0\/databaseuser","abstract":[{"type":"text","text":"A newly created database user (just the email, username, and email verified flag)."}],"title":"DatabaseUser","navigatorTitle":[{"kind":"identifier","text":"DatabaseUser"}],"fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"DatabaseUser"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DatabaseUser","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"url":"\/documentation\/auth0\/jwk","title":"JWK","abstract":[{"type":"text","text":"Cryptographic public key of your Auth0 tenant."}],"navigatorTitle":[{"kind":"identifier","text":"JWK"}],"fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"JWK"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/webAuth(session:bundle:)":{"url":"\/documentation\/auth0\/webauth(session:bundle:)","title":"webAuth(session:bundle:)","abstract":[{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/authenticate\/login\/auth0-universal-login"},{"type":"text","text":" client for performing web-based"},{"type":"text","text":" "},{"type":"text","text":"authentication."}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"webAuth"},{"kind":"text","text":"("},{"kind":"externalParam","text":"session"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSURLSession","text":"URLSession"},{"kind":"text","text":", "},{"kind":"externalParam","text":"bundle"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSBundle","text":"Bundle"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07WebAuthP","text":"WebAuth"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/webAuth(session:bundle:)","role":"symbol","kind":"symbol","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/apicredentials.json b/docs/data/documentation/auth0/apicredentials.json index abaaa5e53..bc1517cc3 100644 --- a/docs/data/documentation/auth0/apicredentials.json +++ b/docs/data/documentation/auth0/apicredentials.json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"APICredentials","kind":"identifier"}]}]}],"variants":[{"paths":["\/documentation\/auth0\/apicredentials"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials\/init(accessToken:tokenType:expiresIn:scope:)"],"title":"Initializers","generated":true,"anchor":"Initializers"},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials\/accessToken","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials\/description","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials\/expiresIn","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials\/scope","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials\/tokenType"],"title":"Instance Properties","generated":true,"anchor":"Instance-Properties"},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials\/Decodable-Implementations"],"title":"Default Implementations","generated":true,"anchor":"Default-Implementations"}],"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials","interfaceLanguage":"swift"},"abstract":[{"text":"User’s credentials obtained from Auth0 for a specific API as the result of exchanging a refresh token.","type":"text"}],"relationshipsSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/s8CopyableP","doc:\/\/com.auth0.Auth0\/s23CustomStringConvertibleP","doc:\/\/com.auth0.Auth0\/Se","doc:\/\/com.auth0.Auth0\/SE"],"kind":"relationships","title":"Conforms To","type":"conformsTo"}],"metadata":{"externalID":"s:5Auth014APICredentialsV","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"APICredentials"}],"title":"APICredentials","role":"symbol","symbolKind":"struct","navigatorTitle":[{"text":"APICredentials","kind":"identifier"}],"roleHeading":"Structure","modules":[{"name":"Auth0"}]},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"references":{"doc://com.auth0.Auth0/Se":{"title":"Swift.Decodable","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/Se"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/APICredentials/tokenType":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials\/tokenType","role":"symbol","url":"\/documentation\/auth0\/apicredentials\/tokentype","title":"tokenType","abstract":[{"text":"Indicates how the access token should be used. For example, as a bearer token.","type":"text"}],"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"tokenType","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/APICredentials":{"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0 for a specific API as the result of exchanging a refresh token."}],"title":"APICredentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials","role":"symbol","navigatorTitle":[{"text":"APICredentials","kind":"identifier"}],"url":"\/documentation\/auth0\/apicredentials","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"APICredentials","kind":"identifier"}],"type":"topic"},"doc://com.auth0.Auth0/SE":{"title":"Swift.Encodable","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/SE"},"doc://com.auth0.Auth0/documentation/Auth0/APICredentials/Decodable-Implementations":{"abstract":[],"url":"\/documentation\/auth0\/apicredentials\/decodable-implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials\/Decodable-Implementations","role":"collectionGroup","type":"topic","kind":"article","title":"Decodable Implementations"},"doc://com.auth0.Auth0/documentation/Auth0/APICredentials/init(accessToken:tokenType:expiresIn:scope:)":{"role":"symbol","abstract":[{"text":"Default initializer.","type":"text"}],"url":"\/documentation\/auth0\/apicredentials\/init(accesstoken:tokentype:expiresin:scope:)","title":"init(accessToken:tokenType:expiresIn:scope:)","type":"topic","kind":"symbol","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"accessToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"tokenType"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"expiresIn"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":")"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials\/init(accessToken:tokenType:expiresIn:scope:)"},"doc://com.auth0.Auth0/s23CustomStringConvertibleP":{"title":"Swift.CustomStringConvertible","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s23CustomStringConvertibleP"},"doc://com.auth0.Auth0/documentation/Auth0/APICredentials/expiresIn":{"title":"expiresIn","url":"\/documentation\/auth0\/apicredentials\/expiresin","kind":"symbol","role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials\/expiresIn","abstract":[{"text":"When the access token expires.","type":"text"}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"expiresIn"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"}]},"doc://com.auth0.Auth0/s8CopyableP":{"title":"Swift.Copyable","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s8CopyableP"},"doc://com.auth0.Auth0/documentation/Auth0/APICredentials/scope":{"url":"\/documentation\/auth0\/apicredentials\/scope","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials\/scope","abstract":[{"type":"text","text":"The scopes that have been granted by Auth0."}],"role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"scope","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"title":"scope","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/APICredentials/accessToken":{"abstract":[{"text":"Token that can be used to make authenticated requests to the API.","type":"text"}],"title":"accessToken","type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"accessToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"kind":"symbol","url":"\/documentation\/auth0\/apicredentials\/accesstoken","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials\/accessToken"},"doc://com.auth0.Auth0/documentation/Auth0/APICredentials/description":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials\/description","type":"topic","role":"symbol","abstract":[{"text":"Custom description that redacts the access token with ","type":"text"},{"code":"","type":"codeVoice"},{"text":".","type":"text"}],"kind":"symbol","title":"description","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"description","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"url":"\/documentation\/auth0\/apicredentials\/description"}}} \ No newline at end of file +{"topicSections":[{"generated":true,"title":"Initializers","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials\/init(accessToken:tokenType:expiresIn:scope:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials\/init(from:)-5sa91"],"anchor":"Initializers"},{"generated":true,"title":"Instance Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials\/accessToken","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials\/description","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials\/expiresIn","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials\/scope","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials\/tokenType"],"anchor":"Instance-Properties"},{"generated":true,"title":"Default Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials\/Decodable-Implementations"],"anchor":"Default-Implementations"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"relationshipsSections":[{"title":"Conforms To","identifiers":["doc:\/\/com.auth0.Auth0\/s8CopyableP","doc:\/\/com.auth0.Auth0\/s23CustomStringConvertibleP","doc:\/\/com.auth0.Auth0\/Se","doc:\/\/com.auth0.Auth0\/SE"],"type":"conformsTo","kind":"relationships"}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"APICredentials"}],"platforms":["iOS"]}],"kind":"declarations"}],"sections":[],"abstract":[{"text":"User’s credentials obtained from Auth0 for a specific API as the result of exchanging a refresh token.","type":"text"}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/apicredentials"]}],"metadata":{"role":"symbol","modules":[{"name":"Auth0"}],"title":"APICredentials","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"APICredentials"}],"externalID":"s:5Auth014APICredentialsV","navigatorTitle":[{"text":"APICredentials","kind":"identifier"}],"roleHeading":"Structure","symbolKind":"struct"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/APICredentials/description":{"kind":"symbol","title":"description","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"description","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials\/description","abstract":[{"text":"Custom description that redacts the access token with ","type":"text"},{"code":"","type":"codeVoice"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/apicredentials\/description"},"doc://com.auth0.Auth0/documentation/Auth0/APICredentials/init(from:)-5sa91":{"role":"symbol","title":"init(from:)","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"text":")","kind":"text"}],"abstract":[],"kind":"symbol","url":"\/documentation\/auth0\/apicredentials\/init(from:)-5sa91","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials\/init(from:)-5sa91","type":"topic"},"doc://com.auth0.Auth0/s8CopyableP":{"type":"unresolvable","title":"Swift.Copyable","identifier":"doc:\/\/com.auth0.Auth0\/s8CopyableP"},"doc://com.auth0.Auth0/documentation/Auth0/APICredentials/tokenType":{"kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"tokenType"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"title":"tokenType","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Indicates how the access token should be used. For example, as a bearer token."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials\/tokenType","url":"\/documentation\/auth0\/apicredentials\/tokentype"},"doc://com.auth0.Auth0/documentation/Auth0/APICredentials/accessToken":{"role":"symbol","title":"accessToken","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"accessToken","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"abstract":[{"text":"Token that can be used to make authenticated requests to the API.","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/apicredentials\/accesstoken","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials\/accessToken","type":"topic"},"doc://com.auth0.Auth0/Se":{"type":"unresolvable","title":"Swift.Decodable","identifier":"doc:\/\/com.auth0.Auth0\/Se"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/SE":{"type":"unresolvable","title":"Swift.Encodable","identifier":"doc:\/\/com.auth0.Auth0\/SE"},"doc://com.auth0.Auth0/documentation/Auth0/APICredentials/expiresIn":{"role":"symbol","title":"expiresIn","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"expiresIn","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation4DateV","text":"Date","kind":"typeIdentifier"}],"abstract":[{"text":"When the access token expires.","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/apicredentials\/expiresin","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials\/expiresIn","type":"topic"},"doc://com.auth0.Auth0/s23CustomStringConvertibleP":{"type":"unresolvable","title":"Swift.CustomStringConvertible","identifier":"doc:\/\/com.auth0.Auth0\/s23CustomStringConvertibleP"},"doc://com.auth0.Auth0/documentation/Auth0/APICredentials":{"role":"symbol","title":"APICredentials","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"APICredentials"}],"navigatorTitle":[{"kind":"identifier","text":"APICredentials"}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0 for a specific API as the result of exchanging a refresh token."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials","url":"\/documentation\/auth0\/apicredentials","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/APICredentials/scope":{"role":"symbol","title":"scope","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"scope","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"abstract":[{"text":"The scopes that have been granted by Auth0.","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/apicredentials\/scope","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials\/scope","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/APICredentials/init(accessToken:tokenType:expiresIn:scope:)":{"url":"\/documentation\/auth0\/apicredentials\/init(accesstoken:tokentype:expiresin:scope:)","title":"init(accessToken:tokenType:expiresIn:scope:)","abstract":[{"type":"text","text":"Default initializer."}],"fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"accessToken"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"tokenType"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"expiresIn"},{"kind":"text","text":": "},{"preciseIdentifier":"s:10Foundation4DateV","kind":"typeIdentifier","text":"Date"},{"kind":"text","text":", "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":")"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials\/init(accessToken:tokenType:expiresIn:scope:)","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/APICredentials/Decodable-Implementations":{"role":"collectionGroup","title":"Decodable Implementations","abstract":[],"kind":"article","url":"\/documentation\/auth0\/apicredentials\/decodable-implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials\/Decodable-Implementations","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/apicredentials/accesstoken.json b/docs/data/documentation/auth0/apicredentials/accesstoken.json index d8a5f17da..e2a40fc82 100644 --- a/docs/data/documentation/auth0/apicredentials/accesstoken.json +++ b/docs/data/documentation/auth0/apicredentials/accesstoken.json @@ -1 +1 @@ -{"schemaVersion":{"patch":0,"major":0,"minor":3},"sections":[],"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/access-tokens"],"title":"Related Documentation","anchor":"Related-Documentation"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials"]]},"metadata":{"role":"symbol","title":"accessToken","roleHeading":"Instance Property","symbolKind":"property","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"accessToken","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"modules":[{"name":"Auth0"}],"externalID":"s:5Auth014APICredentialsV11accessTokenSSvp"},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"accessToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"languages":["swift"]}],"kind":"declarations"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/apicredentials\/accesstoken"]}],"abstract":[{"text":"Token that can be used to make authenticated requests to the API.","type":"text"}],"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials\/accessToken"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/APICredentials":{"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0 for a specific API as the result of exchanging a refresh token."}],"title":"APICredentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials","role":"symbol","navigatorTitle":[{"text":"APICredentials","kind":"identifier"}],"url":"\/documentation\/auth0\/apicredentials","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"APICredentials","kind":"identifier"}],"type":"topic"},"https://auth0.com/docs/secure/tokens/access-tokens":{"title":"Access Tokens","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/access-tokens","type":"link","titleInlineContent":[{"text":"Access Tokens","type":"text"}],"identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/access-tokens"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/APICredentials/accessToken":{"abstract":[{"text":"Token that can be used to make authenticated requests to the API.","type":"text"}],"title":"accessToken","type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"accessToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"kind":"symbol","url":"\/documentation\/auth0\/apicredentials\/accesstoken","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials\/accessToken"}}} \ No newline at end of file +{"metadata":{"symbolKind":"property","title":"accessToken","externalID":"s:5Auth014APICredentialsV11accessTokenSSvp","roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"accessToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"role":"symbol"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/apicredentials\/accesstoken"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials\/accessToken","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"type":"text","text":"Token that can be used to make authenticated requests to the API."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials"]]},"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/access-tokens"],"anchor":"Related-Documentation"}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"accessToken","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}]}],"kind":"declarations"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/APICredentials":{"role":"symbol","title":"APICredentials","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"APICredentials"}],"navigatorTitle":[{"kind":"identifier","text":"APICredentials"}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0 for a specific API as the result of exchanging a refresh token."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials","url":"\/documentation\/auth0\/apicredentials","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/APICredentials/accessToken":{"role":"symbol","title":"accessToken","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"accessToken","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"abstract":[{"text":"Token that can be used to make authenticated requests to the API.","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/apicredentials\/accesstoken","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials\/accessToken","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"https://auth0.com/docs/secure/tokens/access-tokens":{"identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/access-tokens","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/access-tokens","titleInlineContent":[{"type":"text","text":"Access Tokens"}],"type":"link","title":"Access Tokens"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/apicredentials/decodable-implementations.json b/docs/data/documentation/auth0/apicredentials/decodable-implementations.json index afc65a125..0f722b284 100644 --- a/docs/data/documentation/auth0/apicredentials/decodable-implementations.json +++ b/docs/data/documentation/auth0/apicredentials/decodable-implementations.json @@ -1 +1 @@ -{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/apicredentials\/decodable-implementations"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials\/init(from:)"],"title":"Initializers","generated":true,"anchor":"Initializers"}],"sections":[],"kind":"article","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials\/Decodable-Implementations","interfaceLanguage":"swift"},"metadata":{"modules":[{"name":"Auth0"}],"title":"Decodable Implementations","role":"collectionGroup","roleHeading":"API Collection"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/APICredentials":{"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0 for a specific API as the result of exchanging a refresh token."}],"title":"APICredentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials","role":"symbol","navigatorTitle":[{"text":"APICredentials","kind":"identifier"}],"url":"\/documentation\/auth0\/apicredentials","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"APICredentials","kind":"identifier"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/APICredentials/init(from:)":{"abstract":[],"title":"init(from:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials\/init(from:)","role":"symbol","url":"\/documentation\/auth0\/apicredentials\/init(from:)","kind":"symbol","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": any "},{"preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier","text":"Decoder"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"type":"topic"}}} \ No newline at end of file +{"metadata":{"modules":[{"name":"Auth0"}],"role":"collectionGroup","title":"Decodable Implementations","roleHeading":"API Collection"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/apicredentials\/decodable-implementations"]}],"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials\/init(from:)-8e5ds"],"title":"Initializers","generated":true,"anchor":"Initializers"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials\/Decodable-Implementations","interfaceLanguage":"swift"},"kind":"article","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials"]]},"schemaVersion":{"minor":3,"patch":0,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/APICredentials/init(from:)-8e5ds":{"kind":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":": any ","kind":"text"},{"text":"Decoder","kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"title":"init(from:)","type":"topic","role":"symbol","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials\/init(from:)-8e5ds","url":"\/documentation\/auth0\/apicredentials\/init(from:)-8e5ds"},"doc://com.auth0.Auth0/documentation/Auth0/APICredentials":{"role":"symbol","title":"APICredentials","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"APICredentials"}],"navigatorTitle":[{"kind":"identifier","text":"APICredentials"}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0 for a specific API as the result of exchanging a refresh token."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials","url":"\/documentation\/auth0\/apicredentials","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/apicredentials/description.json b/docs/data/documentation/auth0/apicredentials/description.json index ca84c478e..3cae9ec9e 100644 --- a/docs/data/documentation/auth0/apicredentials/description.json +++ b/docs/data/documentation/auth0/apicredentials/description.json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"description","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}]}],"kind":"symbol","sections":[],"metadata":{"modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"description"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"symbolKind":"property","title":"description","roleHeading":"Instance Property","role":"symbol","externalID":"s:5Auth014APICredentialsV11descriptionSSvp"},"variants":[{"paths":["\/documentation\/auth0\/apicredentials\/description"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials\/description"},"schemaVersion":{"patch":0,"major":0,"minor":3},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials"]]},"abstract":[{"text":"Custom description that redacts the access token with ","type":"text"},{"code":"","type":"codeVoice"},{"text":".","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/APICredentials":{"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0 for a specific API as the result of exchanging a refresh token."}],"title":"APICredentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials","role":"symbol","navigatorTitle":[{"text":"APICredentials","kind":"identifier"}],"url":"\/documentation\/auth0\/apicredentials","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"APICredentials","kind":"identifier"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/APICredentials/description":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials\/description","type":"topic","role":"symbol","abstract":[{"text":"Custom description that redacts the access token with ","type":"text"},{"code":"","type":"codeVoice"},{"text":".","type":"text"}],"kind":"symbol","title":"description","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"description","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"url":"\/documentation\/auth0\/apicredentials\/description"}}} \ No newline at end of file +{"variants":[{"paths":["\/documentation\/auth0\/apicredentials\/description"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials"]]},"abstract":[{"type":"text","text":"Custom description that redacts the access token with "},{"type":"codeVoice","code":""},{"type":"text","text":"."}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"description"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}]}],"kind":"declarations"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","sections":[],"metadata":{"externalID":"s:5Auth014APICredentialsV11descriptionSSvp","symbolKind":"property","title":"description","roleHeading":"Instance Property","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"description"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"modules":[{"name":"Auth0"}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials\/description"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/APICredentials/description":{"kind":"symbol","title":"description","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"description","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials\/description","abstract":[{"text":"Custom description that redacts the access token with ","type":"text"},{"code":"","type":"codeVoice"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/apicredentials\/description"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/APICredentials":{"role":"symbol","title":"APICredentials","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"APICredentials"}],"navigatorTitle":[{"kind":"identifier","text":"APICredentials"}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0 for a specific API as the result of exchanging a refresh token."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials","url":"\/documentation\/auth0\/apicredentials","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/apicredentials/expiresin.json b/docs/data/documentation/auth0/apicredentials/expiresin.json index 4f03fb61c..3c4f54028 100644 --- a/docs/data/documentation/auth0/apicredentials/expiresin.json +++ b/docs/data/documentation/auth0/apicredentials/expiresin.json @@ -1 +1 @@ -{"metadata":{"modules":[{"name":"Auth0"}],"symbolKind":"property","role":"symbol","roleHeading":"Instance Property","externalID":"s:5Auth014APICredentialsV9expiresIn10Foundation4DateVvp","title":"expiresIn","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"expiresIn","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Date","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DateV"}]},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials\/expiresIn","interfaceLanguage":"swift"},"sections":[],"kind":"symbol","abstract":[{"text":"When the access token expires.","type":"text"}],"variants":[{"paths":["\/documentation\/auth0\/apicredentials\/expiresin"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"expiresIn","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Date","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DateV"}],"languages":["swift"],"platforms":["iOS"]}]}],"schemaVersion":{"major":0,"patch":0,"minor":3},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/APICredentials/expiresIn":{"title":"expiresIn","url":"\/documentation\/auth0\/apicredentials\/expiresin","kind":"symbol","role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials\/expiresIn","abstract":[{"text":"When the access token expires.","type":"text"}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"expiresIn"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"}]},"doc://com.auth0.Auth0/documentation/Auth0/APICredentials":{"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0 for a specific API as the result of exchanging a refresh token."}],"title":"APICredentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials","role":"symbol","navigatorTitle":[{"text":"APICredentials","kind":"identifier"}],"url":"\/documentation\/auth0\/apicredentials","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"APICredentials","kind":"identifier"}],"type":"topic"}}} \ No newline at end of file +{"abstract":[{"type":"text","text":"When the access token expires."}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"expiresIn","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Date","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DateV"}]}],"kind":"declarations"}],"variants":[{"paths":["\/documentation\/auth0\/apicredentials\/expiresin"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials"]]},"metadata":{"modules":[{"name":"Auth0"}],"title":"expiresIn","symbolKind":"property","roleHeading":"Instance Property","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"expiresIn","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Date","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DateV"}],"externalID":"s:5Auth014APICredentialsV9expiresIn10Foundation4DateVvp"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials\/expiresIn","interfaceLanguage":"swift"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/APICredentials/expiresIn":{"role":"symbol","title":"expiresIn","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"expiresIn","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation4DateV","text":"Date","kind":"typeIdentifier"}],"abstract":[{"text":"When the access token expires.","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/apicredentials\/expiresin","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials\/expiresIn","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/APICredentials":{"role":"symbol","title":"APICredentials","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"APICredentials"}],"navigatorTitle":[{"kind":"identifier","text":"APICredentials"}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0 for a specific API as the result of exchanging a refresh token."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials","url":"\/documentation\/auth0\/apicredentials","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/apicredentials/init(accesstoken:tokentype:expiresin:scope:).json b/docs/data/documentation/auth0/apicredentials/init(accesstoken:tokentype:expiresin:scope:).json index 7f9e685c3..1a5577d21 100644 --- a/docs/data/documentation/auth0/apicredentials/init(accesstoken:tokentype:expiresin:scope:).json +++ b/docs/data/documentation/auth0/apicredentials/init(accesstoken:tokentype:expiresin:scope:).json @@ -1 +1 @@ -{"metadata":{"title":"init(accessToken:tokenType:expiresIn:scope:)","roleHeading":"Initializer","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"accessToken"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"tokenType"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"expiresIn"},{"kind":"text","text":": "},{"preciseIdentifier":"s:10Foundation4DateV","kind":"typeIdentifier","text":"Date"},{"kind":"text","text":", "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":")"}],"symbolKind":"init","externalID":"s:5Auth014APICredentialsV11accessToken9tokenType9expiresIn5scopeACSS_SS10Foundation4DateVSStcfc","role":"symbol","modules":[{"name":"Auth0"}]},"schemaVersion":{"patch":0,"major":0,"minor":3},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials"]]},"abstract":[{"type":"text","text":"Default initializer."}],"sections":[],"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"accessToken"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"tokenType"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","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","text":"String","kind":"typeIdentifier"},{"text":")","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials\/init(accessToken:tokenType:expiresIn:scope:)"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/apicredentials\/init(accesstoken:tokentype:expiresin:scope:)"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/APICredentials/init(accessToken:tokenType:expiresIn:scope:)":{"role":"symbol","abstract":[{"text":"Default initializer.","type":"text"}],"url":"\/documentation\/auth0\/apicredentials\/init(accesstoken:tokentype:expiresin:scope:)","title":"init(accessToken:tokenType:expiresIn:scope:)","type":"topic","kind":"symbol","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"accessToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"tokenType"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"expiresIn"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":")"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials\/init(accessToken:tokenType:expiresIn:scope:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/APICredentials":{"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0 for a specific API as the result of exchanging a refresh token."}],"title":"APICredentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials","role":"symbol","navigatorTitle":[{"text":"APICredentials","kind":"identifier"}],"url":"\/documentation\/auth0\/apicredentials","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"APICredentials","kind":"identifier"}],"type":"topic"}}} \ No newline at end of file +{"metadata":{"modules":[{"name":"Auth0"}],"externalID":"s:5Auth014APICredentialsV11accessToken9tokenType9expiresIn5scopeACSS_SS10Foundation4DateVSStcfc","title":"init(accessToken:tokenType:expiresIn:scope:)","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"},{"text":"tokenType","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"expiresIn","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Date","preciseIdentifier":"s:10Foundation4DateV","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":")","kind":"text"}],"roleHeading":"Initializer","role":"symbol","symbolKind":"init"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/apicredentials\/init(accesstoken:tokentype:expiresin:scope:)"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials\/init(accessToken:tokenType:expiresIn:scope:)"},"kind":"symbol","abstract":[{"type":"text","text":"Default initializer."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"init","kind":"keyword"},{"text":"(","kind":"text"},{"text":"accessToken","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"tokenType","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"expiresIn","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Date","preciseIdentifier":"s:10Foundation4DateV","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":")","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/APICredentials":{"role":"symbol","title":"APICredentials","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"APICredentials"}],"navigatorTitle":[{"kind":"identifier","text":"APICredentials"}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0 for a specific API as the result of exchanging a refresh token."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials","url":"\/documentation\/auth0\/apicredentials","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/APICredentials/init(accessToken:tokenType:expiresIn:scope:)":{"url":"\/documentation\/auth0\/apicredentials\/init(accesstoken:tokentype:expiresin:scope:)","title":"init(accessToken:tokenType:expiresIn:scope:)","abstract":[{"type":"text","text":"Default initializer."}],"fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"accessToken"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"tokenType"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"expiresIn"},{"kind":"text","text":": "},{"preciseIdentifier":"s:10Foundation4DateV","kind":"typeIdentifier","text":"Date"},{"kind":"text","text":", "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":")"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials\/init(accessToken:tokenType:expiresIn:scope:)","role":"symbol","kind":"symbol","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/apicredentials/init(from:)-5sa91.json b/docs/data/documentation/auth0/apicredentials/init(from:)-5sa91.json new file mode 100644 index 000000000..fd7e553d5 --- /dev/null +++ b/docs/data/documentation/auth0/apicredentials/init(from:)-5sa91.json @@ -0,0 +1 @@ +{"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"init","kind":"keyword"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"credentials","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"Credentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"text":")","kind":"text"}]}]}],"variants":[{"paths":["\/documentation\/auth0\/apicredentials\/init(from:)-5sa91"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials"]]},"metadata":{"externalID":"s:5Auth014APICredentialsV4fromAcA11CredentialsC_tcfc","extendedModule":"Auth0","symbolKind":"init","title":"init(from:)","roleHeading":"Initializer","role":"symbol","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"},{"kind":"text","text":")"}],"modules":[{"name":"Auth0"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials\/init(from:)-5sa91","interfaceLanguage":"swift"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/APICredentials":{"role":"symbol","title":"APICredentials","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"APICredentials"}],"navigatorTitle":[{"kind":"identifier","text":"APICredentials"}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0 for a specific API as the result of exchanging a refresh token."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials","url":"\/documentation\/auth0\/apicredentials","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"Credentials","kind":"identifier"}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}]},"doc://com.auth0.Auth0/documentation/Auth0/APICredentials/init(from:)-5sa91":{"role":"symbol","title":"init(from:)","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"text":")","kind":"text"}],"abstract":[],"kind":"symbol","url":"\/documentation\/auth0\/apicredentials\/init(from:)-5sa91","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials\/init(from:)-5sa91","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/apicredentials/init(from:)-8e5ds.json b/docs/data/documentation/auth0/apicredentials/init(from:)-8e5ds.json new file mode 100644 index 000000000..fe5c185a0 --- /dev/null +++ b/docs/data/documentation/auth0/apicredentials/init(from:)-8e5ds.json @@ -0,0 +1 @@ +{"abstract":[{"type":"text","text":"Inherited from "},{"code":"Decodable.init(from:)","type":"codeVoice"},{"type":"text","text":"."}],"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 "},{"kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP","text":"Decoder"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"variants":[{"paths":["\/documentation\/auth0\/apicredentials\/init(from:)-8e5ds"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials"]]},"metadata":{"modules":[{"name":"Auth0"}],"title":"init(from:)","roleHeading":"Initializer","symbolKind":"init","role":"symbol","extendedModule":"Auth0","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": any "},{"preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier","text":"Decoder"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"externalID":"s:5Auth014APICredentialsV4fromACs7Decoder_p_tKcfc"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials\/init(from:)-8e5ds","interfaceLanguage":"swift"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/APICredentials":{"role":"symbol","title":"APICredentials","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"APICredentials"}],"navigatorTitle":[{"kind":"identifier","text":"APICredentials"}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0 for a specific API as the result of exchanging a refresh token."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials","url":"\/documentation\/auth0\/apicredentials","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/APICredentials/init(from:)-8e5ds":{"kind":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":": any ","kind":"text"},{"text":"Decoder","kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"title":"init(from:)","type":"topic","role":"symbol","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials\/init(from:)-8e5ds","url":"\/documentation\/auth0\/apicredentials\/init(from:)-8e5ds"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/apicredentials/init(from:).json b/docs/data/documentation/auth0/apicredentials/init(from:).json deleted file mode 100644 index dd8378e15..000000000 --- a/docs/data/documentation/auth0/apicredentials/init(from:).json +++ /dev/null @@ -1 +0,0 @@ -{"metadata":{"symbolKind":"init","title":"init(from:)","role":"symbol","modules":[{"name":"Auth0"}],"extendedModule":"Auth0","externalID":"s:5Auth014APICredentialsV4fromACs7Decoder_p_tKcfc","roleHeading":"Initializer","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":": any ","kind":"text"},{"text":"Decoder","kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}]},"kind":"symbol","abstract":[{"text":"Inherited from ","type":"text"},{"code":"Decodable.init(from:)","type":"codeVoice"},{"text":".","type":"text"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"init","kind":"keyword"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"decoder","kind":"internalParam"},{"text":": any ","kind":"text"},{"preciseIdentifier":"s:s7DecoderP","text":"Decoder","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}]}]}],"variants":[{"paths":["\/documentation\/auth0\/apicredentials\/init(from:)"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials\/init(from:)","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/APICredentials":{"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0 for a specific API as the result of exchanging a refresh token."}],"title":"APICredentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials","role":"symbol","navigatorTitle":[{"text":"APICredentials","kind":"identifier"}],"url":"\/documentation\/auth0\/apicredentials","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"APICredentials","kind":"identifier"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/APICredentials/init(from:)":{"abstract":[],"title":"init(from:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials\/init(from:)","role":"symbol","url":"\/documentation\/auth0\/apicredentials\/init(from:)","kind":"symbol","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": any "},{"preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier","text":"Decoder"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/apicredentials/scope.json b/docs/data/documentation/auth0/apicredentials/scope.json index ed4992abc..b643f846f 100644 --- a/docs/data/documentation/auth0/apicredentials/scope.json +++ b/docs/data/documentation/auth0/apicredentials/scope.json @@ -1 +1 @@ -{"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/apicredentials\/scope"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials"]]},"sections":[],"metadata":{"role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"scope","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"externalID":"s:5Auth014APICredentialsV5scopeSSvp","symbolKind":"property","roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"title":"scope"},"schemaVersion":{"major":0,"minor":3,"patch":0},"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/get-started\/apis\/scopes"],"anchor":"Related-Documentation","title":"Related Documentation"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials\/scope"},"abstract":[{"text":"The scopes that have been granted by Auth0.","type":"text"}],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"scope"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"https://auth0.com/docs/get-started/apis/scopes":{"url":"https:\/\/auth0.com\/docs\/get-started\/apis\/scopes","titleInlineContent":[{"text":"Scopes","type":"text"}],"identifier":"https:\/\/auth0.com\/docs\/get-started\/apis\/scopes","title":"Scopes","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/APICredentials":{"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0 for a specific API as the result of exchanging a refresh token."}],"title":"APICredentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials","role":"symbol","navigatorTitle":[{"text":"APICredentials","kind":"identifier"}],"url":"\/documentation\/auth0\/apicredentials","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"APICredentials","kind":"identifier"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/APICredentials/scope":{"url":"\/documentation\/auth0\/apicredentials\/scope","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials\/scope","abstract":[{"type":"text","text":"The scopes that have been granted by Auth0."}],"role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"scope","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"title":"scope","type":"topic"}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/apicredentials\/scope"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials"]]},"abstract":[{"type":"text","text":"The scopes that have been granted by Auth0."}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}]}],"kind":"declarations"}],"kind":"symbol","schemaVersion":{"major":0,"patch":0,"minor":3},"sections":[],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/get-started\/apis\/scopes"],"anchor":"Related-Documentation"}],"metadata":{"externalID":"s:5Auth014APICredentialsV5scopeSSvp","modules":[{"name":"Auth0"}],"title":"scope","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"roleHeading":"Instance Property","role":"symbol","symbolKind":"property"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials\/scope","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/APICredentials":{"role":"symbol","title":"APICredentials","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"APICredentials"}],"navigatorTitle":[{"kind":"identifier","text":"APICredentials"}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0 for a specific API as the result of exchanging a refresh token."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials","url":"\/documentation\/auth0\/apicredentials","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/APICredentials/scope":{"role":"symbol","title":"scope","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"scope","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"abstract":[{"text":"The scopes that have been granted by Auth0.","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/apicredentials\/scope","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials\/scope","type":"topic"},"https://auth0.com/docs/get-started/apis/scopes":{"identifier":"https:\/\/auth0.com\/docs\/get-started\/apis\/scopes","titleInlineContent":[{"text":"Scopes","type":"text"}],"url":"https:\/\/auth0.com\/docs\/get-started\/apis\/scopes","title":"Scopes","type":"link"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/apicredentials/tokentype.json b/docs/data/documentation/auth0/apicredentials/tokentype.json index 5ebb86a16..4e5df7d84 100644 --- a/docs/data/documentation/auth0/apicredentials/tokentype.json +++ b/docs/data/documentation/auth0/apicredentials/tokentype.json @@ -1 +1 @@ -{"metadata":{"externalID":"s:5Auth014APICredentialsV9tokenTypeSSvp","title":"tokenType","roleHeading":"Instance Property","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"tokenType"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"role":"symbol","symbolKind":"property","modules":[{"name":"Auth0"}]},"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials\/tokenType","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials"]]},"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"tokenType"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"platforms":["iOS"]}],"kind":"declarations"}],"abstract":[{"type":"text","text":"Indicates how the access token should be used. For example, as a bearer token."}],"variants":[{"paths":["\/documentation\/auth0\/apicredentials\/tokentype"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/APICredentials":{"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0 for a specific API as the result of exchanging a refresh token."}],"title":"APICredentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials","role":"symbol","navigatorTitle":[{"text":"APICredentials","kind":"identifier"}],"url":"\/documentation\/auth0\/apicredentials","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"APICredentials","kind":"identifier"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/APICredentials/tokenType":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials\/tokenType","role":"symbol","url":"\/documentation\/auth0\/apicredentials\/tokentype","title":"tokenType","abstract":[{"text":"Indicates how the access token should be used. For example, as a bearer token.","type":"text"}],"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"tokenType","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"abstract":[{"type":"text","text":"Indicates how the access token should be used. For example, as a bearer token."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"tokenType","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/apicredentials\/tokentype"]}],"schemaVersion":{"patch":0,"minor":3,"major":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials"]]},"metadata":{"modules":[{"name":"Auth0"}],"title":"tokenType","roleHeading":"Instance Property","symbolKind":"property","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"tokenType"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"externalID":"s:5Auth014APICredentialsV9tokenTypeSSvp"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials\/tokenType","interfaceLanguage":"swift"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/APICredentials/tokenType":{"kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"tokenType"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"title":"tokenType","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Indicates how the access token should be used. For example, as a bearer token."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials\/tokenType","url":"\/documentation\/auth0\/apicredentials\/tokentype"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/APICredentials":{"role":"symbol","title":"APICredentials","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"APICredentials"}],"navigatorTitle":[{"kind":"identifier","text":"APICredentials"}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0 for a specific API as the result of exchanging a refresh token."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials","url":"\/documentation\/auth0\/apicredentials","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/auth0apierror.json b/docs/data/documentation/auth0/auth0apierror.json index 71d1103be..805d91847 100644 --- a/docs/data/documentation/auth0/auth0apierror.json +++ b/docs/data/documentation/auth0/auth0apierror.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\/s5ErrorP","doc:\/\/com.auth0.Auth0\/s8SendableP","doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP"],"type":"inheritsFrom","title":"Inherits From","kind":"relationships"},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError"],"type":"conformingTypes","title":"Conforming Types","kind":"relationships"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/auth0apierror"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/init(info:statusCode:)"],"title":"Initializers","anchor":"Initializers","generated":true},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/code","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/info","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/isNetworkError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/statusCode"],"title":"Instance Properties","anchor":"Instance-Properties","generated":true}],"metadata":{"symbolKind":"protocol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Auth0APIError","kind":"identifier"}],"externalID":"s:5Auth00A8APIErrorP","roleHeading":"Protocol","navigatorTitle":[{"kind":"identifier","text":"Auth0APIError"}],"modules":[{"name":"Auth0"}],"role":"symbol","title":"Auth0APIError"},"kind":"symbol","sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","interfaceLanguage":"swift"},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Auth0APIError","kind":"identifier"},{"text":" : ","kind":"text"},{"text":"Auth0Error","kind":"typeIdentifier","preciseIdentifier":"s:5Auth00A5ErrorP","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error"}],"languages":["swift"]}],"kind":"declarations"}],"schemaVersion":{"minor":3,"patch":0,"major":0},"abstract":[{"text":"Generic representation of Auth0 API errors.","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error":{"url":"\/documentation\/auth0\/auth0error","title":"Auth0Error","kind":"symbol","type":"topic","abstract":[{"type":"text","text":"Generic representation of Auth0 errors."}],"role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Auth0Error"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","navigatorTitle":[{"kind":"identifier","text":"Auth0Error"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","type":"topic","url":"\/documentation\/auth0\/auth0apierror","title":"Auth0APIError","abstract":[{"type":"text","text":"Generic representation of Auth0 API errors."}],"role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Auth0APIError","kind":"identifier"}],"kind":"symbol","navigatorTitle":[{"text":"Auth0APIError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError/init(info:statusCode:)":{"url":"\/documentation\/auth0\/auth0apierror\/init(info:statuscode:)","title":"init(info:statusCode:)","kind":"symbol","required":true,"type":"topic","abstract":[{"type":"text","text":"Creates an error from a JSON response."}],"role":"symbol","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"info"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"statusCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"},{"kind":"text","text":")"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/init(info:statusCode:)"},"doc://com.auth0.Auth0/s5ErrorP":{"type":"unresolvable","title":"Swift.Error","identifier":"doc:\/\/com.auth0.Auth0\/s5ErrorP"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError/statusCode":{"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"statusCode","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Int","preciseIdentifier":"s:Si","kind":"typeIdentifier"}],"required":true,"type":"topic","abstract":[{"text":"HTTP status code of the response.","type":"text"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/statusCode","url":"\/documentation\/auth0\/auth0apierror\/statuscode","title":"statusCode","kind":"symbol"},"doc://com.auth0.Auth0/10Foundation14LocalizedErrorP":{"type":"unresolvable","title":"Foundation.LocalizedError","identifier":"doc:\/\/com.auth0.Auth0\/10Foundation14LocalizedErrorP"},"doc://com.auth0.Auth0/s16SendableMetatypeP":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP","title":"Swift.SendableMetatype"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"type":"topic","url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","kind":"symbol","title":"ManagementError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}]},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError/info":{"required":true,"role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/info","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"info"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]"}],"kind":"symbol","abstract":[{"type":"text","text":"Raw error values."}],"title":"info","url":"\/documentation\/auth0\/auth0apierror\/info"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError/code":{"title":"code","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"code","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"required":true,"kind":"symbol","abstract":[{"text":"Error code.","type":"text"}],"type":"topic","role":"symbol","url":"\/documentation\/auth0\/auth0apierror\/code","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/code"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError/isNetworkError":{"kind":"symbol","title":"isNetworkError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/isNetworkError","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isNetworkError","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"type":"topic","role":"symbol","abstract":[{"type":"text","text":"Whether the request failed due to network issues."}],"url":"\/documentation\/auth0\/auth0apierror\/isnetworkerror"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","type":"topic","kind":"symbol","abstract":[{"text":"Represents an error during a request to the Auth0 My Account API.","type":"text"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountError","kind":"identifier"}],"navigatorTitle":[{"text":"MyAccountError","kind":"identifier"}],"url":"\/documentation\/auth0\/myaccounterror","role":"symbol"},"doc://com.auth0.Auth0/s28CustomDebugStringConvertibleP":{"identifier":"doc:\/\/com.auth0.Auth0\/s28CustomDebugStringConvertibleP","type":"unresolvable","title":"Swift.CustomDebugStringConvertible"},"doc://com.auth0.Auth0/s8SendableP":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s8SendableP","title":"Swift.Sendable"}}} \ No newline at end of file +{"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"protocol"},{"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"}],"platforms":["iOS"]}]}],"relationshipsSections":[{"title":"Inherits From","kind":"relationships","type":"inheritsFrom","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","doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP"]},{"title":"Conforming Types","kind":"relationships","type":"conformingTypes","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError"]}],"topicSections":[{"anchor":"Initializers","title":"Initializers","generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/init(info:statusCode:)"]},{"anchor":"Instance-Properties","title":"Instance Properties","generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/code","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/info","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/isNetworkError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/statusCode"]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/auth0apierror"]}],"sections":[],"schemaVersion":{"patch":0,"major":0,"minor":3},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","interfaceLanguage":"swift"},"abstract":[{"text":"Generic representation of Auth0 API errors.","type":"text"}],"metadata":{"roleHeading":"Protocol","navigatorTitle":[{"kind":"identifier","text":"Auth0APIError"}],"symbolKind":"protocol","role":"symbol","title":"Auth0APIError","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Auth0APIError"}],"externalID":"s:5Auth00A8APIErrorP","modules":[{"name":"Auth0"}]},"references":{"doc://com.auth0.Auth0/s28CustomDebugStringConvertibleP":{"title":"Swift.CustomDebugStringConvertible","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s28CustomDebugStringConvertibleP"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError/info":{"kind":"symbol","title":"info","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"info"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/info","required":true,"abstract":[{"text":"Raw error values.","type":"text"}],"url":"\/documentation\/auth0\/auth0apierror\/info"},"doc://com.auth0.Auth0/s5ErrorP":{"title":"Swift.Error","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s5ErrorP"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError/statusCode":{"kind":"symbol","title":"statusCode","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"statusCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/statusCode","required":true,"abstract":[{"text":"HTTP status code of the response.","type":"text"}],"url":"\/documentation\/auth0\/auth0apierror\/statuscode"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError/init(info:statusCode:)":{"kind":"symbol","title":"init(info:statusCode:)","role":"symbol","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"info"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"statusCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"kind":"text","text":")"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/init(info:statusCode:)","required":true,"abstract":[{"text":"Creates an error from a JSON response.","type":"text"}],"url":"\/documentation\/auth0\/auth0apierror\/init(info:statuscode:)"},"doc://com.auth0.Auth0/s16SendableMetatypeP":{"title":"Swift.SendableMetatype","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccountError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 My Account API."}],"url":"\/documentation\/auth0\/myaccounterror","navigatorTitle":[{"kind":"identifier","text":"MyAccountError"}]},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError":{"url":"\/documentation\/auth0\/auth0apierror","abstract":[{"type":"text","text":"Generic representation of Auth0 API errors."}],"title":"Auth0APIError","navigatorTitle":[{"kind":"identifier","text":"Auth0APIError"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Auth0APIError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/10Foundation14LocalizedErrorP":{"title":"Foundation.LocalizedError","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/10Foundation14LocalizedErrorP"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError/code":{"kind":"symbol","title":"code","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"code"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/code","required":true,"abstract":[{"text":"Error code.","type":"text"}],"url":"\/documentation\/auth0\/auth0apierror\/code"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"title":"ManagementError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}]},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error":{"url":"\/documentation\/auth0\/auth0error","title":"Auth0Error","abstract":[{"type":"text","text":"Generic representation of Auth0 errors."}],"navigatorTitle":[{"kind":"identifier","text":"Auth0Error"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Auth0Error"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError/isNetworkError":{"kind":"symbol","title":"isNetworkError","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isNetworkError"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/isNetworkError","abstract":[{"text":"Whether the request failed due to network issues.","type":"text"}],"url":"\/documentation\/auth0\/auth0apierror\/isnetworkerror"},"doc://com.auth0.Auth0/s8SendableP":{"title":"Swift.Sendable","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s8SendableP"}}} \ 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 f264ed0b2..cda7a1332 100644 --- a/docs/data/documentation/auth0/auth0apierror/code.json +++ b/docs/data/documentation/auth0/auth0apierror/code.json @@ -1 +1 @@ -{"schemaVersion":{"minor":3,"major":0,"patch":0},"abstract":[{"text":"Error code.","type":"text"}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"code","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}]}],"kind":"declarations"}],"variants":[{"paths":["\/documentation\/auth0\/auth0apierror\/code"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError"]]},"sections":[],"metadata":{"title":"code","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"code","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"modules":[{"name":"Auth0"}],"role":"symbol","required":true,"externalID":"s:5Auth00A8APIErrorP4codeSSvp","symbolKind":"property","roleHeading":"Instance Property"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/code","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","type":"topic","url":"\/documentation\/auth0\/auth0apierror","title":"Auth0APIError","abstract":[{"type":"text","text":"Generic representation of Auth0 API errors."}],"role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Auth0APIError","kind":"identifier"}],"kind":"symbol","navigatorTitle":[{"text":"Auth0APIError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError/code":{"title":"code","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"code","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"required":true,"kind":"symbol","abstract":[{"text":"Error code.","type":"text"}],"type":"topic","role":"symbol","url":"\/documentation\/auth0\/auth0apierror\/code","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/code"}}} \ No newline at end of file +{"sections":[],"metadata":{"externalID":"s:5Auth00A8APIErrorP4codeSSvp","modules":[{"name":"Auth0"}],"title":"code","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"code"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"roleHeading":"Instance Property","role":"symbol","required":true,"symbolKind":"property"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/code","interfaceLanguage":"swift"},"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/auth0apierror\/code"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"code","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}]}],"kind":"declarations"}],"abstract":[{"type":"text","text":"Error code."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError":{"url":"\/documentation\/auth0\/auth0apierror","abstract":[{"type":"text","text":"Generic representation of Auth0 API errors."}],"title":"Auth0APIError","navigatorTitle":[{"kind":"identifier","text":"Auth0APIError"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Auth0APIError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError/code":{"kind":"symbol","title":"code","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"code"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/code","required":true,"abstract":[{"text":"Error code.","type":"text"}],"url":"\/documentation\/auth0\/auth0apierror\/code"}}} \ 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 208e12c30..71286e5c1 100644 --- a/docs/data/documentation/auth0/auth0apierror/info.json +++ b/docs/data/documentation/auth0/auth0apierror/info.json @@ -1 +1 @@ -{"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"info"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"] { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}]}],"kind":"declarations"}],"variants":[{"paths":["\/documentation\/auth0\/auth0apierror\/info"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","metadata":{"symbolKind":"property","roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"required":true,"title":"info","externalID":"s:5Auth00A8APIErrorP4infoSDySSypGvp","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"info","kind":"identifier"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"]","kind":"text"}],"role":"symbol"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/info","interfaceLanguage":"swift"},"sections":[],"abstract":[{"text":"Raw error values.","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","type":"topic","url":"\/documentation\/auth0\/auth0apierror","title":"Auth0APIError","abstract":[{"type":"text","text":"Generic representation of Auth0 API errors."}],"role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Auth0APIError","kind":"identifier"}],"kind":"symbol","navigatorTitle":[{"text":"Auth0APIError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError/info":{"required":true,"role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/info","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"info"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]"}],"kind":"symbol","abstract":[{"type":"text","text":"Raw error values."}],"title":"info","url":"\/documentation\/auth0\/auth0apierror\/info"}}} \ No newline at end of file +{"metadata":{"symbolKind":"property","title":"info","externalID":"s:5Auth00A8APIErrorP4infoSDySSypGvp","roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"info"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]"}],"role":"symbol","required":true},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/auth0apierror\/info"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/info","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"text":"Raw error values.","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"info"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"] { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError":{"url":"\/documentation\/auth0\/auth0apierror","abstract":[{"type":"text","text":"Generic representation of Auth0 API errors."}],"title":"Auth0APIError","navigatorTitle":[{"kind":"identifier","text":"Auth0APIError"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Auth0APIError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError/info":{"kind":"symbol","title":"info","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"info"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/info","required":true,"abstract":[{"text":"Raw error values.","type":"text"}],"url":"\/documentation\/auth0\/auth0apierror\/info"}}} \ 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 0af555667..362a32834 100644 --- a/docs/data/documentation/auth0/auth0apierror/init(info:statuscode:).json +++ b/docs/data/documentation/auth0/auth0apierror/init(info:statuscode:).json @@ -1 +1 @@ -{"sections":[],"metadata":{"modules":[{"name":"Auth0"}],"role":"symbol","symbolKind":"init","title":"init(info:statusCode:)","externalID":"s:5Auth00A8APIErrorP4info10statusCodexSDySSypG_Sitcfc","required":true,"fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"info"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"statusCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"},{"kind":"text","text":")"}],"roleHeading":"Initializer"},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"info"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"statusCode"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"},{"text":")","kind":"text"}]}]},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"JSON response from Auth0."}]}],"name":"info"},{"content":[{"inlineContent":[{"type":"text","text":"HTTP status code of the response."}],"type":"paragraph"}],"name":"statusCode"}]},{"kind":"content","content":[{"level":2,"type":"heading","text":"Return Value","anchor":"return-value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A new "},{"type":"codeVoice","code":"Auth0APIError"},{"type":"text","text":"."}]}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/init(info:statusCode:)"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/auth0apierror\/init(info:statuscode:)"]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"abstract":[{"type":"text","text":"Creates an error from a JSON response."}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError/init(info:statusCode:)":{"url":"\/documentation\/auth0\/auth0apierror\/init(info:statuscode:)","title":"init(info:statusCode:)","kind":"symbol","required":true,"type":"topic","abstract":[{"type":"text","text":"Creates an error from a JSON response."}],"role":"symbol","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"info"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"statusCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"},{"kind":"text","text":")"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/init(info:statusCode:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","type":"topic","url":"\/documentation\/auth0\/auth0apierror","title":"Auth0APIError","abstract":[{"type":"text","text":"Generic representation of Auth0 API errors."}],"role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Auth0APIError","kind":"identifier"}],"kind":"symbol","navigatorTitle":[{"text":"Auth0APIError","kind":"identifier"}]}}} \ No newline at end of file +{"metadata":{"symbolKind":"init","title":"init(info:statusCode:)","externalID":"s:5Auth00A8APIErrorP4info10statusCodexSDySSypG_Sitcfc","roleHeading":"Initializer","modules":[{"name":"Auth0"}],"fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"info"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"statusCode"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"},{"kind":"text","text":")"}],"role":"symbol","required":true},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/auth0apierror\/init(info:statuscode:)"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/init(info:statusCode:)","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"type":"text","text":"Creates an error from a JSON response."}],"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":"("},{"kind":"externalParam","text":"info"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"statusCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"},{"kind":"text","text":")"}],"platforms":["iOS"],"languages":["swift"]}]},{"parameters":[{"name":"info","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"JSON response from Auth0."}]}]},{"name":"statusCode","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"HTTP status code of the response."}]}]}],"kind":"parameters"},{"kind":"content","content":[{"type":"heading","level":2,"text":"Return Value","anchor":"return-value"},{"inlineContent":[{"type":"text","text":"A new "},{"type":"codeVoice","code":"Auth0APIError"},{"type":"text","text":"."}],"type":"paragraph"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError/init(info:statusCode:)":{"kind":"symbol","title":"init(info:statusCode:)","role":"symbol","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"info"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"statusCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"kind":"text","text":")"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/init(info:statusCode:)","required":true,"abstract":[{"text":"Creates an error from a JSON response.","type":"text"}],"url":"\/documentation\/auth0\/auth0apierror\/init(info:statuscode:)"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError":{"url":"\/documentation\/auth0\/auth0apierror","abstract":[{"type":"text","text":"Generic representation of Auth0 API errors."}],"title":"Auth0APIError","navigatorTitle":[{"kind":"identifier","text":"Auth0APIError"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Auth0APIError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","role":"symbol","kind":"symbol","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/auth0apierror/isnetworkerror.json b/docs/data/documentation/auth0/auth0apierror/isnetworkerror.json index 944ead93a..a9c34963b 100644 --- a/docs/data/documentation/auth0/auth0apierror/isnetworkerror.json +++ b/docs/data/documentation/auth0/auth0apierror/isnetworkerror.json @@ -1 +1 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/isNetworkError","interfaceLanguage":"swift"},"schemaVersion":{"major":0,"patch":0,"minor":3},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError"]]},"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/auth0apierror\/isnetworkerror"]}],"sections":[],"abstract":[{"type":"text","text":"Whether the request failed due to network issues."}],"metadata":{"roleHeading":"Instance Property","symbolKind":"property","externalID":"s:5Auth00A8APIErrorPAAE14isNetworkErrorSbvp","extendedModule":"Auth0","role":"symbol","title":"isNetworkError","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isNetworkError"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}]},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isNetworkError","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"},{"content":[{"type":"heading","level":2,"text":"Discussion","anchor":"discussion"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Returns "},{"type":"codeVoice","code":"true"},{"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":[{"isActive":true,"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/datanotallowed","type":"reference"}]}]},{"content":[{"type":"paragraph","inlineContent":[{"isActive":true,"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/notconnectedtointernet"}]}]},{"content":[{"inlineContent":[{"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/networkconnectionlost","isActive":true}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"isActive":true,"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/dnslookupfailed","type":"reference"}]}]},{"content":[{"type":"paragraph","inlineContent":[{"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/cannotfindhost","type":"reference","isActive":true}]}]},{"content":[{"inlineContent":[{"type":"reference","isActive":true,"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/cannotconnecttohost"}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/timedout","isActive":true,"type":"reference"}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/internationalroamingoff","isActive":true,"type":"reference"}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/callisactive","type":"reference","isActive":true}]}]}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"The underlying "},{"code":"URLError","type":"codeVoice"},{"type":"text","text":" is available in the "},{"code":"cause","type":"codeVoice"},{"type":"text","text":" property."}]}],"kind":"content"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","type":"topic","url":"\/documentation\/auth0\/auth0apierror","title":"Auth0APIError","abstract":[{"type":"text","text":"Generic representation of Auth0 API errors."}],"role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Auth0APIError","kind":"identifier"}],"kind":"symbol","navigatorTitle":[{"text":"Auth0APIError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError/isNetworkError":{"kind":"symbol","title":"isNetworkError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/isNetworkError","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isNetworkError","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"type":"topic","role":"symbol","abstract":[{"type":"text","text":"Whether the request failed due to network issues."}],"url":"\/documentation\/auth0\/auth0apierror\/isnetworkerror"},"https://developer.apple.com/documentation/foundation/urlerror/timedout":{"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/timedout","type":"link","url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/timedout","title":"timedOut","titleInlineContent":[{"text":"timedOut","type":"text"}]},"https://developer.apple.com/documentation/foundation/urlerror/internationalroamingoff":{"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/internationalroamingoff","type":"link","url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/internationalroamingoff","title":"internationalRoamingOff","titleInlineContent":[{"text":"internationalRoamingOff","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"https://developer.apple.com/documentation/foundation/urlerror/datanotallowed":{"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/datanotallowed","type":"link","url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/datanotallowed","title":"dataNotAllowed","titleInlineContent":[{"text":"dataNotAllowed","type":"text"}]},"https://developer.apple.com/documentation/foundation/urlerror/notconnectedtointernet":{"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/notconnectedtointernet","type":"link","url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/notconnectedtointernet","title":"notConnectedToInternet","titleInlineContent":[{"text":"notConnectedToInternet","type":"text"}]},"https://developer.apple.com/documentation/foundation/urlerror/cannotfindhost":{"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/cannotfindhost","type":"link","url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/cannotfindhost","title":"cannotFindHost","titleInlineContent":[{"text":"cannotFindHost","type":"text"}]},"https://developer.apple.com/documentation/foundation/urlerror/cannotconnecttohost":{"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/cannotconnecttohost","type":"link","url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/cannotconnecttohost","title":"cannotConnectToHost","titleInlineContent":[{"text":"cannotConnectToHost","type":"text"}]},"https://developer.apple.com/documentation/foundation/urlerror/networkconnectionlost":{"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/networkconnectionlost","type":"link","url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/networkconnectionlost","title":"networkConnectionLost","titleInlineContent":[{"text":"networkConnectionLost","type":"text"}]},"https://developer.apple.com/documentation/foundation/urlerror/callisactive":{"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/callisactive","type":"link","url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/callisactive","title":"callIsActive","titleInlineContent":[{"text":"callIsActive","type":"text"}]},"https://developer.apple.com/documentation/foundation/urlerror/dnslookupfailed":{"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/dnslookupfailed","type":"link","url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/dnslookupfailed","title":"dnsLookupFailed","titleInlineContent":[{"text":"dnsLookupFailed","type":"text"}]}}} \ No newline at end of file +{"metadata":{"symbolKind":"property","roleHeading":"Instance Property","title":"isNetworkError","externalID":"s:5Auth00A8APIErrorPAAE14isNetworkErrorSbvp","extendedModule":"Auth0","modules":[{"name":"Auth0"}],"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isNetworkError","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"role":"symbol"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/auth0apierror\/isnetworkerror"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/isNetworkError"},"kind":"symbol","abstract":[{"text":"Whether the request failed due to network issues.","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError"]]},"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isNetworkError"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"platforms":["iOS"]}],"kind":"declarations"},{"content":[{"level":2,"text":"Discussion","type":"heading","anchor":"discussion"},{"inlineContent":[{"type":"text","text":"Returns "},{"type":"codeVoice","code":"true"},{"type":"text","text":" when the "},{"type":"codeVoice","code":"URLError"},{"type":"text","text":" code is one of the following:"}],"type":"paragraph"},{"type":"unorderedList","items":[{"content":[{"type":"paragraph","inlineContent":[{"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/datanotallowed","isActive":true}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/notconnectedtointernet","isActive":true}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/networkconnectionlost","isActive":true}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/dnslookupfailed","isActive":true}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/cannotfindhost","isActive":true}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/cannotconnecttohost","isActive":true}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/timedout","isActive":true}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/internationalroamingoff","isActive":true}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/callisactive","isActive":true}]}]}]},{"inlineContent":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"URLError"},{"type":"text","text":" is available in the "},{"type":"codeVoice","code":"cause"},{"type":"text","text":" property."}],"type":"paragraph"}],"kind":"content"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"https://developer.apple.com/documentation/foundation/urlerror/networkconnectionlost":{"title":"networkConnectionLost","url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/networkconnectionlost","type":"link","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/networkconnectionlost","titleInlineContent":[{"text":"networkConnectionLost","type":"text"}]},"https://developer.apple.com/documentation/foundation/urlerror/cannotfindhost":{"title":"cannotFindHost","url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/cannotfindhost","type":"link","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/cannotfindhost","titleInlineContent":[{"text":"cannotFindHost","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"https://developer.apple.com/documentation/foundation/urlerror/dnslookupfailed":{"title":"dnsLookupFailed","url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/dnslookupfailed","type":"link","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/dnslookupfailed","titleInlineContent":[{"text":"dnsLookupFailed","type":"text"}]},"https://developer.apple.com/documentation/foundation/urlerror/datanotallowed":{"title":"dataNotAllowed","url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/datanotallowed","type":"link","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/datanotallowed","titleInlineContent":[{"text":"dataNotAllowed","type":"text"}]},"https://developer.apple.com/documentation/foundation/urlerror/cannotconnecttohost":{"title":"cannotConnectToHost","url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/cannotconnecttohost","type":"link","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/cannotconnecttohost","titleInlineContent":[{"text":"cannotConnectToHost","type":"text"}]},"https://developer.apple.com/documentation/foundation/urlerror/callisactive":{"title":"callIsActive","url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/callisactive","type":"link","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/callisactive","titleInlineContent":[{"text":"callIsActive","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError/isNetworkError":{"kind":"symbol","title":"isNetworkError","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isNetworkError"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/isNetworkError","abstract":[{"text":"Whether the request failed due to network issues.","type":"text"}],"url":"\/documentation\/auth0\/auth0apierror\/isnetworkerror"},"https://developer.apple.com/documentation/foundation/urlerror/timedout":{"title":"timedOut","url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/timedout","type":"link","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/timedout","titleInlineContent":[{"text":"timedOut","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError":{"url":"\/documentation\/auth0\/auth0apierror","abstract":[{"type":"text","text":"Generic representation of Auth0 API errors."}],"title":"Auth0APIError","navigatorTitle":[{"kind":"identifier","text":"Auth0APIError"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Auth0APIError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","role":"symbol","kind":"symbol","type":"topic"},"https://developer.apple.com/documentation/foundation/urlerror/notconnectedtointernet":{"title":"notConnectedToInternet","url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/notconnectedtointernet","type":"link","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/notconnectedtointernet","titleInlineContent":[{"text":"notConnectedToInternet","type":"text"}]},"https://developer.apple.com/documentation/foundation/urlerror/internationalroamingoff":{"title":"internationalRoamingOff","url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/internationalroamingoff","type":"link","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/internationalroamingoff","titleInlineContent":[{"text":"internationalRoamingOff","type":"text"}]}}} \ 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 2cad08886..eb07ec959 100644 --- a/docs/data/documentation/auth0/auth0apierror/statuscode.json +++ b/docs/data/documentation/auth0/auth0apierror/statuscode.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError"]]},"kind":"symbol","primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"statusCode"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"platforms":["iOS"]}],"kind":"declarations"}],"schemaVersion":{"minor":3,"major":0,"patch":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/statusCode","interfaceLanguage":"swift"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/auth0apierror\/statuscode"]}],"sections":[],"metadata":{"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"statusCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"}],"roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"externalID":"s:5Auth00A8APIErrorP10statusCodeSivp","title":"statusCode","role":"symbol","symbolKind":"property","required":true},"abstract":[{"type":"text","text":"HTTP status code of the response."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError/statusCode":{"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"statusCode","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Int","preciseIdentifier":"s:Si","kind":"typeIdentifier"}],"required":true,"type":"topic","abstract":[{"text":"HTTP status code of the response.","type":"text"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/statusCode","url":"\/documentation\/auth0\/auth0apierror\/statuscode","title":"statusCode","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","type":"topic","url":"\/documentation\/auth0\/auth0apierror","title":"Auth0APIError","abstract":[{"type":"text","text":"Generic representation of Auth0 API errors."}],"role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Auth0APIError","kind":"identifier"}],"kind":"symbol","navigatorTitle":[{"text":"Auth0APIError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"metadata":{"symbolKind":"property","title":"statusCode","externalID":"s:5Auth00A8APIErrorP10statusCodeSivp","roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"statusCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"}],"role":"symbol","required":true},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/auth0apierror\/statuscode"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/statusCode","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"type":"text","text":"HTTP status code of the response."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError"]]},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"statusCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}]}],"kind":"declarations"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError":{"url":"\/documentation\/auth0\/auth0apierror","abstract":[{"type":"text","text":"Generic representation of Auth0 API errors."}],"title":"Auth0APIError","navigatorTitle":[{"kind":"identifier","text":"Auth0APIError"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Auth0APIError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError/statusCode":{"kind":"symbol","title":"statusCode","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"statusCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError\/statusCode","required":true,"abstract":[{"text":"HTTP status code of the response.","type":"text"}],"url":"\/documentation\/auth0\/auth0apierror\/statuscode"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/auth0error.json b/docs/data/documentation/auth0/auth0error.json index dc24394b7..99b1a62ca 100644 --- a/docs/data/documentation/auth0/auth0error.json +++ b/docs/data/documentation/auth0/auth0error.json @@ -1 +1 @@ -{"sections":[],"kind":"symbol","abstract":[{"text":"Generic representation of Auth0 errors.","type":"text"}],"topicSections":[{"anchor":"Instance-Properties","generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/localizedDescription"],"title":"Instance Properties"}],"relationshipsSections":[{"title":"Inherits From","type":"inheritsFrom","identifiers":["doc:\/\/com.auth0.Auth0\/10Foundation14LocalizedErrorP","doc:\/\/com.auth0.Auth0\/s28CustomDebugStringConvertibleP","doc:\/\/com.auth0.Auth0\/s5ErrorP","doc:\/\/com.auth0.Auth0\/s8SendableP","doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP"],"kind":"relationships"},{"title":"Inherited By","type":"inheritedBy","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError"],"kind":"relationships"},{"title":"Conforming Types","type":"conformingTypes","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"],"kind":"relationships"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","interfaceLanguage":"swift"},"metadata":{"externalID":"s:5Auth00A5ErrorP","navigatorTitle":[{"text":"Auth0Error","kind":"identifier"}],"role":"symbol","symbolKind":"protocol","modules":[{"name":"Auth0"}],"title":"Auth0Error","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Auth0Error"}],"roleHeading":"Protocol"},"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Auth0Error","kind":"identifier"},{"text":" : ","kind":"text"},{"text":"LocalizedError","preciseIdentifier":"s:10Foundation14LocalizedErrorP","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"CustomDebugStringConvertible","preciseIdentifier":"s:s28CustomDebugStringConvertibleP","kind":"typeIdentifier"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/auth0error"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error":{"url":"\/documentation\/auth0\/auth0error","title":"Auth0Error","kind":"symbol","type":"topic","abstract":[{"type":"text","text":"Generic representation of Auth0 errors."}],"role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Auth0Error"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","navigatorTitle":[{"kind":"identifier","text":"Auth0Error"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"url":"\/documentation\/auth0\/credentialsmanagererror","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}],"title":"CredentialsManagerError","kind":"symbol","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/localizedDescription":{"type":"topic","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"localizedDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/localizedDescription","role":"symbol","url":"\/documentation\/auth0\/auth0error\/localizeddescription","title":"localizedDescription","abstract":[{"text":"Description of the error.","type":"text"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause":{"abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value, if any."}],"role":"symbol","url":"\/documentation\/auth0\/auth0error\/cause","required":true,"kind":"symbol","type":"topic","defaultImplementations":2,"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier","text":"Error"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause","title":"cause"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"type":"topic","url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","kind":"symbol","title":"ManagementError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}]},"doc://com.auth0.Auth0/10Foundation14LocalizedErrorP":{"identifier":"doc:\/\/com.auth0.Auth0\/10Foundation14LocalizedErrorP","type":"unresolvable","title":"Foundation.LocalizedError"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/s5ErrorP":{"identifier":"doc:\/\/com.auth0.Auth0\/s5ErrorP","type":"unresolvable","title":"Swift.Error"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError":{"kind":"symbol","abstract":[{"type":"text","text":"Represents an error during a DPoP operation."}],"navigatorTitle":[{"text":"DPoPError","kind":"identifier"}],"title":"DPoPError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"DPoPError","kind":"identifier"}],"url":"\/documentation\/auth0\/dpoperror","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","type":"topic","kind":"symbol","abstract":[{"text":"Represents an error during a request to the Auth0 My Account API.","type":"text"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountError","kind":"identifier"}],"navigatorTitle":[{"text":"MyAccountError","kind":"identifier"}],"url":"\/documentation\/auth0\/myaccounterror","role":"symbol"},"doc://com.auth0.Auth0/s16SendableMetatypeP":{"identifier":"doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP","type":"unresolvable","title":"Swift.SendableMetatype"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/s28CustomDebugStringConvertibleP":{"identifier":"doc:\/\/com.auth0.Auth0\/s28CustomDebugStringConvertibleP","type":"unresolvable","title":"Swift.CustomDebugStringConvertible"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"abstract":[{"text":"Represents an error during a Web Auth operation.","type":"text"}],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"type":"topic","role":"symbol","navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","title":"WebAuthError","url":"\/documentation\/auth0\/webautherror"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","type":"topic","url":"\/documentation\/auth0\/auth0apierror","title":"Auth0APIError","abstract":[{"type":"text","text":"Generic representation of Auth0 API errors."}],"role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Auth0APIError","kind":"identifier"}],"kind":"symbol","navigatorTitle":[{"text":"Auth0APIError","kind":"identifier"}]},"doc://com.auth0.Auth0/s8SendableP":{"identifier":"doc:\/\/com.auth0.Auth0\/s8SendableP","type":"unresolvable","title":"Swift.Sendable"}}} \ No newline at end of file +{"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/localizedDescription"],"title":"Instance Properties","generated":true,"anchor":"Instance-Properties"}],"schemaVersion":{"minor":3,"patch":0,"major":0},"relationshipsSections":[{"title":"Inherits From","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","doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP"]},{"type":"inheritedBy","kind":"relationships","title":"Inherited By","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError"]},{"kind":"relationships","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"],"type":"conformingTypes","title":"Conforming Types"}],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Auth0Error"},{"text":" : ","kind":"text"},{"preciseIdentifier":"s:10Foundation14LocalizedErrorP","kind":"typeIdentifier","text":"LocalizedError"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:s28CustomDebugStringConvertibleP","kind":"typeIdentifier","text":"CustomDebugStringConvertible"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"sections":[],"abstract":[{"text":"Generic representation of Auth0 errors.","type":"text"}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/auth0error"]}],"metadata":{"externalID":"s:5Auth00A5ErrorP","modules":[{"name":"Auth0"}],"title":"Auth0Error","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"Auth0Error","kind":"identifier"}],"roleHeading":"Protocol","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Auth0Error"}],"symbolKind":"protocol"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/DPoPError":{"role":"symbol","title":"DPoPError","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"DPoPError","kind":"identifier"}],"navigatorTitle":[{"text":"DPoPError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a DPoP operation."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError","url":"\/documentation\/auth0\/dpoperror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"title":"ManagementError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"url":"\/documentation\/auth0\/webautherror","abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"title":"WebAuthError","navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"role":"symbol","title":"CredentialsManagerError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerError"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}],"abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","url":"\/documentation\/auth0\/credentialsmanagererror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error":{"url":"\/documentation\/auth0\/auth0error","title":"Auth0Error","abstract":[{"type":"text","text":"Generic representation of Auth0 errors."}],"navigatorTitle":[{"kind":"identifier","text":"Auth0Error"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Auth0Error"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/s5ErrorP":{"title":"Swift.Error","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s5ErrorP"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError":{"url":"\/documentation\/auth0\/auth0apierror","abstract":[{"type":"text","text":"Generic representation of Auth0 API errors."}],"title":"Auth0APIError","navigatorTitle":[{"kind":"identifier","text":"Auth0APIError"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Auth0APIError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccountError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 My Account API."}],"url":"\/documentation\/auth0\/myaccounterror","navigatorTitle":[{"kind":"identifier","text":"MyAccountError"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/localizedDescription":{"kind":"symbol","title":"localizedDescription","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"localizedDescription"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/localizedDescription","abstract":[{"type":"text","text":"Description of the error."}],"url":"\/documentation\/auth0\/auth0error\/localizeddescription"},"doc://com.auth0.Auth0/s16SendableMetatypeP":{"title":"Swift.SendableMetatype","identifier":"doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP","type":"unresolvable"},"doc://com.auth0.Auth0/s8SendableP":{"title":"Swift.Sendable","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s8SendableP"},"doc://com.auth0.Auth0/10Foundation14LocalizedErrorP":{"title":"Foundation.LocalizedError","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/10Foundation14LocalizedErrorP"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause":{"kind":"symbol","title":"cause","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":"?"}],"type":"topic","defaultImplementations":2,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause","required":true,"abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any."}],"url":"\/documentation\/auth0\/auth0error\/cause"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"},"doc://com.auth0.Auth0/s28CustomDebugStringConvertibleP":{"title":"Swift.CustomDebugStringConvertible","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s28CustomDebugStringConvertibleP"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/auth0error/cause-97kwn.json b/docs/data/documentation/auth0/auth0error/cause-97kwn.json index a46e0fc2f..8356b8225 100644 --- a/docs/data/documentation/auth0/auth0error/cause-97kwn.json +++ b/docs/data/documentation/auth0/auth0error/cause-97kwn.json @@ -1 +1 @@ -{"schemaVersion":{"patch":0,"major":0,"minor":3},"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-97kwn","interfaceLanguage":"swift"},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Error","preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier"},{"text":"? { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}]}],"kind":"declarations"}],"metadata":{"symbolKind":"property","roleHeading":"Instance Property","title":"cause","externalID":"s:5Auth00A8APIErrorPAAE5causes5Error_pSgvp","extendedModule":"Auth0","modules":[{"name":"Auth0"}],"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier","text":"Error"},{"kind":"text","text":"?"}]},"kind":"symbol","sections":[],"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":"."}],"variants":[{"paths":["\/documentation\/auth0\/auth0error\/cause-97kwn"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-97kwn":{"title":"cause","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-97kwn","url":"\/documentation\/auth0\/auth0error\/cause-97kwn","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:s5ErrorP","text":"Error","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"kind":"symbol","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"}],"type":"topic","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error":{"url":"\/documentation\/auth0\/auth0error","title":"Auth0Error","kind":"symbol","type":"topic","abstract":[{"type":"text","text":"Generic representation of Auth0 errors."}],"role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Auth0Error"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","navigatorTitle":[{"kind":"identifier","text":"Auth0Error"}]}}} \ No newline at end of file +{"abstract":[{"text":"The underlying ","type":"text"},{"code":"Error","type":"codeVoice"},{"text":" value, if any. Defaults to ","type":"text"},{"code":"nil","type":"codeVoice"},{"text":".","type":"text"}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"text":"? { ","kind":"text"},{"kind":"keyword","text":"get"},{"text":" }","kind":"text"}],"platforms":["iOS"]}],"kind":"declarations"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/auth0error\/cause-97kwn"]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error"]]},"metadata":{"extendedModule":"Auth0","symbolKind":"property","modules":[{"name":"Auth0"}],"title":"cause","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"text":"Error","preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"externalID":"s:5Auth00A8APIErrorPAAE5causes5Error_pSgvp","role":"symbol","roleHeading":"Instance Property"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-97kwn"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-97kwn":{"url":"\/documentation\/auth0\/auth0error\/cause-97kwn","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":"?"}],"title":"cause","type":"topic","role":"symbol","abstract":[{"text":"The underlying ","type":"text"},{"code":"Error","type":"codeVoice"},{"text":" value, if any. Defaults to ","type":"text"},{"code":"nil","type":"codeVoice"},{"text":".","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-97kwn","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error":{"url":"\/documentation\/auth0\/auth0error","title":"Auth0Error","abstract":[{"type":"text","text":"Generic representation of Auth0 errors."}],"navigatorTitle":[{"kind":"identifier","text":"Auth0Error"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Auth0Error"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ 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 13ecf8c42..c2261f73f 100644 --- a/docs/data/documentation/auth0/auth0error/cause-9wuyi.json +++ b/docs/data/documentation/auth0/auth0error/cause-9wuyi.json @@ -1 +1 @@ -{"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-9wuyi","interfaceLanguage":"swift"},"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":"."}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/auth0error\/cause-9wuyi"]}],"sections":[],"metadata":{"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:s5ErrorP","text":"Error","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"role":"symbol","extendedModule":"Auth0","modules":[{"name":"Auth0"}],"externalID":"s:5Auth00A5ErrorPAAE5causes0B0_pSgvp","roleHeading":"Instance Property","title":"cause","symbolKind":"property"},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":"? { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}]}],"kind":"declarations"}],"schemaVersion":{"patch":0,"major":0,"minor":3},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error":{"url":"\/documentation\/auth0\/auth0error","title":"Auth0Error","kind":"symbol","type":"topic","abstract":[{"type":"text","text":"Generic representation of Auth0 errors."}],"role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Auth0Error"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","navigatorTitle":[{"kind":"identifier","text":"Auth0Error"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"title":"cause","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","kind":"symbol","abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":"?"}],"role":"symbol","type":"topic"}}} \ No newline at end of file +{"schemaVersion":{"patch":0,"minor":3,"major":0},"primaryContentSections":[{"declarations":[{"languages":["swift"],"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"}],"platforms":["iOS"]}],"kind":"declarations"}],"sections":[],"abstract":[{"text":"The underlying ","type":"text"},{"type":"codeVoice","code":"Error"},{"text":" value, if any. Defaults to ","type":"text"},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/auth0error\/cause-9wuyi"]}],"metadata":{"modules":[{"name":"Auth0"}],"title":"cause","roleHeading":"Instance Property","symbolKind":"property","role":"symbol","extendedModule":"Auth0","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s5ErrorP","text":"Error","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"externalID":"s:5Auth00A5ErrorPAAE5causes0B0_pSgvp"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error":{"url":"\/documentation\/auth0\/auth0error","title":"Auth0Error","abstract":[{"type":"text","text":"Generic representation of Auth0 errors."}],"navigatorTitle":[{"kind":"identifier","text":"Auth0Error"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Auth0Error"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"kind":"symbol","title":"cause","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier","text":"Error"},{"kind":"text","text":"?"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","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":"."}],"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/auth0error/cause.json b/docs/data/documentation/auth0/auth0error/cause.json index 512d3927f..36f1ba5b5 100644 --- a/docs/data/documentation/auth0/auth0error/cause.json +++ b/docs/data/documentation/auth0/auth0error/cause.json @@ -1 +1 @@ -{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/auth0error\/cause"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":"? { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}]}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause"},"metadata":{"externalID":"s:5Auth00A5ErrorP5causes0B0_pSgvp","role":"symbol","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier","text":"Error"},{"kind":"text","text":"?"}],"symbolKind":"property","roleHeading":"Instance Property","required":true,"title":"cause"},"defaultImplementationsSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-97kwn","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"],"title":"Auth0Error Implementations","anchor":"Auth0Error-Implementations"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error"]]},"abstract":[{"text":"The underlying ","type":"text"},{"code":"Error","type":"codeVoice"},{"text":" value, if any.","type":"text"}],"sections":[],"schemaVersion":{"patch":0,"major":0,"minor":3},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-97kwn":{"title":"cause","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-97kwn","url":"\/documentation\/auth0\/auth0error\/cause-97kwn","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:s5ErrorP","text":"Error","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"kind":"symbol","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"}],"type":"topic","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"title":"cause","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","kind":"symbol","abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":"?"}],"role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error":{"url":"\/documentation\/auth0\/auth0error","title":"Auth0Error","kind":"symbol","type":"topic","abstract":[{"type":"text","text":"Generic representation of Auth0 errors."}],"role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Auth0Error"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","navigatorTitle":[{"kind":"identifier","text":"Auth0Error"}]},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause":{"abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value, if any."}],"role":"symbol","url":"\/documentation\/auth0\/auth0error\/cause","required":true,"kind":"symbol","type":"topic","defaultImplementations":2,"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier","text":"Error"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause","title":"cause"}}} \ No newline at end of file +{"variants":[{"paths":["\/documentation\/auth0\/auth0error\/cause"],"traits":[{"interfaceLanguage":"swift"}]}],"defaultImplementationsSections":[{"title":"Auth0Error Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-97kwn"],"anchor":"Auth0Error-Implementations"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error"]]},"abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value, if any."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"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":"? { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","sections":[],"metadata":{"externalID":"s:5Auth00A5ErrorP5causes0B0_pSgvp","symbolKind":"property","title":"cause","roleHeading":"Instance Property","required":true,"role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:s5ErrorP","text":"Error","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"modules":[{"name":"Auth0"}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error":{"url":"\/documentation\/auth0\/auth0error","title":"Auth0Error","abstract":[{"type":"text","text":"Generic representation of Auth0 errors."}],"navigatorTitle":[{"kind":"identifier","text":"Auth0Error"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Auth0Error"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause":{"kind":"symbol","title":"cause","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":"?"}],"type":"topic","defaultImplementations":2,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause","required":true,"abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value, if any."}],"url":"\/documentation\/auth0\/auth0error\/cause"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"kind":"symbol","title":"cause","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier","text":"Error"},{"kind":"text","text":"?"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","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":"."}],"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-97kwn":{"url":"\/documentation\/auth0\/auth0error\/cause-97kwn","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":"?"}],"title":"cause","type":"topic","role":"symbol","abstract":[{"text":"The underlying ","type":"text"},{"code":"Error","type":"codeVoice"},{"text":" value, if any. Defaults to ","type":"text"},{"code":"nil","type":"codeVoice"},{"text":".","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-97kwn","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 754c25f8a..79b8ebdeb 100644 --- a/docs/data/documentation/auth0/auth0error/errordescription.json +++ b/docs/data/documentation/auth0/auth0error/errordescription.json @@ -1 +1 @@ -{"sections":[],"kind":"symbol","abstract":[{"text":"Description of the error.","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"errorDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"? { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}]}]},{"kind":"content","content":[{"type":"heading","anchor":"discussion","level":2,"text":"Discussion"},{"type":"aside","style":"important","name":"Important","content":[{"type":"paragraph","inlineContent":[{"text":"You should avoid displaying the error description to the user, it’s meant for ","type":"text"},{"type":"strong","inlineContent":[{"text":"debugging","type":"text"}]},{"text":" only.","type":"text"}]}]}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/errorDescription","interfaceLanguage":"swift"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/auth0error\/errordescription"]}],"metadata":{"roleHeading":"Instance Property","externalID":"s:5Auth00A5ErrorPAAE16errorDescriptionSSSgvp","symbolKind":"property","modules":[{"name":"Auth0"}],"extendedModule":"Auth0","role":"symbol","title":"errorDescription","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"errorDescription","kind":"identifier"},{"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\/Auth0Error"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/errorDescription":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/errorDescription","abstract":[{"text":"Description of the error.","type":"text"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/auth0error\/errordescription","title":"errorDescription","kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"errorDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}]},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error":{"url":"\/documentation\/auth0\/auth0error","title":"Auth0Error","kind":"symbol","type":"topic","abstract":[{"type":"text","text":"Generic representation of Auth0 errors."}],"role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Auth0Error"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","navigatorTitle":[{"kind":"identifier","text":"Auth0Error"}]}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/auth0error\/errordescription"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error"]]},"abstract":[{"type":"text","text":"Description of the error."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"errorDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"? { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]},{"kind":"content","content":[{"type":"heading","text":"Discussion","anchor":"discussion","level":2},{"type":"aside","name":"Important","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"},{"text":" only.","type":"text"}],"type":"paragraph"}]}]}],"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"metadata":{"externalID":"s:5Auth00A5ErrorPAAE16errorDescriptionSSSgvp","extendedModule":"Auth0","symbolKind":"property","title":"errorDescription","roleHeading":"Instance Property","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"errorDescription","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"modules":[{"name":"Auth0"}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/errorDescription"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/errorDescription":{"kind":"symbol","title":"errorDescription","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"errorDescription"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/errorDescription","abstract":[{"type":"text","text":"Description of the error."}],"url":"\/documentation\/auth0\/auth0error\/errordescription"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error":{"url":"\/documentation\/auth0\/auth0error","title":"Auth0Error","abstract":[{"type":"text","text":"Generic representation of Auth0 errors."}],"navigatorTitle":[{"kind":"identifier","text":"Auth0Error"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Auth0Error"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","role":"symbol","kind":"symbol","type":"topic"}}} \ 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 bd5c99300..95ef29106 100644 --- a/docs/data/documentation/auth0/auth0error/localizeddescription.json +++ b/docs/data/documentation/auth0/auth0error/localizeddescription.json @@ -1 +1 @@ -{"metadata":{"title":"localizedDescription","symbolKind":"property","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"localizedDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"role":"symbol","externalID":"s:5Auth00A5ErrorPAAE20localizedDescriptionSSvp","modules":[{"name":"Auth0"}],"extendedModule":"Auth0","roleHeading":"Instance Property"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error"]]},"abstract":[{"type":"text","text":"Description of the error."}],"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/auth0error\/localizeddescription"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/localizedDescription","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"localizedDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}]},{"kind":"content","content":[{"type":"heading","level":2,"text":"Discussion","anchor":"discussion"},{"style":"important","type":"aside","content":[{"type":"paragraph","inlineContent":[{"text":"You should avoid displaying the error description to the user, it’s meant for ","type":"text"},{"inlineContent":[{"text":"debugging","type":"text"}],"type":"strong"},{"text":" only.","type":"text"}]}],"name":"Important"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/localizedDescription":{"type":"topic","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"localizedDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/localizedDescription","role":"symbol","url":"\/documentation\/auth0\/auth0error\/localizeddescription","title":"localizedDescription","abstract":[{"text":"Description of the error.","type":"text"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error":{"url":"\/documentation\/auth0\/auth0error","title":"Auth0Error","kind":"symbol","type":"topic","abstract":[{"type":"text","text":"Generic representation of Auth0 errors."}],"role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Auth0Error"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","navigatorTitle":[{"kind":"identifier","text":"Auth0Error"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"abstract":[{"type":"text","text":"Description of the error."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"localizedDescription","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}]}]},{"kind":"content","content":[{"level":2,"anchor":"discussion","type":"heading","text":"Discussion"},{"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":[{"type":"text","text":"debugging"}]},{"type":"text","text":" only."}]}],"type":"aside","style":"important"}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/auth0error\/localizeddescription"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error"]]},"metadata":{"modules":[{"name":"Auth0"}],"title":"localizedDescription","roleHeading":"Instance Property","symbolKind":"property","role":"symbol","extendedModule":"Auth0","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"localizedDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"externalID":"s:5Auth00A5ErrorPAAE20localizedDescriptionSSvp"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/localizedDescription","interfaceLanguage":"swift"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error":{"url":"\/documentation\/auth0\/auth0error","title":"Auth0Error","abstract":[{"type":"text","text":"Generic representation of Auth0 errors."}],"navigatorTitle":[{"kind":"identifier","text":"Auth0Error"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Auth0Error"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/localizedDescription":{"kind":"symbol","title":"localizedDescription","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"localizedDescription"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/localizedDescription","abstract":[{"type":"text","text":"Description of the error."}],"url":"\/documentation\/auth0\/auth0error\/localizeddescription"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authentication(clientid:domain:session:).json b/docs/data/documentation/auth0/authentication(clientid:domain:session:).json index fc10cb08e..7e593d0cc 100644 --- a/docs/data/documentation/auth0/authentication(clientid:domain:session:).json +++ b/docs/data/documentation/auth0/authentication(clientid:domain:session:).json @@ -1 +1 @@ -{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/authentication(clientId:domain:session:)"},"variants":[{"paths":["\/documentation\/auth0\/authentication(clientid:domain:session:)"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"abstract":[{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","isActive":true},{"type":"text","text":" client to authenticate a user with Database, Social,"},{"type":"text","text":" "},{"type":"text","text":"Enterprise or Passwordless connections."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"metadata":{"modules":[{"name":"Auth0"}],"roleHeading":"Function","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authentication","kind":"identifier"},{"text":"(","kind":"text"},{"text":"clientId","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"domain","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"session","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:objc(cs)NSURLSession","text":"URLSession","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth014AuthenticationP","text":"Authentication","kind":"typeIdentifier"}],"title":"authentication(clientId:domain:session:)","externalID":"s:5Auth014authentication8clientId6domain7sessionAA14Authentication_pSS_SSSo12NSURLSessionCtF","role":"symbol","symbolKind":"func"},"sections":[],"kind":"symbol","primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"authentication"},{"kind":"text","text":"("},{"kind":"externalParam","text":"clientId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"domain"},{"kind":"text","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"},{"text":" = .shared) -> ","kind":"text"},{"text":"Authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","kind":"typeIdentifier","preciseIdentifier":"s:5Auth014AuthenticationP"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"},{"parameters":[{"content":[{"inlineContent":[{"text":"Client ID of your Auth0 application.","type":"text"}],"type":"paragraph"}],"name":"clientId"},{"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"},{"type":"text","text":" instance used for networking. Defaults to "},{"type":"codeVoice","code":"URLSession.shared"},{"type":"text","text":"."}]}],"name":"session"}],"kind":"parameters"},{"kind":"content","content":[{"type":"heading","anchor":"return-value","text":"Return Value","level":2},{"type":"paragraph","inlineContent":[{"text":"Authentication API client.","type":"text"}]}]},{"kind":"content","content":[{"type":"heading","text":"Usage","level":2,"anchor":"Usage"},{"type":"codeListing","syntax":"swift","code":["Auth0.authentication(clientId: \"client-id\", domain: \"samples.us.auth0.com\")"]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"type":"topic","role":"symbol","title":"Authentication","abstract":[{"text":"Client for the ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"text":".","type":"text"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"doc://com.auth0.Auth0/documentation/Auth0/authentication(clientId:domain:session:)":{"abstract":[{"type":"reference","isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"type":"text","text":" client to authenticate a user with Database, Social,"},{"type":"text","text":" "},{"type":"text","text":"Enterprise or Passwordless connections."}],"title":"authentication(clientId:domain:session:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authentication","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"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"session","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"URLSession","preciseIdentifier":"c:objc(cs)NSURLSession","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Authentication","preciseIdentifier":"s:5Auth014AuthenticationP","kind":"typeIdentifier"}],"url":"\/documentation\/auth0\/authentication(clientid:domain:session:)","type":"topic","kind":"symbol","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/authentication(clientId:domain:session:)"},"https://auth0.com/docs/api/authentication":{"title":"Auth0 Authentication API","type":"link","url":"https:\/\/auth0.com\/docs\/api\/authentication","titleInlineContent":[{"text":"Auth0 Authentication API","type":"text"}],"identifier":"https:\/\/auth0.com\/docs\/api\/authentication"}}} \ No newline at end of file +{"abstract":[{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"type":"text","text":" client to authenticate a user with Database, Social,"},{"type":"text","text":" "},{"type":"text","text":"Enterprise or Passwordless connections."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"authentication"},{"kind":"text","text":"("},{"kind":"externalParam","text":"clientId"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"domain"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"session"},{"kind":"text","text":": "},{"preciseIdentifier":"c:objc(cs)NSURLSession","kind":"typeIdentifier","text":"URLSession"},{"kind":"text","text":" = .shared) -> "},{"preciseIdentifier":"s:5Auth014AuthenticationP","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","kind":"typeIdentifier","text":"Authentication"}]}]},{"parameters":[{"name":"clientId","content":[{"inlineContent":[{"text":"Client ID of your Auth0 application.","type":"text"}],"type":"paragraph"}]},{"name":"domain","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":"session","content":[{"inlineContent":[{"text":"","type":"text"},{"code":"URLSession","type":"codeVoice"},{"text":" instance used for networking. Defaults to ","type":"text"},{"code":"URLSession.shared","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"}]}],"kind":"parameters"},{"kind":"content","content":[{"level":2,"anchor":"return-value","type":"heading","text":"Return Value"},{"inlineContent":[{"type":"text","text":"Authentication API client."}],"type":"paragraph"}]},{"kind":"content","content":[{"level":2,"anchor":"Usage","type":"heading","text":"Usage"},{"code":["Auth0.authentication(clientId: \"client-id\", domain: \"samples.us.auth0.com\")"],"type":"codeListing","syntax":"swift"}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication(clientid:domain:session:)"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"metadata":{"modules":[{"name":"Auth0"}],"title":"authentication(clientId:domain:session:)","symbolKind":"func","roleHeading":"Function","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"authentication"},{"kind":"text","text":"("},{"kind":"externalParam","text":"clientId"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"domain"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"session"},{"kind":"text","text":": "},{"preciseIdentifier":"c:objc(cs)NSURLSession","kind":"typeIdentifier","text":"URLSession"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth014AuthenticationP","kind":"typeIdentifier","text":"Authentication"}],"externalID":"s:5Auth014authentication8clientId6domain7sessionAA14Authentication_pSS_SSSo12NSURLSessionCtF"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/authentication(clientId:domain:session:)","interfaceLanguage":"swift"},"kind":"symbol","references":{"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","abstract":[{"type":"text","text":"Client for the "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","isActive":true},{"type":"text","text":"."}],"type":"topic","title":"Authentication","url":"\/documentation\/auth0\/authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"doc://com.auth0.Auth0/documentation/Auth0/authentication(clientId:domain:session:)":{"title":"authentication(clientId:domain:session:)","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/authentication(clientId:domain:session:)","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"authentication"},{"kind":"text","text":"("},{"kind":"externalParam","text":"clientId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"domain"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"session"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSURLSession","text":"URLSession"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth014AuthenticationP","text":"Authentication"}],"abstract":[{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","isActive":true,"type":"reference"},{"text":" client to authenticate a user with Database, Social,","type":"text"},{"text":" ","type":"text"},{"text":"Enterprise or Passwordless connections.","type":"text"}],"url":"\/documentation\/auth0\/authentication(clientid:domain:session:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ 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 533d215d1..8cf926453 100644 --- a/docs/data/documentation/auth0/authentication(session:bundle:).json +++ b/docs/data/documentation/auth0/authentication(session:bundle:).json @@ -1 +1 @@ -{"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/authentication(session:bundle:)"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"metadata":{"title":"authentication(session:bundle:)","externalID":"s:5Auth014authentication7session6bundleAA14Authentication_pSo12NSURLSessionC_So8NSBundleCtF","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"authentication"},{"kind":"text","text":"("},{"kind":"externalParam","text":"session"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"URLSession","preciseIdentifier":"c:objc(cs)NSURLSession"},{"kind":"text","text":", "},{"kind":"externalParam","text":"bundle"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bundle","preciseIdentifier":"c:objc(cs)NSBundle"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Authentication","preciseIdentifier":"s:5Auth014AuthenticationP"}],"roleHeading":"Function","modules":[{"name":"Auth0"}],"symbolKind":"func","role":"symbol"},"abstract":[{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","isActive":true},{"type":"text","text":" client to authenticate a user with Database, Social,"},{"type":"text","text":" "},{"type":"text","text":"Enterprise or Passwordless connections."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"authentication"},{"kind":"text","text":"("},{"kind":"externalParam","text":"session"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSURLSession","text":"URLSession"},{"kind":"text","text":" = .shared, "},{"kind":"externalParam","text":"bundle"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSBundle","text":"Bundle"},{"kind":"text","text":" = .main) -> "},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","preciseIdentifier":"s:5Auth014AuthenticationP","text":"Authentication"}]}]},{"parameters":[{"content":[{"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":"."}],"type":"paragraph"}],"name":"session"},{"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":[{"level":2,"text":"Return Value","type":"heading","anchor":"return-value"},{"inlineContent":[{"text":"Authentication API client.","type":"text"}],"type":"paragraph"}],"kind":"content"},{"content":[{"level":2,"anchor":"Usage","type":"heading","text":"Usage"},{"type":"codeListing","syntax":"swift","code":["Auth0.authentication()"]},{"type":"paragraph","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":"codeListing","syntax":"xml","code":["","","",""," ClientId<\/key>"," YOUR_AUTH0_CLIENT_ID<\/string>"," Domain<\/key>"," YOUR_AUTH0_DOMAIN<\/string>","<\/dict>","<\/plist>"]},{"type":"aside","name":"Warning","style":"warning","content":[{"type":"paragraph","inlineContent":[{"text":"Calling this method without a valid ","type":"text"},{"type":"codeVoice","code":"Auth0.plist"},{"text":" file will crash your application.","type":"text"}]}]}],"kind":"content"}],"schemaVersion":{"minor":3,"patch":0,"major":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication(session:bundle:)"]}],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/authentication(session:bundle:)":{"title":"authentication(session:bundle:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"authentication"},{"kind":"text","text":"("},{"kind":"externalParam","text":"session"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSURLSession","text":"URLSession"},{"kind":"text","text":", "},{"kind":"externalParam","text":"bundle"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSBundle","text":"Bundle"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth014AuthenticationP","text":"Authentication"}],"kind":"symbol","url":"\/documentation\/auth0\/authentication(session:bundle:)","type":"topic","abstract":[{"type":"reference","isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"type":"text","text":" client to authenticate a user with Database, Social,"},{"type":"text","text":" "},{"type":"text","text":"Enterprise or Passwordless connections."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/authentication(session:bundle:)","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"https://auth0.com/docs/api/authentication":{"url":"https:\/\/auth0.com\/docs\/api\/authentication","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"link","titleInlineContent":[{"text":"Auth0 Authentication API","type":"text"}],"title":"Auth0 Authentication API"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"type":"topic","role":"symbol","title":"Authentication","abstract":[{"text":"Client for the ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"text":".","type":"text"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]}}} \ No newline at end of file +{"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/authentication(session:bundle:)"},"kind":"symbol","metadata":{"externalID":"s:5Auth014authentication7session6bundleAA14Authentication_pSo12NSURLSessionC_So8NSBundleCtF","symbolKind":"func","title":"authentication(session:bundle:)","role":"symbol","roleHeading":"Function","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"authentication"},{"kind":"text","text":"("},{"kind":"externalParam","text":"session"},{"kind":"text","text":": "},{"text":"URLSession","preciseIdentifier":"c:objc(cs)NSURLSession","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"bundle","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Bundle","preciseIdentifier":"c:objc(cs)NSBundle","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth014AuthenticationP","text":"Authentication"}],"modules":[{"name":"Auth0"}]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication(session:bundle:)"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"authentication","kind":"identifier"},{"kind":"text","text":"("},{"text":"session","kind":"externalParam"},{"kind":"text","text":": "},{"text":"URLSession","preciseIdentifier":"c:objc(cs)NSURLSession","kind":"typeIdentifier"},{"text":" = .shared, ","kind":"text"},{"text":"bundle","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:objc(cs)NSBundle","text":"Bundle","kind":"typeIdentifier"},{"text":" = .main) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth014AuthenticationP","text":"Authentication","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"}],"platforms":["iOS"],"languages":["swift"]}]},{"parameters":[{"content":[{"inlineContent":[{"type":"text","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":"session"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Bundle used to locate the "},{"code":"Auth0.plist","type":"codeVoice"},{"type":"text","text":" file. Defaults to "},{"code":"Bundle.main","type":"codeVoice"},{"type":"text","text":"."}]}],"name":"bundle"}],"kind":"parameters"},{"kind":"content","content":[{"level":2,"anchor":"return-value","type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Authentication API client."}]}]},{"kind":"content","content":[{"level":2,"anchor":"Usage","text":"Usage","type":"heading"},{"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>"]},{"content":[{"inlineContent":[{"type":"text","text":"Calling this method without a valid "},{"type":"codeVoice","code":"Auth0.plist"},{"type":"text","text":" file will crash your application."}],"type":"paragraph"}],"style":"warning","name":"Warning","type":"aside"}]}],"abstract":[{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"type":"text","text":" client to authenticate a user with Database, Social,"},{"type":"text","text":" "},{"text":"Enterprise or Passwordless connections.","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/authentication(session:bundle:)":{"role":"symbol","title":"authentication(session:bundle:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authentication","kind":"identifier"},{"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"},{"preciseIdentifier":"c:objc(cs)NSBundle","text":"Bundle","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth014AuthenticationP","text":"Authentication","kind":"typeIdentifier"}],"abstract":[{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","isActive":true},{"type":"text","text":" client to authenticate a user with Database, Social,"},{"type":"text","text":" "},{"type":"text","text":"Enterprise or Passwordless connections."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/authentication(session:bundle:)","url":"\/documentation\/auth0\/authentication(session:bundle:)","type":"topic"},"https://auth0.com/docs/api/authentication":{"titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication","type":"link","title":"Auth0 Authentication API","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","abstract":[{"type":"text","text":"Client for the "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","isActive":true},{"type":"text","text":"."}],"type":"topic","title":"Authentication","url":"\/documentation\/auth0\/authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authentication.json b/docs/data/documentation/auth0/authentication.json index c846f78d8..96cb6e88b 100644 --- a/docs/data/documentation/auth0/authentication.json +++ b/docs/data/documentation/auth0/authentication.json @@ -1 +1 @@ -{"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Authentication","kind":"identifier"},{"text":" : ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","text":"Loggable","kind":"typeIdentifier","preciseIdentifier":"s:5Auth08LoggableP"},{"text":", ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SenderConstraining","text":"SenderConstraining","kind":"typeIdentifier","preciseIdentifier":"s:5Auth018SenderConstrainingP"},{"text":", ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable","text":"Trackable","kind":"typeIdentifier","preciseIdentifier":"s:5Auth09TrackableP"}]}]}],"abstract":[{"text":"Client for the ","type":"text"},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","isActive":true},{"text":".","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"relationshipsSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SenderConstraining","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable"],"type":"inheritsFrom","title":"Inherits From","kind":"relationships"}],"seeAlsoSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"],"anchor":"Related-Documentation","title":"Related Documentation"}],"schemaVersion":{"minor":3,"major":0,"patch":0},"metadata":{"fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Authentication","kind":"identifier"}],"title":"Authentication","role":"symbol","modules":[{"name":"Auth0"}],"symbolKind":"protocol","navigatorTitle":[{"text":"Authentication","kind":"identifier"}],"roleHeading":"Protocol","externalID":"s:5Auth014AuthenticationP"},"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/clientId","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/url"],"anchor":"Instance-Properties","title":"Instance Properties","generated":true},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/codeExchange(withCode:codeVerifier:redirectURI:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/customTokenExchange(subjectToken:subjectTokenType:audience:scope:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/jwks()","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(appleAuthorizationCode:fullName:profile:audience:scope:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(email:code:audience:scope:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(facebookSessionAccessToken:profile:audience:scope:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(passkey:challenge:connection:audience:scope:organization:)-1gm8k","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(passkey:challenge:connection:audience:scope:organization:)-340n2","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(phoneNumber:code:audience:scope:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(usernameOrEmail:password:realmOrConnection:audience:scope:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withOOBCode:mfaToken:bindingCode:)","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:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/multifactorChallenge(mfaToken:types:authenticatorId:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/passkeyLoginChallenge(connection:organization:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/passkeySignupChallenge(email:phoneNumber:username:name:connection:organization:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/renew(withRefreshToken:audience:scope:)","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:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/ssoExchange(withRefreshToken:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(email:type:connection:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(phoneNumber:type:connection:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/userInfo(withAccessToken:tokenType:)"],"anchor":"Instance-Methods","title":"Instance Methods","generated":true}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication"]}],"references":{"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","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/clientId":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/clientId","type":"topic","required":true,"kind":"symbol","abstract":[{"type":"text","text":"The Auth0 Client ID."}],"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"clientId","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"title":"clientId","role":"symbol","url":"\/documentation\/auth0\/authentication\/clientid"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(email:code:audience:scope:)":{"type":"topic","defaultImplementations":1,"role":"symbol","title":"login(email:code:audience:scope:)","abstract":[{"text":"Logs a user in 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"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"email","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"code","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"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"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"url":"\/documentation\/auth0\/authentication\/login(email:code:audience:scope:)","required":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(email:code:audience:scope:)","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/userInfo(withAccessToken:tokenType:)":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"userInfo","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withAccessToken","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"tokenType","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth08UserInfoV","text":"UserInfo","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"abstract":[{"type":"text","text":"Returns OIDC standard claims information by performing a request to the "},{"type":"codeVoice","code":"\/userinfo"},{"type":"text","text":" endpoint."}],"url":"\/documentation\/auth0\/authentication\/userinfo(withaccesstoken:tokentype:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/userInfo(withAccessToken:tokenType:)","title":"userInfo(withAccessToken:tokenType:)","role":"symbol","kind":"symbol","type":"topic","defaultImplementations":1,"required":true},"doc://com.auth0.Auth0/documentation/Auth0/Loggable":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","abstract":[{"type":"text","text":"A type that can log statements for debugging purposes."}],"fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Loggable","kind":"identifier"}],"kind":"symbol","title":"Loggable","type":"topic","role":"symbol","navigatorTitle":[{"text":"Loggable","kind":"identifier"}],"url":"\/documentation\/auth0\/loggable"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(withRecoveryCode:mfaToken:)":{"kind":"symbol","url":"\/documentation\/auth0\/authentication\/login(withrecoverycode:mfatoken:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withRecoveryCode:mfaToken:)","title":"login(withRecoveryCode:mfaToken:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withRecoveryCode","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"mfaToken","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"type":"topic","abstract":[{"text":"Verifies multi-factor authentication (MFA) using a recovery code.","type":"text"},{"text":" ","type":"text"},{"text":"Some multi-factor authentication (MFA) providers support using a recovery code to login. Use this method to","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"},{"text":" ","type":"text"},{"text":"it due to connectivity issues.","type":"text"}],"required":true,"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/jwks()":{"url":"\/documentation\/auth0\/authentication\/jwks()","required":true,"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"jwks","kind":"identifier"},{"text":"() -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth04JWKSV","text":"JWKS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"kind":"symbol","abstract":[{"text":"Returns JSON Web Key Set (JWKS) information from the ","type":"text"},{"type":"codeVoice","code":"\/.well-known\/jwks.json"},{"text":" endpoint.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/jwks()","type":"topic","title":"jwks()","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/startPasswordless(email:type:connection:)":{"required":true,"role":"symbol","url":"\/documentation\/auth0\/authentication\/startpasswordless(email:type:connection:)","title":"startPasswordless(email:type:connection:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(email:type:connection:)","defaultImplementations":1,"type":"topic","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"startPasswordless","kind":"identifier"},{"text":"(","kind":"text"},{"text":"email","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"type","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth016PasswordlessTypeO","text":"PasswordlessType","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"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"},{"type":"text","text":" "},{"type":"text","text":"passwordless login flow."}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(appleAuthorizationCode:fullName:profile:audience:scope:)":{"title":"login(appleAuthorizationCode:fullName:profile:audience:scope:)","abstract":[{"text":"Logs a user in with their Sign In with Apple authorization code.","type":"text"}],"required":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(appleAuthorizationCode:fullName:profile:audience:scope:)","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"kind":"externalParam","text":"appleAuthorizationCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"fullName"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"PersonNameComponents","preciseIdentifier":"s:10Foundation20PersonNameComponentsV"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"profile"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]?, "},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"type":"topic","defaultImplementations":1,"kind":"symbol","url":"\/documentation\/auth0\/authentication\/login(appleauthorizationcode:fullname:profile:audience:scope:)"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"type":"topic","role":"symbol","title":"Authentication","abstract":[{"text":"Client for the ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"text":".","type":"text"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/startPasswordless(phoneNumber:type:connection:)":{"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"},{"type":"text","text":" "},{"type":"text","text":"login flow."}],"required":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(phoneNumber:type:connection:)","url":"\/documentation\/auth0\/authentication\/startpasswordless(phonenumber:type:connection:)","role":"symbol","defaultImplementations":1,"kind":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"startPasswordless"},{"kind":"text","text":"("},{"kind":"externalParam","text":"phoneNumber"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"type"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth016PasswordlessTypeO","kind":"typeIdentifier","text":"PasswordlessType"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:s4Voida","kind":"typeIdentifier","text":"Void"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","text":"AuthenticationError"},{"kind":"text","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","url":"\/documentation\/auth0\/trackable","role":"symbol","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Trackable"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable","title":"Trackable","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Trackable"}]},"doc://com.auth0.Auth0/documentation/Auth0/SenderConstraining":{"navigatorTitle":[{"kind":"identifier","text":"SenderConstraining"}],"role":"symbol","kind":"symbol","abstract":[{"text":"A type that can use DPoP for securing requests.","type":"text"}],"url":"\/documentation\/auth0\/senderconstraining","type":"topic","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"SenderConstraining"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SenderConstraining","title":"SenderConstraining"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(passkey:challenge:connection:audience:scope:organization:)-340n2":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"passkey","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"SignupPasskey","preciseIdentifier":"s:5Auth013SignupPasskeyP","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"challenge","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"PasskeySignupChallenge","preciseIdentifier":"s:5Auth022PasskeySignupChallengeV","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"organization","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"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"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"kind":"symbol","role":"symbol","defaultImplementations":2,"url":"\/documentation\/auth0\/authentication\/login(passkey:challenge:connection:audience:scope:organization:)-340n2","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(passkey:challenge:connection:audience:scope:organization:)-340n2","abstract":[{"text":"Logs a new user in using a signup passkey credential and the signup challenge. This is the last part of the passkey signup flow.","type":"text"}],"required":true,"type":"topic","title":"login(passkey:challenge:connection:audience:scope:organization:)"},"https://developers.facebook.com/docs/facebook-login/access-tokens/session-info-access-token/":{"type":"link","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\/","identifier":"https:\/\/developers.facebook.com\/docs\/facebook-login\/access-tokens\/session-info-access-token\/"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/multifactorChallenge(mfaToken:types:authenticatorId:)":{"kind":"symbol","title":"multifactorChallenge(mfaToken:types:authenticatorId:)","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."}],"required":true,"type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"multifactorChallenge"},{"kind":"text","text":"("},{"kind":"externalParam","text":"mfaToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"types"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"]?, "},{"kind":"externalParam","text":"authenticatorId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?) -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Challenge","preciseIdentifier":"s:5Auth09ChallengeV"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"defaultImplementations":1,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/multifactorChallenge(mfaToken:types:authenticatorId:)","url":"\/documentation\/auth0\/authentication\/multifactorchallenge(mfatoken:types:authenticatorid:)"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/passkeyLoginChallenge(connection:organization:)":{"url":"\/documentation\/auth0\/authentication\/passkeyloginchallenge(connection:organization:)","abstract":[{"text":"Requests a challenge for logging a user in with an existing passkey. This is the first part of the passkey login flow.","type":"text"}],"title":"passkeyLoginChallenge(connection:organization:)","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"passkeyLoginChallenge","kind":"identifier"},{"text":"(","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"text":"organization","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?) -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"PasskeyLoginChallenge","kind":"typeIdentifier","preciseIdentifier":"s:5Auth021PasskeyLoginChallengeV"},{"text":", ","kind":"text"},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"defaultImplementations":1,"required":true,"role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/passkeyLoginChallenge(connection:organization:)"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/codeExchange(withCode:codeVerifier:redirectURI:)":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/codeExchange(withCode:codeVerifier:redirectURI:)","title":"codeExchange(withCode:codeVerifier:redirectURI:)","required":true,"kind":"symbol","abstract":[{"text":"Performs the last step of Proof Key for Code Exchange (PKCE).","type":"text"},{"text":" ","type":"text"},{"text":"This will request the user’s credentials using the code and its verifier after a request to ","type":"text"},{"code":"\/oauth\/authorize","type":"codeVoice"},{"text":".","type":"text"}],"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"codeExchange"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"codeVerifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"redirectURI"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"url":"\/documentation\/auth0\/authentication\/codeexchange(withcode:codeverifier:redirecturi:)"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(facebookSessionAccessToken:profile:audience:scope:)":{"kind":"symbol","role":"symbol","url":"\/documentation\/auth0\/authentication\/login(facebooksessionaccesstoken:profile:audience:scope:)","defaultImplementations":1,"required":true,"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"facebookSessionAccessToken","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"profile","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"], ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(facebookSessionAccessToken:profile:audience:scope:)","abstract":[{"type":"text","text":"Logs a user in with their Facebook "},{"type":"reference","isActive":true,"identifier":"https:\/\/developers.facebook.com\/docs\/facebook-login\/access-tokens\/session-info-access-token\/"},{"type":"text","text":" and profile data."}],"type":"topic","title":"login(facebookSessionAccessToken:profile:audience:scope:)"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/loginDefaultDirectory(withUsername:password:audience:scope:)":{"role":"symbol","required":true,"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"loginDefaultDirectory","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withUsername","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"password","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"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"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"defaultImplementations":1,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/loginDefaultDirectory(withUsername:password:audience:scope:)","url":"\/documentation\/auth0\/authentication\/logindefaultdirectory(withusername:password:audience:scope:)","title":"loginDefaultDirectory(withUsername:password:audience:scope:)","type":"topic","abstract":[{"type":"text","text":"Logs a user in using a username and password in the default directory."}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/renew(withRefreshToken:audience:scope:)":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/renew(withRefreshToken:audience:scope:)","role":"symbol","abstract":[{"type":"text","text":"Renews the user’s credentials using a refresh token."}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"renew","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withRefreshToken","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?) -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"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"}],"kind":"symbol","title":"renew(withRefreshToken:audience:scope:)","url":"\/documentation\/auth0\/authentication\/renew(withrefreshtoken:audience:scope:)","defaultImplementations":1,"required":true},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/revoke(refreshToken:)":{"url":"\/documentation\/auth0\/authentication\/revoke(refreshtoken:)","abstract":[{"text":"Revokes a user’s refresh token by performing a request to the ","type":"text"},{"type":"codeVoice","code":"\/oauth\/revoke"},{"text":" endpoint.","type":"text"}],"type":"topic","required":true,"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/revoke(refreshToken:)","title":"revoke(refreshToken:)","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"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"},{"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"},{"text":">","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(withOOBCode:mfaToken:bindingCode:)":{"url":"\/documentation\/auth0\/authentication\/login(withoobcode:mfatoken:bindingcode:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withOOBCode:mfaToken:bindingCode:)","type":"topic","required":true,"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withOOBCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"mfaToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"bindingCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","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":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"title":"login(withOOBCode:mfaToken:bindingCode:)","defaultImplementations":1,"abstract":[{"type":"text","text":"Verifies multi-factor authentication (MFA) using an out-of-band (OOB) challenge (either push notification, SMS"},{"type":"text","text":" "},{"type":"text","text":"or voice)."}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(passkey:challenge:connection:audience:scope:organization:)-1gm8k":{"role":"symbol","abstract":[{"type":"text","text":"Logs a user in using an existing passkey credential and the login challenge. This is the last part of the passkey login flow."}],"title":"login(passkey:challenge:connection:audience:scope:organization:)","defaultImplementations":2,"required":true,"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(passkey:challenge:connection:audience:scope:organization:)-1gm8k","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"passkey","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth012LoginPasskeyP","text":"LoginPasskey","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"challenge","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth021PasskeyLoginChallengeV","text":"PasskeyLoginChallenge","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"organization","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"url":"\/documentation\/auth0\/authentication\/login(passkey:challenge:connection:audience:scope:organization:)-1gm8k","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/url":{"required":true,"url":"\/documentation\/auth0\/authentication\/url","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"url"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV","text":"URL"}],"abstract":[{"text":"The Auth0 Domain URL.","type":"text"}],"role":"symbol","kind":"symbol","type":"topic","title":"url","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/url"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(withOTP:mfaToken:)":{"role":"symbol","abstract":[{"type":"text","text":"Verifies multi-factor authentication (MFA) using a one-time password (OTP)."}],"kind":"symbol","title":"login(withOTP:mfaToken:)","url":"\/documentation\/auth0\/authentication\/login(withotp:mfatoken:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withOTP:mfaToken:)","required":true,"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withOTP","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"mfaToken","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"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"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(usernameOrEmail:password:realmOrConnection:audience:scope:)":{"abstract":[{"type":"text","text":"Logs a user in using a username and password with a realm or connection."}],"kind":"symbol","required":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(usernameOrEmail:password:realmOrConnection:audience:scope:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"usernameOrEmail","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"password","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"realmOrConnection"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","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","kind":"typeIdentifier","text":"AuthenticationError"},{"kind":"text","text":">"}],"type":"topic","defaultImplementations":1,"title":"login(usernameOrEmail:password:realmOrConnection:audience:scope:)","url":"\/documentation\/auth0\/authentication\/login(usernameoremail:password:realmorconnection:audience:scope:)"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/ssoExchange(withRefreshToken:)":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ssoExchange","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withRefreshToken","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth014SSOCredentialsV","text":"SSOCredentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"abstract":[{"type":"text","text":"Exchanges a user’s refresh token for a session transfer token that can be used to perform web single sign-on"},{"type":"text","text":" "},{"type":"text","text":"(SSO)."}],"url":"\/documentation\/auth0\/authentication\/ssoexchange(withrefreshtoken:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/ssoExchange(withRefreshToken:)","title":"ssoExchange(withRefreshToken:)","role":"symbol","kind":"symbol","type":"topic","required":true},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/signup(email:username:password:connection:userMetadata:rootAttributes:)":{"role":"symbol","abstract":[{"type":"text","text":"Creates a user in a database connection."}],"title":"signup(email:username:password:connection:userMetadata:rootAttributes:)","defaultImplementations":1,"required":true,"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/signup(email:username:password:connection:userMetadata:rootAttributes:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"signup","kind":"identifier"},{"text":"(","kind":"text"},{"text":"email","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"username","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"password","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"userMetadata","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"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"},{"text":"Any","kind":"keyword"},{"text":"]?) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth012DatabaseUsera","text":"DatabaseUser","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"url":"\/documentation\/auth0\/authentication\/signup(email:username:password:connection:usermetadata:rootattributes:)","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/resetPassword(email:connection:)":{"abstract":[{"type":"text","text":"Resets the password of a database user."}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"resetPassword","kind":"identifier"},{"text":"(","kind":"text"},{"text":"email","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"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"},{"text":">","kind":"text"}],"url":"\/documentation\/auth0\/authentication\/resetpassword(email:connection:)","title":"resetPassword(email:connection:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/resetPassword(email:connection:)","type":"topic","required":true,"role":"symbol","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/customTokenExchange(subjectToken:subjectTokenType:audience:scope:)":{"type":"topic","defaultImplementations":1,"title":"customTokenExchange(subjectToken:subjectTokenType:audience:scope:)","role":"symbol","kind":"symbol","required":true,"url":"\/documentation\/auth0\/authentication\/customtokenexchange(subjecttoken:subjecttokentype:audience:scope:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"customTokenExchange"},{"kind":"text","text":"("},{"kind":"externalParam","text":"subjectToken"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"subjectTokenType"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"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"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"abstract":[{"type":"text","text":"Performs a custom token exchange to obtain Auth0 credentials using an existing identity provider token."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/customTokenExchange(subjectToken:subjectTokenType:audience:scope:)"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(phoneNumber:code:audience:scope:)":{"abstract":[{"text":"Logs a user in using a phone number and an OTP code received via SMS. This is the last part of the passwordless login flow.","type":"text"}],"url":"\/documentation\/auth0\/authentication\/login(phonenumber:code:audience:scope:)","required":true,"type":"topic","role":"symbol","kind":"symbol","defaultImplementations":1,"title":"login(phoneNumber:code:audience:scope:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"phoneNumber","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"code","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"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"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(phoneNumber:code:audience:scope:)"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/passkeySignupChallenge(email:phoneNumber:username:name:connection:organization:)":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"passkeySignupChallenge","kind":"identifier"},{"text":"(","kind":"text"},{"text":"email","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"phoneNumber","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"username","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"name","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"organization","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?) -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"PasskeySignupChallenge","preciseIdentifier":"s:5Auth022PasskeySignupChallengeV","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/authentication\/passkeysignupchallenge(email:phonenumber:username:name:connection:organization:)","defaultImplementations":1,"title":"passkeySignupChallenge(email:phoneNumber:username:name:connection:organization:)","type":"topic","abstract":[{"type":"text","text":"Requests a challenge for registering a new user with a passkey. This is the first part of the passkey signup flow."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/passkeySignupChallenge(email:phoneNumber:username:name:connection:organization:)","required":true,"role":"symbol"}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"abstract":[{"type":"text","text":"Client for the "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},{"type":"text","text":"."}],"topicSections":[{"title":"Instance Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/clientId","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/url"],"anchor":"Instance-Properties","generated":true},{"title":"Instance Methods","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/codeExchange(withCode:codeVerifier:redirectURI:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/customTokenExchange(subjectToken:subjectTokenType:audience:scope:organization:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/jwks()","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(appleAuthorizationCode:fullName:profile:audience:scope:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(email:code:audience:scope:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(facebookSessionAccessToken:profile:audience:scope:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(passkey:challenge:connection:audience:scope:organization:)-1gm8k","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(passkey:challenge:connection:audience:scope:organization:)-340n2","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(phoneNumber:code:audience:scope:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(usernameOrEmail:password:realmOrConnection:audience:scope:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withOOBCode:mfaToken:bindingCode:)","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:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/multifactorChallenge(mfaToken:types:authenticatorId:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/passkeyLoginChallenge(connection:organization:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/passkeySignupChallenge(email:phoneNumber:username:name:connection:organization:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/renew(withRefreshToken:audience:scope:)","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:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/ssoExchange(withRefreshToken:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(email:type:connection:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(phoneNumber:type:connection:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/userInfo(withAccessToken:tokenType:)"],"anchor":"Instance-Methods","generated":true}],"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","sections":[],"relationshipsSections":[{"type":"inheritsFrom","kind":"relationships","title":"Inherits From","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SenderConstraining","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable"]}],"seeAlsoSections":[{"anchor":"Related-Documentation","title":"Related Documentation","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Authentication"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","text":"Loggable","preciseIdentifier":"s:5Auth08LoggableP"},{"kind":"text","text":", "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SenderConstraining","text":"SenderConstraining","kind":"typeIdentifier","preciseIdentifier":"s:5Auth018SenderConstrainingP"},{"kind":"text","text":", "},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable","text":"Trackable","preciseIdentifier":"s:5Auth09TrackableP"}],"languages":["swift"],"platforms":["iOS"]}]}],"metadata":{"externalID":"s:5Auth014AuthenticationP","symbolKind":"protocol","title":"Authentication","role":"symbol","roleHeading":"Protocol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Authentication","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"Authentication"}],"modules":[{"name":"Auth0"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Authentication/passkeySignupChallenge(email:phoneNumber:username:name:connection:organization:)":{"kind":"symbol","title":"passkeySignupChallenge(email:phoneNumber:username:name:connection:organization:)","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"passkeySignupChallenge"},{"kind":"text","text":"("},{"kind":"externalParam","text":"email"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"phoneNumber"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"username"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"name"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"organization"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth022PasskeySignupChallengeV","text":"PasskeySignupChallenge"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"type":"topic","defaultImplementations":1,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/passkeySignupChallenge(email:phoneNumber:username:name:connection:organization:)","required":true,"abstract":[{"type":"text","text":"Requests a challenge for registering a new user with a passkey. This is the first part of the passkey signup flow."}],"url":"\/documentation\/auth0\/authentication\/passkeysignupchallenge(email:phonenumber:username:name:connection:organization:)"},"doc://com.auth0.Auth0/documentation/Auth0/SenderConstraining":{"kind":"symbol","abstract":[{"text":"A type that can use DPoP for securing requests.","type":"text"}],"type":"topic","title":"SenderConstraining","url":"\/documentation\/auth0\/senderconstraining","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"SenderConstraining"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SenderConstraining","navigatorTitle":[{"kind":"identifier","text":"SenderConstraining"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/multifactorChallenge(mfaToken:types:authenticatorId:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/multifactorChallenge(mfaToken:types:authenticatorId:)","kind":"symbol","title":"multifactorChallenge(mfaToken:types:authenticatorId:)","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"multifactorChallenge","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"mfaToken"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"types","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"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"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth09ChallengeV","text":"Challenge","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"defaultImplementations":1,"role":"symbol","required":true,"url":"\/documentation\/auth0\/authentication\/multifactorchallenge(mfatoken:types:authenticatorid:)","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."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(email:code:audience:scope:)":{"title":"login(email:code:audience:scope:)","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(email:code:audience:scope:)","role":"symbol","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"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":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"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":"<"},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"abstract":[{"type":"text","text":"Logs a user in 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"}],"defaultImplementations":1,"url":"\/documentation\/auth0\/authentication\/login(email:code:audience:scope:)","required":true},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(withOOBCode:mfaToken:bindingCode:)":{"defaultImplementations":1,"type":"topic","title":"login(withOOBCode:mfaToken:bindingCode:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withOOBCode:mfaToken:bindingCode:)","url":"\/documentation\/auth0\/authentication\/login(withoobcode:mfatoken:bindingcode:)","kind":"symbol","abstract":[{"type":"text","text":"Verifies multi-factor authentication (MFA) using an out-of-band (OOB) challenge (either push notification, SMS"},{"type":"text","text":" "},{"type":"text","text":"or voice)."}],"required":true,"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withOOBCode","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"mfaToken","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"bindingCode","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"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"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(withOTP:mfaToken:)":{"type":"topic","abstract":[{"type":"text","text":"Verifies multi-factor authentication (MFA) using a one-time password (OTP)."}],"title":"login(withOTP:mfaToken:)","url":"\/documentation\/auth0\/authentication\/login(withotp:mfatoken:)","kind":"symbol","required":true,"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withOTP"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"mfaToken"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","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","kind":"typeIdentifier","text":"AuthenticationError"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withOTP:mfaToken:)"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/signup(email:username:password:connection:userMetadata:rootAttributes:)":{"defaultImplementations":1,"type":"topic","title":"signup(email:username:password:connection:userMetadata:rootAttributes:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/signup(email:username:password:connection:userMetadata:rootAttributes:)","kind":"symbol","url":"\/documentation\/auth0\/authentication\/signup(email:username:password:connection:usermetadata:rootattributes:)","abstract":[{"type":"text","text":"Creates a user in a database connection."}],"required":true,"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"signup"},{"kind":"text","text":"("},{"kind":"externalParam","text":"email"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"username"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"password"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"userMetadata"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]?, "},{"kind":"externalParam","text":"rootAttributes"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]?) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012DatabaseUsera","text":"DatabaseUser"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/resetPassword(email:connection:)":{"kind":"symbol","title":"resetPassword(email:connection:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"resetPassword","kind":"identifier"},{"text":"(","kind":"text"},{"text":"email","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"Void","preciseIdentifier":"s:s4Voida","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/resetPassword(email:connection:)","required":true,"abstract":[{"type":"text","text":"Resets the password of a database user."}],"url":"\/documentation\/auth0\/authentication\/resetpassword(email:connection:)"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(passkey:challenge:connection:audience:scope:organization:)-1gm8k":{"defaultImplementations":2,"type":"topic","title":"login(passkey:challenge:connection:audience:scope:organization:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(passkey:challenge:connection:audience:scope:organization:)-1gm8k","kind":"symbol","abstract":[{"type":"text","text":"Logs a user in using an existing passkey credential and the login challenge. This is the last part of the passkey login flow."}],"url":"\/documentation\/auth0\/authentication\/login(passkey:challenge:connection:audience:scope:organization:)-1gm8k","required":true,"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"login"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"passkey"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012LoginPasskeyP","text":"LoginPasskey"},{"text":", ","kind":"text"},{"text":"challenge","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"PasskeyLoginChallenge","kind":"typeIdentifier","preciseIdentifier":"s:5Auth021PasskeyLoginChallengeV"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"organization"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?) -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"text":">","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(usernameOrEmail:password:realmOrConnection:audience:scope:)":{"defaultImplementations":1,"type":"topic","title":"login(usernameOrEmail:password:realmOrConnection:audience:scope:)","url":"\/documentation\/auth0\/authentication\/login(usernameoremail:password:realmorconnection:audience:scope:)","kind":"symbol","abstract":[{"text":"Logs a user in using a username and password with a realm or connection.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(usernameOrEmail:password:realmOrConnection:audience:scope:)","required":true,"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"usernameOrEmail","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"password","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"realmOrConnection","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}]},"https://auth0.com/docs/api/authentication":{"title":"Auth0 Authentication API","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/revoke(refreshToken:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/revoke(refreshToken:)","type":"topic","title":"revoke(refreshToken:)","role":"symbol","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"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"},{"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"},{"text":">","kind":"text"}],"abstract":[{"type":"text","text":"Revokes a user’s refresh token by performing a request to the "},{"type":"codeVoice","code":"\/oauth\/revoke"},{"type":"text","text":" endpoint."}],"url":"\/documentation\/auth0\/authentication\/revoke(refreshtoken:)","required":true},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/customTokenExchange(subjectToken:subjectTokenType:audience:scope:organization:)":{"kind":"symbol","title":"customTokenExchange(subjectToken:subjectTokenType:audience:scope:organization:)","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"customTokenExchange"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"subjectToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"subjectTokenType"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"organization"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"type":"topic","defaultImplementations":1,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/customTokenExchange(subjectToken:subjectTokenType:audience:scope:organization:)","required":true,"abstract":[{"type":"text","text":"Performs a custom token exchange to obtain Auth0 credentials using an existing identity provider token."}],"url":"\/documentation\/auth0\/authentication\/customtokenexchange(subjecttoken:subjecttokentype:audience:scope:organization:)"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/url":{"kind":"symbol","title":"url","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"url"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation3URLV","text":"URL","kind":"typeIdentifier"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/url","required":true,"abstract":[{"type":"text","text":"The Auth0 Domain URL."}],"url":"\/documentation\/auth0\/authentication\/url"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(phoneNumber:code:audience:scope:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(phoneNumber:code:audience:scope:)","type":"topic","title":"login(phoneNumber:code:audience:scope:)","role":"symbol","kind":"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"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"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","text":"Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"abstract":[{"type":"text","text":"Logs a user in using a phone number and an OTP code received via SMS. This is the last part of the passwordless login flow."}],"defaultImplementations":1,"url":"\/documentation\/auth0\/authentication\/login(phonenumber:code:audience:scope:)","required":true},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/ssoExchange(withRefreshToken:)":{"url":"\/documentation\/auth0\/authentication\/ssoexchange(withrefreshtoken:)","title":"ssoExchange(withRefreshToken:)","abstract":[{"type":"text","text":"Exchanges a user’s refresh token for a session transfer token that can be used to perform web single sign-on"},{"type":"text","text":" "},{"type":"text","text":"(SSO)."}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"ssoExchange"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withRefreshToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth014SSOCredentialsV","text":"SSOCredentials"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/ssoExchange(withRefreshToken:)","required":true,"kind":"symbol","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/passkeyLoginChallenge(connection:organization:)":{"defaultImplementations":1,"type":"topic","abstract":[{"type":"text","text":"Requests a challenge for logging a user in with an existing passkey. This is the first part of the passkey login flow."}],"title":"passkeyLoginChallenge(connection:organization:)","kind":"symbol","url":"\/documentation\/auth0\/authentication\/passkeyloginchallenge(connection:organization:)","required":true,"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"passkeyLoginChallenge","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"connection"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"organization"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"?) -> "},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:5Auth021PasskeyLoginChallengeV","text":"PasskeyLoginChallenge","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/passkeyLoginChallenge(connection:organization:)"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Trackable":{"title":"Trackable","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Trackable"}],"abstract":[{"text":"A type that can send the ","type":"text"},{"code":"Auth0-Client","type":"codeVoice"},{"text":" header on every request to Auth0.","type":"text"}],"url":"\/documentation\/auth0\/trackable","navigatorTitle":[{"kind":"identifier","text":"Trackable"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/renew(withRefreshToken:audience:scope:)":{"kind":"symbol","required":true,"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"renew"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withRefreshToken"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","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","kind":"typeIdentifier","text":"AuthenticationError"},{"kind":"text","text":">"}],"title":"renew(withRefreshToken:audience:scope:)","type":"topic","defaultImplementations":1,"role":"symbol","abstract":[{"text":"Renews the user’s credentials using a refresh token.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/renew(withRefreshToken:audience:scope:)","url":"\/documentation\/auth0\/authentication\/renew(withrefreshtoken:audience:scope:)"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/startPasswordless(phoneNumber:type:connection:)":{"defaultImplementations":1,"type":"topic","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."}],"kind":"symbol","url":"\/documentation\/auth0\/authentication\/startpasswordless(phonenumber:type:connection:)","title":"startPasswordless(phoneNumber:type:connection:)","required":true,"role":"symbol","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"},{"kind":"text","text":", "},{"kind":"externalParam","text":"type"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"PasswordlessType","preciseIdentifier":"s:5Auth016PasswordlessTypeO"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(phoneNumber:type:connection:)"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/loginDefaultDirectory(withUsername:password:audience:scope:)":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/loginDefaultDirectory(withUsername:password:audience:scope:)","title":"loginDefaultDirectory(withUsername:password:audience:scope:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"loginDefaultDirectory","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withUsername","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"password","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"audience"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"defaultImplementations":1,"role":"symbol","required":true,"url":"\/documentation\/auth0\/authentication\/logindefaultdirectory(withusername:password:audience:scope:)","abstract":[{"text":"Logs a user in using a username and password in the default directory.","type":"text"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/jwks()":{"kind":"symbol","title":"jwks()","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"jwks"},{"kind":"text","text":"() -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:5Auth04JWKSV","kind":"typeIdentifier","text":"JWKS"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","text":"AuthenticationError"},{"kind":"text","text":">"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/jwks()","required":true,"abstract":[{"type":"text","text":"Returns JSON Web Key Set (JWKS) information from the "},{"type":"codeVoice","code":"\/.well-known\/jwks.json"},{"type":"text","text":" endpoint."}],"url":"\/documentation\/auth0\/authentication\/jwks()"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/clientId":{"type":"topic","abstract":[{"type":"text","text":"The Auth0 Client ID."}],"title":"clientId","kind":"symbol","url":"\/documentation\/auth0\/authentication\/clientid","required":true,"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"clientId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/clientId"},"doc://com.auth0.Auth0/documentation/Auth0/Loggable":{"role":"symbol","title":"Loggable","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Loggable"}],"navigatorTitle":[{"text":"Loggable","kind":"identifier"}],"abstract":[{"text":"A type that can log statements for debugging purposes.","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/loggable","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(withRecoveryCode:mfaToken:)":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withRecoveryCode:mfaToken:)","title":"login(withRecoveryCode:mfaToken:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withRecoveryCode","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"mfaToken","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"role":"symbol","required":true,"url":"\/documentation\/auth0\/authentication\/login(withrecoverycode:mfatoken:)","abstract":[{"type":"text","text":"Verifies multi-factor authentication (MFA) using a recovery code."},{"type":"text","text":" "},{"type":"text","text":"Some multi-factor authentication (MFA) providers support using a recovery code to login. Use this method to"},{"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","text":" "},{"type":"text","text":"it due to connectivity issues."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(passkey:challenge:connection:audience:scope:organization:)-340n2":{"role":"symbol","title":"login(passkey:challenge:connection:audience:scope:organization:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"kind":"externalParam","text":"passkey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth013SignupPasskeyP","text":"SignupPasskey"},{"kind":"text","text":", "},{"kind":"externalParam","text":"challenge"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth022PasskeySignupChallengeV","text":"PasskeySignupChallenge"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"kind":"text","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":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"organization"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","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":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"abstract":[{"type":"text","text":"Logs a new user in using a signup passkey credential and the signup challenge. This is the last part of the passkey signup flow."}],"kind":"symbol","defaultImplementations":2,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(passkey:challenge:connection:audience:scope:organization:)-340n2","url":"\/documentation\/auth0\/authentication\/login(passkey:challenge:connection:audience:scope:organization:)-340n2","required":true,"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/userInfo(withAccessToken:tokenType:)":{"role":"symbol","title":"userInfo(withAccessToken:tokenType:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"userInfo"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withAccessToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"tokenType"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"UserInfo","preciseIdentifier":"s:5Auth08UserInfoV"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"abstract":[{"type":"text","text":"Returns OIDC standard claims information by performing a request to the "},{"type":"codeVoice","code":"\/userinfo"},{"type":"text","text":" endpoint."}],"kind":"symbol","defaultImplementations":1,"url":"\/documentation\/auth0\/authentication\/userinfo(withaccesstoken:tokentype:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/userInfo(withAccessToken:tokenType:)","required":true,"type":"topic"},"https://developers.facebook.com/docs/facebook-login/access-tokens/session-info-access-token/":{"title":"session info access token","identifier":"https:\/\/developers.facebook.com\/docs\/facebook-login\/access-tokens\/session-info-access-token\/","titleInlineContent":[{"type":"text","text":"session info access token"}],"type":"link","url":"https:\/\/developers.facebook.com\/docs\/facebook-login\/access-tokens\/session-info-access-token\/"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(appleAuthorizationCode:fullName:profile:audience:scope:)":{"defaultImplementations":1,"type":"topic","abstract":[{"type":"text","text":"Logs a user in with their Sign In with Apple authorization code."}],"title":"login(appleAuthorizationCode:fullName:profile:audience:scope:)","kind":"symbol","url":"\/documentation\/auth0\/authentication\/login(appleauthorizationcode:fullname:profile:audience:scope:)","required":true,"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"kind":"externalParam","text":"appleAuthorizationCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"fullName"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"PersonNameComponents","preciseIdentifier":"s:10Foundation20PersonNameComponentsV"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"profile"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]?, "},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(appleAuthorizationCode:fullName:profile:audience:scope:)"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","abstract":[{"type":"text","text":"Client for the "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","isActive":true},{"type":"text","text":"."}],"type":"topic","title":"Authentication","url":"\/documentation\/auth0\/authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/codeExchange(withCode:codeVerifier:redirectURI:)":{"type":"topic","abstract":[{"text":"Performs the last step of Proof Key for Code Exchange (PKCE).","type":"text"},{"text":" ","type":"text"},{"text":"This will request the user’s credentials using the code and its verifier after a request to ","type":"text"},{"code":"\/oauth\/authorize","type":"codeVoice"},{"text":".","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/authentication\/codeexchange(withcode:codeverifier:redirecturi:)","title":"codeExchange(withCode:codeVerifier:redirectURI:)","required":true,"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"codeExchange"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"codeVerifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"redirectURI"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","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":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/codeExchange(withCode:codeVerifier:redirectURI:)"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/startPasswordless(email:type:connection:)":{"defaultImplementations":1,"type":"topic","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"},{"text":"passwordless login flow.","type":"text"}],"kind":"symbol","title":"startPasswordless(email:type:connection:)","url":"\/documentation\/auth0\/authentication\/startpasswordless(email:type:connection:)","required":true,"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"startPasswordless"},{"kind":"text","text":"("},{"kind":"externalParam","text":"email"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"type"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth016PasswordlessTypeO","kind":"typeIdentifier","text":"PasswordlessType"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:s4Voida","kind":"typeIdentifier","text":"Void"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","text":"AuthenticationError"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(email:type:connection:)"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(facebookSessionAccessToken:profile:audience:scope:)":{"role":"symbol","title":"login(facebookSessionAccessToken:profile:audience:scope:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"kind":"externalParam","text":"facebookSessionAccessToken"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"profile"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","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","kind":"typeIdentifier","text":"AuthenticationError"},{"kind":"text","text":">"}],"abstract":[{"type":"text","text":"Logs a user in 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."}],"kind":"symbol","defaultImplementations":1,"url":"\/documentation\/auth0\/authentication\/login(facebooksessionaccesstoken:profile:audience:scope:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(facebookSessionAccessToken:profile:audience:scope:)","required":true,"type":"topic"}}} \ 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 a7c365450..1a3546805 100644 --- a/docs/data/documentation/auth0/authentication/clientid.json +++ b/docs/data/documentation/auth0/authentication/clientid.json @@ -1 +1 @@ -{"metadata":{"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"clientId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"roleHeading":"Instance Property","role":"symbol","symbolKind":"property","externalID":"s:5Auth014AuthenticationP8clientIdSSvp","modules":[{"name":"Auth0"}],"title":"clientId","required":true},"abstract":[{"type":"text","text":"The Auth0 Client ID."}],"variants":[{"paths":["\/documentation\/auth0\/authentication\/clientid"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/clientId"},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"clientId","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"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\/Authentication"]]},"sections":[],"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"type":"topic","role":"symbol","title":"Authentication","abstract":[{"text":"Client for the ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"text":".","type":"text"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/clientId":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/clientId","type":"topic","required":true,"kind":"symbol","abstract":[{"type":"text","text":"The Auth0 Client ID."}],"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"clientId","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"title":"clientId","role":"symbol","url":"\/documentation\/auth0\/authentication\/clientid"},"https://auth0.com/docs/api/authentication":{"type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication","title":"Auth0 Authentication API"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"sections":[],"metadata":{"symbolKind":"property","title":"clientId","roleHeading":"Instance Property","externalID":"s:5Auth014AuthenticationP8clientIdSSvp","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"clientId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"role":"symbol","required":true},"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/clientId","interfaceLanguage":"swift"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/clientid"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"clientId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"platforms":["iOS"],"languages":["swift"]}]}],"abstract":[{"type":"text","text":"The Auth0 Client ID."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Authentication/clientId":{"type":"topic","abstract":[{"type":"text","text":"The Auth0 Client ID."}],"title":"clientId","kind":"symbol","url":"\/documentation\/auth0\/authentication\/clientid","required":true,"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"clientId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/clientId"},"https://auth0.com/docs/api/authentication":{"type":"link","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication","title":"Auth0 Authentication API","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","abstract":[{"type":"text","text":"Client for the "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","isActive":true},{"type":"text","text":"."}],"type":"topic","title":"Authentication","url":"\/documentation\/auth0\/authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]}}} \ 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 1ee0f99d6..92f804c13 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","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"},{"text":"This will request the user’s credentials using the code and its verifier after a request to ","type":"text"},{"code":"\/oauth\/authorize","type":"codeVoice"},{"text":".","type":"text"}],"metadata":{"role":"symbol","symbolKind":"method","modules":[{"name":"Auth0"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"codeExchange","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withCode","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"codeVerifier","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"redirectURI","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"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"}],"required":true,"externalID":"s:5Auth014AuthenticationP12codeExchange8withCode0C8Verifier11redirectURIAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_S2StF","roleHeading":"Instance Method","title":"codeExchange(withCode:codeVerifier:redirectURI:)"},"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/api\/authentication\/authorization-code-flow-with-pkce\/get-token-pkce","https:\/\/tools.ietf.org\/html\/rfc7636"],"title":"Related Documentation","anchor":"Related-Documentation"}],"sections":[],"primaryContentSections":[{"declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"codeExchange","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withCode","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"code","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"codeVerifier","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"redirectURI","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier"},{"text":", ","kind":"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":[{"inlineContent":[{"type":"text","text":"Code returned after a request to "},{"code":"\/oauth\/authorize","type":"codeVoice"},{"type":"text","text":"."}],"type":"paragraph"}],"name":"code"},{"content":[{"type":"paragraph","inlineContent":[{"text":"Verifier used to generate the challenge sent in the request to ","type":"text"},{"code":"\/oauth\/authorize","type":"codeVoice"},{"text":".","type":"text"}]}],"name":"codeVerifier"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Redirect URI sent in the request to "},{"type":"codeVoice","code":"\/oauth\/authorize"},{"type":"text","text":"."}]}],"name":"redirectURI"}]},{"kind":"content","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":[{"text":"Usage","level":2,"anchor":"Usage","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)\")"," }"," }"]}]}],"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\/codeexchange(withcode:codeverifier:redirecturi:)"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"https://auth0.com/docs/api/authentication/authorization-code-flow-with-pkce/get-token-pkce":{"title":"Authentication API Endpoint","url":"https:\/\/auth0.com\/docs\/api\/authentication\/authorization-code-flow-with-pkce\/get-token-pkce","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/authorization-code-flow-with-pkce\/get-token-pkce"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/codeExchange(withCode:codeVerifier:redirectURI:)":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/codeExchange(withCode:codeVerifier:redirectURI:)","title":"codeExchange(withCode:codeVerifier:redirectURI:)","required":true,"kind":"symbol","abstract":[{"text":"Performs the last step of Proof Key for Code Exchange (PKCE).","type":"text"},{"text":" ","type":"text"},{"text":"This will request the user’s credentials using the code and its verifier after a request to ","type":"text"},{"code":"\/oauth\/authorize","type":"codeVoice"},{"text":".","type":"text"}],"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"codeExchange"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"codeVerifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"redirectURI"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"url":"\/documentation\/auth0\/authentication\/codeexchange(withcode:codeverifier:redirecturi:)"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/request","kind":"symbol","abstract":[{"type":"text","text":"Auth0 API request."}]},"https://auth0.com/docs/api/authentication":{"title":"Auth0 Authentication API","url":"https:\/\/auth0.com\/docs\/api\/authentication","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},"https://tools.ietf.org/html/rfc7636":{"title":"RFC 7636","url":"https:\/\/tools.ietf.org\/html\/rfc7636","titleInlineContent":[{"text":"RFC 7636","type":"text"}],"type":"link","identifier":"https:\/\/tools.ietf.org\/html\/rfc7636"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"type":"topic","role":"symbol","title":"Authentication","abstract":[{"text":"Client for the ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"text":".","type":"text"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"url":"\/documentation\/auth0\/credentials","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"role":"symbol","type":"topic","abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"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\/Authentication"]]},"metadata":{"modules":[{"name":"Auth0"}],"externalID":"s:5Auth014AuthenticationP12codeExchange8withCode0C8Verifier11redirectURIAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_S2StF","title":"codeExchange(withCode:codeVerifier:redirectURI:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"codeExchange"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"codeVerifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"redirectURI"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","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":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"roleHeading":"Instance Method","role":"symbol","required":true,"symbolKind":"method"},"sections":[],"abstract":[{"type":"text","text":"Performs the last step of Proof Key for Code Exchange (PKCE)."},{"type":"text","text":" "},{"type":"text","text":"This will request the user’s credentials using the code and its verifier after a request to "},{"type":"codeVoice","code":"\/oauth\/authorize"},{"type":"text","text":"."}],"variants":[{"paths":["\/documentation\/auth0\/authentication\/codeexchange(withcode:codeverifier:redirecturi:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/codeExchange(withCode:codeVerifier:redirectURI:)","interfaceLanguage":"swift"},"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication\/authorization-code-flow-with-pkce\/get-token-pkce","https:\/\/tools.ietf.org\/html\/rfc7636"],"anchor":"Related-Documentation"}],"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"codeExchange"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withCode"},{"kind":"text","text":" "},{"kind":"internalParam","text":"code"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"text":"codeVerifier","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"redirectURI"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","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"},{"kind":"text","text":", "},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}]},{"kind":"parameters","parameters":[{"name":"code","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Code returned after a request to "},{"type":"codeVoice","code":"\/oauth\/authorize"},{"type":"text","text":"."}]}]},{"name":"codeVerifier","content":[{"inlineContent":[{"text":"Verifier used to generate the challenge sent in the request to ","type":"text"},{"type":"codeVoice","code":"\/oauth\/authorize"},{"type":"text","text":"."}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"text":"Redirect URI sent in the request to ","type":"text"},{"code":"\/oauth\/authorize","type":"codeVoice"},{"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"}]},{"kind":"content","content":[{"type":"heading","level":2,"anchor":"Usage","text":"Usage"},{"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)\")"," }"," }"],"type":"codeListing"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Authentication/codeExchange(withCode:codeVerifier:redirectURI:)":{"type":"topic","abstract":[{"text":"Performs the last step of Proof Key for Code Exchange (PKCE).","type":"text"},{"text":" ","type":"text"},{"text":"This will request the user’s credentials using the code and its verifier after a request to ","type":"text"},{"code":"\/oauth\/authorize","type":"codeVoice"},{"text":".","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/authentication\/codeexchange(withcode:codeverifier:redirecturi:)","title":"codeExchange(withCode:codeVerifier:redirectURI:)","required":true,"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"codeExchange"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"codeVerifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"redirectURI"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","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":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/codeExchange(withCode:codeVerifier:redirectURI:)"},"https://auth0.com/docs/api/authentication":{"titleInlineContent":[{"text":"Auth0 Authentication API","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication","type":"link","title":"Auth0 Authentication API","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"title":"Request","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"abstract":[{"text":"Auth0 API request.","type":"text"}],"url":"\/documentation\/auth0\/request","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"Credentials","kind":"identifier"}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"https://tools.ietf.org/html/rfc7636":{"titleInlineContent":[{"text":"RFC 7636","type":"text"}],"url":"https:\/\/tools.ietf.org\/html\/rfc7636","type":"link","title":"RFC 7636","identifier":"https:\/\/tools.ietf.org\/html\/rfc7636"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","abstract":[{"type":"text","text":"Client for the "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","isActive":true},{"type":"text","text":"."}],"type":"topic","title":"Authentication","url":"\/documentation\/auth0\/authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"https://auth0.com/docs/api/authentication/authorization-code-flow-with-pkce/get-token-pkce":{"titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication\/authorization-code-flow-with-pkce\/get-token-pkce","type":"link","title":"Authentication API Endpoint","identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/authorization-code-flow-with-pkce\/get-token-pkce"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authentication/customtokenexchange(subjecttoken:subjecttokentype:audience:scope:)-10iff.json b/docs/data/documentation/auth0/authentication/customtokenexchange(subjecttoken:subjecttokentype:audience:scope:)-10iff.json deleted file mode 100644 index 6ff2328ae..000000000 --- a/docs/data/documentation/auth0/authentication/customtokenexchange(subjecttoken:subjecttokentype:audience:scope:)-10iff.json +++ /dev/null @@ -1 +0,0 @@ -{"sections":[],"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/api\/authentication\/token-exchange","https:\/\/auth0.com\/docs\/authenticate\/custom-token-exchange","https:\/\/tools.ietf.org\/html\/rfc8693"],"anchor":"Related-Documentation","title":"Related Documentation"}],"variants":[{"paths":["\/documentation\/auth0\/authentication\/customtokenexchange(subjecttoken:subjecttokentype:audience:scope:)-10iff"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"metadata":{"title":"customTokenExchange(subjectToken:subjectTokenType:audience:scope:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"customTokenExchange","kind":"identifier"},{"text":"(","kind":"text"},{"text":"subjectToken","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"subjectTokenType","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"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"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"modules":[{"name":"Auth0"}],"extendedModule":"Auth0","role":"symbol","externalID":"s:5Auth014AuthenticationPAAE19customTokenExchange07subjectD00fD4Type8audience5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_S2SSgSStF","roleHeading":"Instance Method","symbolKind":"method"},"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/customTokenExchange(subjectToken:subjectTokenType:audience:scope:)-10iff","interfaceLanguage":"swift"},"schemaVersion":{"major":0,"patch":0,"minor":3},"abstract":[{"type":"text","text":"Performs a custom token exchange to obtain Auth0 credentials using an existing identity provider token."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"customTokenExchange"},{"kind":"text","text":"("},{"kind":"externalParam","text":"subjectToken"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"subjectTokenType"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"? = nil, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" = defaultScope) -> ","kind":"text"},{"text":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"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":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"},{"kind":"text","text":">"}]}]},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The security token to be exchanged."}]}],"name":"subjectToken"},{"content":[{"inlineContent":[{"text":"URI that identifies the type of the subject token.","type":"text"}],"type":"paragraph"}],"name":"subjectTokenType"},{"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":"audience"},{"content":[{"inlineContent":[{"type":"text","text":"Space-separated list of requested scope values. Defaults to "},{"type":"codeVoice","code":"openid profile email"},{"type":"text","text":"."}],"type":"paragraph"}],"name":"scope"}]},{"kind":"content","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","content":[{"type":"heading","level":2,"text":"Availability","anchor":"Availability"},{"type":"paragraph","inlineContent":[{"text":"This feature is currently available in","type":"text"},{"text":" ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","isActive":true,"type":"reference"},{"text":".","type":"text"},{"text":" ","type":"text"},{"text":"Please reach out to ","type":"text"},{"identifier":"https:\/\/support.auth0.com\/","isActive":true,"type":"reference"},{"text":" to enable for your tenant.","type":"text"}]},{"type":"heading","level":2,"text":"Usage","anchor":"Usage"},{"type":"codeListing","syntax":"swift","code":["Auth0"," .authentication()"," .customTokenExchange(subjectToken: \"existing-token\","," subjectTokenType: \"urn:ietf:params:oauth:token-type:jwt\","," audience: \"https:\/\/example.com\/api\","," scope: \"openid profile email\")"," .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 include additional parameters:","type":"text"}]},{"type":"codeListing","syntax":"swift","code":["Auth0"," .authentication()"," .customTokenExchange(subjectToken: \"existing-token\","," subjectTokenType: \"urn:ietf:params:oauth:token-type:jwt\","," audience: \"https:\/\/example.com\/api\","," scope: \"openid profile email\","," additionalParameters: [\"custom_claim\": \"value\"])"," .start { print($0) }"]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Authentication/customTokenExchange(subjectToken:subjectTokenType:audience:scope:)-10iff":{"type":"topic","title":"customTokenExchange(subjectToken:subjectTokenType:audience:scope:)","role":"symbol","kind":"symbol","url":"\/documentation\/auth0\/authentication\/customtokenexchange(subjecttoken:subjecttokentype:audience:scope:)-10iff","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"customTokenExchange"},{"kind":"text","text":"("},{"kind":"externalParam","text":"subjectToken"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"subjectTokenType"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"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"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"abstract":[{"type":"text","text":"Performs a custom token exchange to obtain Auth0 credentials using an existing identity provider token."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/customTokenExchange(subjectToken:subjectTokenType:audience:scope:)-10iff"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"url":"\/documentation\/auth0\/credentials","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"role":"symbol","type":"topic","abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}]},"https://support.auth0.com/":{"identifier":"https:\/\/support.auth0.com\/","titleInlineContent":[{"text":"Auth0 support","type":"text"}],"url":"https:\/\/support.auth0.com\/","title":"Auth0 support","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"type":"topic","role":"symbol","title":"Authentication","abstract":[{"text":"Client for the ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"text":".","type":"text"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/request","kind":"symbol","abstract":[{"type":"text","text":"Auth0 API request."}]},"https://auth0.com/docs/authenticate/custom-token-exchange":{"titleInlineContent":[{"type":"text","text":"Custom Token Exchange Documentation"}],"type":"link","identifier":"https:\/\/auth0.com\/docs\/authenticate\/custom-token-exchange","url":"https:\/\/auth0.com\/docs\/authenticate\/custom-token-exchange","title":"Custom Token Exchange Documentation"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"https://tools.ietf.org/html/rfc8693":{"identifier":"https:\/\/tools.ietf.org\/html\/rfc8693","titleInlineContent":[{"text":"RFC 8693: OAuth 2.0 Token Exchange","type":"text"}],"url":"https:\/\/tools.ietf.org\/html\/rfc8693","title":"RFC 8693: OAuth 2.0 Token Exchange","type":"link"},"https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access":{"titleInlineContent":[{"type":"text","text":"Early Access"}],"type":"link","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","url":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","title":"Early Access"},"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"},"https://auth0.com/docs/api/authentication/token-exchange":{"titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/token-exchange","url":"https:\/\/auth0.com\/docs\/api\/authentication\/token-exchange","title":"Authentication API Endpoint"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authentication/customtokenexchange(subjecttoken:subjecttokentype:audience:scope:).json b/docs/data/documentation/auth0/authentication/customtokenexchange(subjecttoken:subjecttokentype:audience:scope:).json deleted file mode 100644 index 31affd054..000000000 --- a/docs/data/documentation/auth0/authentication/customtokenexchange(subjecttoken:subjecttokentype:audience:scope:).json +++ /dev/null @@ -1 +0,0 @@ -{"defaultImplementationsSections":[{"title":"Authentication Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/customTokenExchange(subjectToken:subjectTokenType:audience:scope:)-10iff"],"anchor":"Authentication-Implementations"}],"kind":"symbol","metadata":{"symbolKind":"method","role":"symbol","roleHeading":"Instance Method","required":true,"modules":[{"name":"Auth0"}],"title":"customTokenExchange(subjectToken:subjectTokenType:audience:scope:)","externalID":"s:5Auth014AuthenticationP19customTokenExchange07subjectD00fD4Type8audience5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_S2SSgSStF","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"customTokenExchange","kind":"identifier"},{"text":"(","kind":"text"},{"text":"subjectToken","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"subjectTokenType","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}]},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication\/token-exchange","https:\/\/auth0.com\/docs\/authenticate\/custom-token-exchange","https:\/\/tools.ietf.org\/html\/rfc8693"],"anchor":"Related-Documentation"}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"customTokenExchange"},{"kind":"text","text":"("},{"kind":"externalParam","text":"subjectToken"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"subjectTokenType"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"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"},{"text":"Credentials","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"text":", ","kind":"text"},{"text":"AuthenticationError","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"platforms":["iOS"]}],"kind":"declarations"},{"parameters":[{"name":"subjectToken","content":[{"type":"paragraph","inlineContent":[{"text":"The security token to be exchanged.","type":"text"}]}]},{"name":"subjectTokenType","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"URI that identifies the type of the subject token."}]}]},{"name":"audience","content":[{"inlineContent":[{"text":"API Identifier that your application is requesting access to. Defaults to ","type":"text"},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}],"type":"paragraph"}]},{"name":"scope","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Space-separated list of requested scope values. Defaults to "},{"code":"openid profile email","type":"codeVoice"},{"type":"text","text":"."}]}]}],"kind":"parameters"},{"content":[{"type":"heading","level":2,"anchor":"return-value","text":"Return Value"},{"inlineContent":[{"text":"A request that will yield Auth0 user’s credentials.","type":"text"}],"type":"paragraph"}],"kind":"content"},{"content":[{"level":2,"text":"Availability","anchor":"Availability","type":"heading"},{"inlineContent":[{"type":"text","text":"This feature is currently available in"},{"type":"text","text":" "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","isActive":true},{"type":"text","text":"."},{"type":"text","text":" "},{"type":"text","text":"Please reach out to "},{"type":"reference","identifier":"https:\/\/support.auth0.com\/","isActive":true},{"type":"text","text":" to enable for your tenant."}],"type":"paragraph"},{"level":2,"text":"Usage","anchor":"Usage","type":"heading"},{"syntax":"swift","code":["Auth0"," .authentication()"," .customTokenExchange(subjectToken: \"existing-token\","," subjectTokenType: \"urn:ietf:params:oauth:token-type:jwt\","," audience: \"https:\/\/example.com\/api\","," scope: \"openid profile email\")"," .start { result in"," switch result {"," case .success(let credentials):"," print(\"Obtained credentials: \\(credentials)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"],"type":"codeListing"},{"inlineContent":[{"text":"You can also include additional parameters:","type":"text"}],"type":"paragraph"},{"syntax":"swift","code":["Auth0"," .authentication()"," .customTokenExchange(subjectToken: \"existing-token\","," subjectTokenType: \"urn:ietf:params:oauth:token-type:jwt\","," audience: \"https:\/\/example.com\/api\","," scope: \"openid profile email\","," additionalParameters: [\"custom_claim\": \"value\"])"," .start { print($0) }"],"type":"codeListing"}],"kind":"content"}],"variants":[{"paths":["\/documentation\/auth0\/authentication\/customtokenexchange(subjecttoken:subjecttokentype:audience:scope:)"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"abstract":[{"type":"text","text":"Performs a custom token exchange to obtain Auth0 credentials using an existing identity provider token."}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/customTokenExchange(subjectToken:subjectTokenType:audience:scope:)","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Authentication/customTokenExchange(subjectToken:subjectTokenType:audience:scope:)":{"type":"topic","defaultImplementations":1,"title":"customTokenExchange(subjectToken:subjectTokenType:audience:scope:)","role":"symbol","kind":"symbol","required":true,"url":"\/documentation\/auth0\/authentication\/customtokenexchange(subjecttoken:subjecttokentype:audience:scope:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"customTokenExchange"},{"kind":"text","text":"("},{"kind":"externalParam","text":"subjectToken"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"subjectTokenType"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"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"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"abstract":[{"type":"text","text":"Performs a custom token exchange to obtain Auth0 credentials using an existing identity provider token."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/customTokenExchange(subjectToken:subjectTokenType:audience:scope:)"},"https://auth0.com/docs/authenticate/custom-token-exchange":{"type":"link","identifier":"https:\/\/auth0.com\/docs\/authenticate\/custom-token-exchange","title":"Custom Token Exchange Documentation","url":"https:\/\/auth0.com\/docs\/authenticate\/custom-token-exchange","titleInlineContent":[{"type":"text","text":"Custom Token Exchange Documentation"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/customTokenExchange(subjectToken:subjectTokenType:audience:scope:)-10iff":{"type":"topic","title":"customTokenExchange(subjectToken:subjectTokenType:audience:scope:)","role":"symbol","kind":"symbol","url":"\/documentation\/auth0\/authentication\/customtokenexchange(subjecttoken:subjecttokentype:audience:scope:)-10iff","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"customTokenExchange"},{"kind":"text","text":"("},{"kind":"externalParam","text":"subjectToken"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"subjectTokenType"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"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"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"abstract":[{"type":"text","text":"Performs a custom token exchange to obtain Auth0 credentials using an existing identity provider token."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/customTokenExchange(subjectToken:subjectTokenType:audience:scope:)-10iff"},"https://support.auth0.com/":{"type":"link","identifier":"https:\/\/support.auth0.com\/","title":"Auth0 support","url":"https:\/\/support.auth0.com\/","titleInlineContent":[{"type":"text","text":"Auth0 support"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"type":"topic","role":"symbol","title":"Authentication","abstract":[{"text":"Client for the ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"text":".","type":"text"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/request","kind":"symbol","abstract":[{"type":"text","text":"Auth0 API request."}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"url":"\/documentation\/auth0\/credentials","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"role":"symbol","type":"topic","abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}]},"https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access":{"url":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","type":"link","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","titleInlineContent":[{"type":"text","text":"Early Access"}],"title":"Early Access"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"https://auth0.com/docs/api/authentication/token-exchange":{"type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/token-exchange","title":"Authentication API Endpoint","url":"https:\/\/auth0.com\/docs\/api\/authentication\/token-exchange","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}]},"https://tools.ietf.org/html/rfc8693":{"url":"https:\/\/tools.ietf.org\/html\/rfc8693","type":"link","identifier":"https:\/\/tools.ietf.org\/html\/rfc8693","titleInlineContent":[{"type":"text","text":"RFC 8693: OAuth 2.0 Token Exchange"}],"title":"RFC 8693: OAuth 2.0 Token Exchange"},"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"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authentication/customtokenexchange(subjecttoken:subjecttokentype:audience:scope:organization:)-5dzwp.json b/docs/data/documentation/auth0/authentication/customtokenexchange(subjecttoken:subjecttokentype:audience:scope:organization:)-5dzwp.json new file mode 100644 index 000000000..cc88c5a95 --- /dev/null +++ b/docs/data/documentation/auth0/authentication/customtokenexchange(subjecttoken:subjecttokentype:audience:scope:organization:)-5dzwp.json @@ -0,0 +1 @@ +{"metadata":{"symbolKind":"method","roleHeading":"Instance Method","title":"customTokenExchange(subjectToken:subjectTokenType:audience:scope:organization:)","externalID":"s:5Auth014AuthenticationPAAE19customTokenExchange07subjectD00fD4Type8audience5scope12organizationAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_S2SSgSSAQtF","extendedModule":"Auth0","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"customTokenExchange"},{"kind":"text","text":"("},{"kind":"externalParam","text":"subjectToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"subjectTokenType"},{"kind":"text","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":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"organization"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","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":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"role":"symbol"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/customtokenexchange(subjecttoken:subjecttokentype:audience:scope:organization:)-5dzwp"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/customTokenExchange(subjectToken:subjectTokenType:audience:scope:organization:)-5dzwp","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"type":"text","text":"Performs a custom token exchange to obtain Auth0 credentials using an existing identity provider token."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"seeAlsoSections":[{"anchor":"Related-Documentation","title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication\/token-exchange","https:\/\/auth0.com\/docs\/authenticate\/custom-token-exchange","https:\/\/tools.ietf.org\/html\/rfc8693"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"customTokenExchange","kind":"identifier"},{"text":"(","kind":"text"},{"text":"subjectToken","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"subjectTokenType","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"? = nil, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" = defaultScope, ","kind":"text"},{"text":"organization","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"? = nil) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"},{"text":">","kind":"text"}]}]},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"text":"The security token to be exchanged.","type":"text"}]}],"name":"subjectToken"},{"content":[{"type":"paragraph","inlineContent":[{"text":"URI that identifies the type of the subject token.","type":"text"}]}],"name":"subjectTokenType"},{"content":[{"type":"paragraph","inlineContent":[{"text":"API Identifier that your application is requesting access to. Defaults to ","type":"text"},{"code":"nil","type":"codeVoice"},{"text":".","type":"text"}]}],"name":"audience"},{"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"}]}],"name":"scope"},{"content":[{"type":"paragraph","inlineContent":[{"text":"Identifier of an organization the user is a member of.","type":"text"}]}],"name":"organization"}]},{"content":[{"anchor":"return-value","type":"heading","level":2,"text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A request that will yield Auth0 user’s credentials."}]}],"kind":"content"},{"content":[{"anchor":"Availability","type":"heading","level":2,"text":"Availability"},{"type":"paragraph","inlineContent":[{"type":"text","text":"This feature is currently available in"},{"type":"text","text":" "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","isActive":true},{"type":"text","text":"."},{"type":"text","text":" "},{"type":"text","text":"Please reach out to "},{"type":"reference","identifier":"https:\/\/support.auth0.com\/","isActive":true},{"type":"text","text":" to enable for your tenant."}]},{"anchor":"Usage","type":"heading","level":2,"text":"Usage"},{"type":"codeListing","syntax":"swift","code":["Auth0"," .authentication()"," .customTokenExchange(subjectToken: \"existing-token\","," subjectTokenType: \"urn:ietf:params:oauth:token-type:jwt\","," audience: \"https:\/\/example.com\/api\","," scope: \"openid profile email\")"," .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 include organization parameter:"}]},{"type":"codeListing","syntax":"swift","code":["Auth0"," .authentication()"," .customTokenExchange(subjectToken: \"existing-token\","," subjectTokenType: \"urn:ietf:params:oauth:token-type:jwt\","," audience: \"https:\/\/example.com\/api\","," scope: \"openid profile email\","," organization: \"org_id\")"," .start { print($0) }"]}],"kind":"content"}],"schemaVersion":{"patch":0,"major":0,"minor":3},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"},"https://tools.ietf.org/html/rfc8693":{"identifier":"https:\/\/tools.ietf.org\/html\/rfc8693","url":"https:\/\/tools.ietf.org\/html\/rfc8693","titleInlineContent":[{"type":"text","text":"RFC 8693: OAuth 2.0 Token Exchange"}],"type":"link","title":"RFC 8693: OAuth 2.0 Token Exchange"},"https://auth0.com/docs/api/authentication":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","url":"https:\/\/auth0.com\/docs\/api\/authentication","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"type":"link","title":"Auth0 Authentication API"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","abstract":[{"type":"text","text":"Client for the "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","isActive":true},{"type":"text","text":"."}],"type":"topic","title":"Authentication","url":"\/documentation\/auth0\/authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/customTokenExchange(subjectToken:subjectTokenType:audience:scope:organization:)-5dzwp":{"kind":"symbol","title":"customTokenExchange(subjectToken:subjectTokenType:audience:scope:organization:)","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"customTokenExchange"},{"kind":"text","text":"("},{"kind":"externalParam","text":"subjectToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"text":"subjectTokenType","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"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"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"organization","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":"<"},{"kind":"typeIdentifier","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/customTokenExchange(subjectToken:subjectTokenType:audience:scope:organization:)-5dzwp","abstract":[{"text":"Performs a custom token exchange to obtain Auth0 credentials using an existing identity provider token.","type":"text"}],"url":"\/documentation\/auth0\/authentication\/customtokenexchange(subjecttoken:subjecttokentype:audience:scope:organization:)-5dzwp"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"Credentials","kind":"identifier"}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"title":"Request","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"abstract":[{"text":"Auth0 API request.","type":"text"}],"url":"\/documentation\/auth0\/request","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"https://auth0.com/docs/authenticate/custom-token-exchange":{"titleInlineContent":[{"type":"text","text":"Custom Token Exchange Documentation"}],"url":"https:\/\/auth0.com\/docs\/authenticate\/custom-token-exchange","type":"link","title":"Custom Token Exchange Documentation","identifier":"https:\/\/auth0.com\/docs\/authenticate\/custom-token-exchange"},"https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access":{"type":"link","titleInlineContent":[{"type":"text","text":"Early Access"}],"url":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","title":"Early Access","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access"},"https://auth0.com/docs/api/authentication/token-exchange":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/token-exchange","url":"https:\/\/auth0.com\/docs\/api\/authentication\/token-exchange","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"type":"link","title":"Authentication API Endpoint"},"https://support.auth0.com/":{"identifier":"https:\/\/support.auth0.com\/","url":"https:\/\/support.auth0.com\/","titleInlineContent":[{"type":"text","text":"Auth0 support"}],"type":"link","title":"Auth0 support"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authentication/customtokenexchange(subjecttoken:subjecttokentype:audience:scope:organization:).json b/docs/data/documentation/auth0/authentication/customtokenexchange(subjecttoken:subjecttokentype:audience:scope:organization:).json new file mode 100644 index 000000000..5dc8dd01e --- /dev/null +++ b/docs/data/documentation/auth0/authentication/customtokenexchange(subjecttoken:subjecttokentype:audience:scope:organization:).json @@ -0,0 +1 @@ +{"kind":"symbol","primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"customTokenExchange","kind":"identifier"},{"text":"(","kind":"text"},{"text":"subjectToken","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"subjectTokenType","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"organization","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?) -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","text":"Request"},{"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","preciseIdentifier":"s:5Auth019AuthenticationErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"text":"The security token to be exchanged.","type":"text"}],"type":"paragraph"}],"name":"subjectToken"},{"content":[{"inlineContent":[{"type":"text","text":"URI that identifies the type of the subject token."}],"type":"paragraph"}],"name":"subjectTokenType"},{"content":[{"inlineContent":[{"text":"API Identifier that your application is requesting access to. Defaults to ","type":"text"},{"code":"nil","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"}],"name":"audience"},{"content":[{"inlineContent":[{"text":"Space-separated list of requested scope values. Defaults to ","type":"text"},{"type":"codeVoice","code":"openid profile email"},{"type":"text","text":"."}],"type":"paragraph"}],"name":"scope"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Identifier of an organization the user is a member of."}]}],"name":"organization"}]},{"kind":"content","content":[{"type":"heading","text":"Return Value","anchor":"return-value","level":2},{"type":"paragraph","inlineContent":[{"type":"text","text":"A request that will yield Auth0 user’s credentials."}]}]},{"content":[{"level":2,"anchor":"Availability","type":"heading","text":"Availability"},{"inlineContent":[{"type":"text","text":"This feature is currently available in"},{"type":"text","text":" "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","isActive":true},{"type":"text","text":"."},{"type":"text","text":" "},{"type":"text","text":"Please reach out to "},{"type":"reference","identifier":"https:\/\/support.auth0.com\/","isActive":true},{"type":"text","text":" to enable for your tenant."}],"type":"paragraph"},{"level":2,"anchor":"Usage","type":"heading","text":"Usage"},{"code":["Auth0"," .authentication()"," .customTokenExchange(subjectToken: \"existing-token\","," subjectTokenType: \"urn:ietf:params:oauth:token-type:jwt\","," audience: \"https:\/\/example.com\/api\","," scope: \"openid profile email\")"," .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 include organization parameter:"}],"type":"paragraph"},{"code":["Auth0"," .authentication()"," .customTokenExchange(subjectToken: \"existing-token\","," subjectTokenType: \"urn:ietf:params:oauth:token-type:jwt\","," audience: \"https:\/\/example.com\/api\","," scope: \"openid profile email\","," organization: \"org_id\")"," .start { print($0) }"],"type":"codeListing","syntax":"swift"}],"kind":"content"}],"variants":[{"paths":["\/documentation\/auth0\/authentication\/customtokenexchange(subjecttoken:subjecttokentype:audience:scope:organization:)"],"traits":[{"interfaceLanguage":"swift"}]}],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication\/token-exchange","https:\/\/auth0.com\/docs\/authenticate\/custom-token-exchange","https:\/\/tools.ietf.org\/html\/rfc8693"],"anchor":"Related-Documentation"}],"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/customTokenExchange(subjectToken:subjectTokenType:audience:scope:organization:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Performs a custom token exchange to obtain Auth0 credentials using an existing identity provider token."}],"defaultImplementationsSections":[{"title":"Authentication Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/customTokenExchange(subjectToken:subjectTokenType:audience:scope:organization:)-5dzwp"],"anchor":"Authentication-Implementations"}],"metadata":{"roleHeading":"Instance Method","symbolKind":"method","role":"symbol","title":"customTokenExchange(subjectToken:subjectTokenType:audience:scope:organization:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"customTokenExchange"},{"kind":"text","text":"("},{"kind":"externalParam","text":"subjectToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"subjectTokenType"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"organization"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?) -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"required":true,"externalID":"s:5Auth014AuthenticationP19customTokenExchange07subjectD00fD4Type8audience5scope12organizationAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_S2SSgSSAQtF","modules":[{"name":"Auth0"}]},"references":{"https://support.auth0.com/":{"title":"Auth0 support","identifier":"https:\/\/support.auth0.com\/","titleInlineContent":[{"text":"Auth0 support","type":"text"}],"type":"link","url":"https:\/\/support.auth0.com\/"},"https://auth0.com/docs/api/authentication":{"title":"Auth0 Authentication API","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"title":"Request","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"abstract":[{"text":"Auth0 API request.","type":"text"}],"url":"\/documentation\/auth0\/request","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"Credentials","kind":"identifier"}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}]},"https://auth0.com/docs/api/authentication/token-exchange":{"type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/token-exchange","url":"https:\/\/auth0.com\/docs\/api\/authentication\/token-exchange","title":"Authentication API Endpoint","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"https://auth0.com/docs/authenticate/custom-token-exchange":{"title":"Custom Token Exchange Documentation","titleInlineContent":[{"type":"text","text":"Custom Token Exchange Documentation"}],"url":"https:\/\/auth0.com\/docs\/authenticate\/custom-token-exchange","identifier":"https:\/\/auth0.com\/docs\/authenticate\/custom-token-exchange","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","abstract":[{"type":"text","text":"Client for the "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","isActive":true},{"type":"text","text":"."}],"type":"topic","title":"Authentication","url":"\/documentation\/auth0\/authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"https://tools.ietf.org/html/rfc8693":{"titleInlineContent":[{"text":"RFC 8693: OAuth 2.0 Token Exchange","type":"text"}],"url":"https:\/\/tools.ietf.org\/html\/rfc8693","type":"link","title":"RFC 8693: OAuth 2.0 Token Exchange","identifier":"https:\/\/tools.ietf.org\/html\/rfc8693"},"https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access":{"titleInlineContent":[{"type":"text","text":"Early Access"}],"url":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","type":"link","title":"Early Access","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/customTokenExchange(subjectToken:subjectTokenType:audience:scope:organization:)":{"defaultImplementations":1,"type":"topic","abstract":[{"type":"text","text":"Performs a custom token exchange to obtain Auth0 credentials using an existing identity provider token."}],"kind":"symbol","url":"\/documentation\/auth0\/authentication\/customtokenexchange(subjecttoken:subjecttokentype:audience:scope:organization:)","title":"customTokenExchange(subjectToken:subjectTokenType:audience:scope:organization:)","required":true,"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"customTokenExchange"},{"text":"(","kind":"text"},{"text":"subjectToken","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"subjectTokenType"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"audience"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"organization","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":"<"},{"kind":"typeIdentifier","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/customTokenExchange(subjectToken:subjectTokenType:audience:scope:organization:)"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/customTokenExchange(subjectToken:subjectTokenType:audience:scope:organization:)-5dzwp":{"kind":"symbol","title":"customTokenExchange(subjectToken:subjectTokenType:audience:scope:organization:)","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"customTokenExchange"},{"kind":"text","text":"("},{"kind":"externalParam","text":"subjectToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"text":"subjectTokenType","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"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"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"organization","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":"<"},{"kind":"typeIdentifier","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/customTokenExchange(subjectToken:subjectTokenType:audience:scope:organization:)-5dzwp","abstract":[{"text":"Performs a custom token exchange to obtain Auth0 credentials using an existing identity provider token.","type":"text"}],"url":"\/documentation\/auth0\/authentication\/customtokenexchange(subjecttoken:subjecttokentype:audience:scope:organization:)-5dzwp"}}} \ 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 a534a5056..4b42642fd 100644 --- a/docs/data/documentation/auth0/authentication/jwks().json +++ b/docs/data/documentation/auth0/authentication/jwks().json @@ -1 +1 @@ -{"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"jwks","kind":"identifier"},{"text":"() -> ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS","preciseIdentifier":"s:5Auth04JWKSV","text":"JWKS","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"],"languages":["swift"]}],"kind":"declarations"},{"content":[{"type":"heading","anchor":"return-value","level":2,"text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A request that will yield JWKS information."}]}],"kind":"content"},{"content":[{"anchor":"Usage","level":2,"text":"Usage","type":"heading"},{"code":["Auth0"," .authentication()"," .jwks()"," .start { result in"," switch result {"," case .success(let jwks):"," print(\"Obtained JWKS: \\(jwks)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"],"syntax":"swift","type":"codeListing"}],"kind":"content"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"variants":[{"paths":["\/documentation\/auth0\/authentication\/jwks()"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"externalID":"s:5Auth014AuthenticationP4jwksAA7RequestVyAA4JWKSVAA0B5ErrorVGyF","roleHeading":"Instance Method","symbolKind":"method","title":"jwks()","role":"symbol","modules":[{"name":"Auth0"}],"required":true,"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"jwks","kind":"identifier"},{"text":"() -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"JWKS","preciseIdentifier":"s:5Auth04JWKSV","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}]},"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/json-web-tokens\/json-web-key-sets"],"title":"Related Documentation","anchor":"Related-Documentation"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/jwks()"},"abstract":[{"text":"Returns JSON Web Key Set (JWKS) information from the ","type":"text"},{"code":"\/.well-known\/jwks.json","type":"codeVoice"},{"text":" endpoint.","type":"text"}],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"type":"topic","role":"symbol","title":"Authentication","abstract":[{"text":"Client for the ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"text":".","type":"text"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"https://auth0.com/docs/secure/tokens/json-web-tokens/json-web-key-sets":{"title":"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","titleInlineContent":[{"text":"JSON Web Key Sets","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/request","kind":"symbol","abstract":[{"type":"text","text":"Auth0 API request."}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/JWKS":{"navigatorTitle":[{"text":"JWKS","kind":"identifier"}],"title":"JWKS","role":"symbol","url":"\/documentation\/auth0\/jwks","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS","abstract":[{"text":"The JSON Web Key Set (JWKS) of your Auth0 tenant.","type":"text"}],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"JWKS","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"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/jwks()":{"url":"\/documentation\/auth0\/authentication\/jwks()","required":true,"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"jwks","kind":"identifier"},{"text":"() -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth04JWKSV","text":"JWKS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"kind":"symbol","abstract":[{"text":"Returns JSON Web Key Set (JWKS) information from the ","type":"text"},{"type":"codeVoice","code":"\/.well-known\/jwks.json"},{"text":" endpoint.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/jwks()","type":"topic","title":"jwks()","role":"symbol"}}} \ No newline at end of file +{"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"jwks","kind":"identifier"},{"text":"() -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"},{"text":"<","kind":"text"},{"text":"JWKS","preciseIdentifier":"s:5Auth04JWKSV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS"},{"text":", ","kind":"text"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"},{"text":">","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]},{"kind":"content","content":[{"type":"heading","text":"Return Value","anchor":"return-value","level":2},{"type":"paragraph","inlineContent":[{"text":"A request that will yield JWKS information.","type":"text"}]}]},{"kind":"content","content":[{"type":"heading","text":"Usage","anchor":"Usage","level":2},{"type":"codeListing","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)\")"," }"," }"],"syntax":"swift"}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/jwks()"]}],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/json-web-tokens\/json-web-key-sets"],"anchor":"Related-Documentation"}],"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/jwks()"},"abstract":[{"type":"text","text":"Returns JSON Web Key Set (JWKS) information from the "},{"type":"codeVoice","code":"\/.well-known\/jwks.json"},{"type":"text","text":" endpoint."}],"metadata":{"roleHeading":"Instance Method","symbolKind":"method","role":"symbol","title":"jwks()","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"jwks","kind":"identifier"},{"text":"() -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth04JWKSV","text":"JWKS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"required":true,"externalID":"s:5Auth014AuthenticationP4jwksAA7RequestVyAA4JWKSVAA0B5ErrorVGyF","modules":[{"name":"Auth0"}]},"references":{"https://auth0.com/docs/api/authentication":{"title":"Auth0 Authentication API","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/jwks()":{"kind":"symbol","title":"jwks()","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"jwks"},{"kind":"text","text":"() -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:5Auth04JWKSV","kind":"typeIdentifier","text":"JWKS"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","text":"AuthenticationError"},{"kind":"text","text":">"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/jwks()","required":true,"abstract":[{"type":"text","text":"Returns JSON Web Key Set (JWKS) information from the "},{"type":"codeVoice","code":"\/.well-known\/jwks.json"},{"type":"text","text":" endpoint."}],"url":"\/documentation\/auth0\/authentication\/jwks()"},"https://auth0.com/docs/secure/tokens/json-web-tokens/json-web-key-sets":{"title":"JSON Web Key Sets","type":"link","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/json-web-tokens\/json-web-key-sets","titleInlineContent":[{"type":"text","text":"JSON Web Key Sets"}],"url":"https:\/\/auth0.com\/docs\/secure\/tokens\/json-web-tokens\/json-web-key-sets"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"title":"Request","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"abstract":[{"text":"Auth0 API request.","type":"text"}],"url":"\/documentation\/auth0\/request","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","abstract":[{"type":"text","text":"Client for the "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","isActive":true},{"type":"text","text":"."}],"type":"topic","title":"Authentication","url":"\/documentation\/auth0\/authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"doc://com.auth0.Auth0/documentation/Auth0/JWKS":{"role":"symbol","title":"JWKS","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"JWKS"}],"navigatorTitle":[{"kind":"identifier","text":"JWKS"}],"abstract":[{"type":"text","text":"The JSON Web Key Set (JWKS) of your Auth0 tenant."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS","url":"\/documentation\/auth0\/jwks","type":"topic"}}} \ 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 13931db43..9ae96dd51 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 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(appleAuthorizationCode:fullName:profile:audience:scope:)-6sf9m","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Logs a user in with their Sign In with Apple authorization code."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"kind":"externalParam","text":"appleAuthorizationCode"},{"kind":"text","text":" "},{"kind":"internalParam","text":"authorizationCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"fullName"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation20PersonNameComponentsV","text":"PersonNameComponents"},{"kind":"text","text":"? = nil, "},{"kind":"externalParam","text":"profile"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]? = nil, "},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"? = nil, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" = defaultScope) -> "},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","preciseIdentifier":"s:5Auth07RequestV","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":", "},{"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":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Authorization Code retrieved from Apple Authorization."}]}],"name":"authorizationCode"},{"content":[{"inlineContent":[{"type":"text","text":"The full name property returned with the Apple ID Credentials."}],"type":"paragraph"}],"name":"fullName"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Additional user profile data returned with the Apple ID Credentials."}]}],"name":"profile"},{"content":[{"inlineContent":[{"type":"text","text":"API Identifier that your application is requesting access to."}],"type":"paragraph"}],"name":"audience"},{"content":[{"inlineContent":[{"type":"text","text":"Space-separated list of requested scope values. Defaults to "},{"type":"codeVoice","code":"openid profile email"},{"type":"text","text":"."}],"type":"paragraph"}],"name":"scope"}]},{"kind":"content","content":[{"level":2,"type":"heading","text":"Return Value","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","type":"heading","level":2},{"syntax":"swift","type":"codeListing","code":["Auth0"," .authentication()"," .login(appleAuthorizationCode: \"auth-code\")"," .start { result in"," switch result {"," case .success(let credentials):"," print(\"Obtained credentials: \\(credentials)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"]},{"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(appleAuthorizationCode: \"auth-code\","," fullName: credentials.fullName,"," audience: \"https:\/\/example.com\/api\","," scope: \"openid profile email offline_access\")"," .start { print($0) }"]}]}],"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\/token-exchange-native-social"],"anchor":"Related-Documentation","title":"Related Documentation"}],"metadata":{"externalID":"s:5Auth014AuthenticationPAAE5login22appleAuthorizationCode8fullName7profile8audience5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_10Foundation06PersonH10ComponentsVSgSDySSypGSgSSSgSStF","extendedModule":"Auth0","role":"symbol","title":"login(appleAuthorizationCode:fullName:profile:audience:scope:)","roleHeading":"Instance Method","symbolKind":"method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"kind":"externalParam","text":"appleAuthorizationCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"fullName"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"PersonNameComponents","preciseIdentifier":"s:10Foundation20PersonNameComponentsV"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"profile"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]?, "},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"modules":[{"name":"Auth0"}]},"schemaVersion":{"patch":0,"major":0,"minor":3},"kind":"symbol","sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"type":"topic","role":"symbol","title":"Authentication","abstract":[{"text":"Client for the ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"text":".","type":"text"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"https://auth0.com/docs/api/authentication/token-exchange-for-native-social/token-exchange-native-social":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/token-exchange-for-native-social\/token-exchange-native-social","title":"Authentication API Endpoint","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication\/token-exchange-for-native-social\/token-exchange-native-social","type":"link"},"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"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(appleAuthorizationCode:fullName:profile:audience:scope:)-6sf9m":{"title":"login(appleAuthorizationCode:fullName:profile:audience:scope:)","abstract":[{"text":"Logs a user in with their Sign In with Apple authorization code.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(appleAuthorizationCode:fullName:profile:audience:scope:)-6sf9m","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"kind":"externalParam","text":"appleAuthorizationCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"fullName"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"PersonNameComponents","preciseIdentifier":"s:10Foundation20PersonNameComponentsV"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"profile"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]?, "},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"type":"topic","kind":"symbol","url":"\/documentation\/auth0\/authentication\/login(appleauthorizationcode:fullname:profile:audience:scope:)-6sf9m"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"url":"\/documentation\/auth0\/credentials","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"role":"symbol","type":"topic","abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/request","kind":"symbol","abstract":[{"type":"text","text":"Auth0 API request."}]}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/login(appleauthorizationcode:fullname:profile:audience:scope:)-6sf9m"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"abstract":[{"type":"text","text":"Logs a user in with their Sign In with Apple authorization code."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"appleAuthorizationCode","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"authorizationCode","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"fullName","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"PersonNameComponents","preciseIdentifier":"s:10Foundation20PersonNameComponentsV","kind":"typeIdentifier"},{"text":"? = nil, ","kind":"text"},{"text":"profile","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"]? = nil, ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"? = nil, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" = defaultScope) -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}]},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"type":"text","text":"Authorization Code retrieved from Apple Authorization."}],"type":"paragraph"}],"name":"authorizationCode"},{"content":[{"inlineContent":[{"type":"text","text":"The full name property returned with the Apple ID Credentials."}],"type":"paragraph"}],"name":"fullName"},{"content":[{"inlineContent":[{"type":"text","text":"Additional user profile data returned with the Apple ID Credentials."}],"type":"paragraph"}],"name":"profile"},{"content":[{"inlineContent":[{"type":"text","text":"API Identifier that your application is requesting access to."}],"type":"paragraph"}],"name":"audience"},{"content":[{"inlineContent":[{"type":"text","text":"Space-separated list of requested scope values. Defaults to "},{"type":"codeVoice","code":"openid profile email"},{"type":"text","text":"."}],"type":"paragraph"}],"name":"scope"}]},{"kind":"content","content":[{"type":"heading","level":2,"anchor":"return-value","text":"Return Value"},{"inlineContent":[{"text":"A request that will yield Auth0 user’s credentials.","type":"text"}],"type":"paragraph"}]},{"kind":"content","content":[{"type":"heading","level":2,"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":"symbol","schemaVersion":{"patch":0,"minor":3,"major":0},"sections":[],"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/api\/authentication\/token-exchange-for-native-social\/token-exchange-native-social"],"title":"Related Documentation","anchor":"Related-Documentation"}],"metadata":{"externalID":"s:5Auth014AuthenticationPAAE5login22appleAuthorizationCode8fullName7profile8audience5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_10Foundation06PersonH10ComponentsVSgSDySSypGSgSSSgSStF","extendedModule":"Auth0","symbolKind":"method","title":"login(appleAuthorizationCode:fullName:profile:audience:scope:)","role":"symbol","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"kind":"externalParam","text":"appleAuthorizationCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"fullName"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation20PersonNameComponentsV","text":"PersonNameComponents"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"profile"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]?, "},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","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":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"modules":[{"name":"Auth0"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(appleAuthorizationCode:fullName:profile:audience:scope:)-6sf9m","interfaceLanguage":"swift"},"references":{"https://auth0.com/docs/api/authentication":{"titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication","type":"link","title":"Auth0 Authentication API","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(appleAuthorizationCode:fullName:profile:audience:scope:)-6sf9m":{"type":"topic","abstract":[{"type":"text","text":"Logs a user in with their Sign In with Apple authorization code."}],"kind":"symbol","url":"\/documentation\/auth0\/authentication\/login(appleauthorizationcode:fullname:profile:audience:scope:)-6sf9m","title":"login(appleAuthorizationCode:fullName:profile:audience:scope:)","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"kind":"externalParam","text":"appleAuthorizationCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"fullName"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation20PersonNameComponentsV","text":"PersonNameComponents"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"profile"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]?, "},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","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":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(appleAuthorizationCode:fullName:profile:audience:scope:)-6sf9m"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"title":"Request","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"abstract":[{"text":"Auth0 API request.","type":"text"}],"url":"\/documentation\/auth0\/request","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"Credentials","kind":"identifier"}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"https://auth0.com/docs/api/authentication/token-exchange-for-native-social/token-exchange-native-social":{"titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication\/token-exchange-for-native-social\/token-exchange-native-social","type":"link","title":"Authentication API Endpoint","identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/token-exchange-for-native-social\/token-exchange-native-social"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","abstract":[{"type":"text","text":"Client for the "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","isActive":true},{"type":"text","text":"."}],"type":"topic","title":"Authentication","url":"\/documentation\/auth0\/authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authentication/login(appleauthorizationcode:fullname:profile:audience:scope:).json b/docs/data/documentation/auth0/authentication/login(appleauthorizationcode:fullname:profile:audience:scope:).json index d95144cf2..ab52131ae 100644 --- a/docs/data/documentation/auth0/authentication/login(appleauthorizationcode:fullname:profile:audience:scope:).json +++ b/docs/data/documentation/auth0/authentication/login(appleauthorizationcode:fullname:profile:audience:scope:).json @@ -1 +1 @@ -{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/login(appleauthorizationcode:fullname:profile:audience:scope:)"]}],"schemaVersion":{"major":0,"patch":0,"minor":3},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"kind":"symbol","abstract":[{"type":"text","text":"Logs a user in with their Sign In with Apple authorization code."}],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication\/token-exchange-for-native-social\/token-exchange-native-social"],"anchor":"Related-Documentation"}],"metadata":{"required":true,"roleHeading":"Instance Method","externalID":"s:5Auth014AuthenticationP5login22appleAuthorizationCode8fullName7profile8audience5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_10Foundation06PersonH10ComponentsVSgSDySSypGSgSSSgSStF","modules":[{"name":"Auth0"}],"role":"symbol","symbolKind":"method","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"},{"text":", ","kind":"text"},{"text":"fullName","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"PersonNameComponents","preciseIdentifier":"s:10Foundation20PersonNameComponentsV","kind":"typeIdentifier"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"profile"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]?, "},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","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":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"title":"login(appleAuthorizationCode:fullName:profile:audience:scope:)"},"sections":[],"defaultImplementationsSections":[{"title":"Authentication Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(appleAuthorizationCode:fullName:profile:audience:scope:)-6sf9m"],"anchor":"Authentication-Implementations"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(appleAuthorizationCode:fullName:profile:audience:scope:)"},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"appleAuthorizationCode","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"authorizationCode","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"fullName","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"PersonNameComponents","preciseIdentifier":"s:10Foundation20PersonNameComponentsV","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"profile","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"]?, ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"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"},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"},{"text":", ","kind":"text"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"},{"text":">","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]},{"kind":"parameters","parameters":[{"name":"authorizationCode","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Authorization Code retrieved from Apple Authorization."}]}]},{"name":"fullName","content":[{"inlineContent":[{"text":"The full name property returned with the Apple ID Credentials.","type":"text"}],"type":"paragraph"}]},{"name":"profile","content":[{"inlineContent":[{"text":"Additional user profile data returned with the Apple ID Credentials.","type":"text"}],"type":"paragraph"}]},{"name":"audience","content":[{"inlineContent":[{"type":"text","text":"API Identifier that your application is requesting access to."}],"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"},{"text":".","type":"text"}]}]}]},{"kind":"content","content":[{"anchor":"return-value","level":2,"type":"heading","text":"Return Value"},{"inlineContent":[{"text":"A request that will yield Auth0 user’s credentials.","type":"text"}],"type":"paragraph"}]},{"kind":"content","content":[{"level":2,"type":"heading","anchor":"Usage","text":"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"},{"type":"paragraph","inlineContent":[{"text":"You can also specify audience (the Auth0 API identifier) and scope values:","type":"text"}]},{"type":"codeListing","code":["Auth0"," .authentication()"," .login(appleAuthorizationCode: \"auth-code\","," fullName: credentials.fullName,"," audience: \"https:\/\/example.com\/api\","," scope: \"openid profile email offline_access\")"," .start { print($0) }"],"syntax":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(appleAuthorizationCode:fullName:profile:audience:scope:)":{"title":"login(appleAuthorizationCode:fullName:profile:audience:scope:)","abstract":[{"text":"Logs a user in with their Sign In with Apple authorization code.","type":"text"}],"required":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(appleAuthorizationCode:fullName:profile:audience:scope:)","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"kind":"externalParam","text":"appleAuthorizationCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"fullName"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"PersonNameComponents","preciseIdentifier":"s:10Foundation20PersonNameComponentsV"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"profile"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]?, "},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"type":"topic","defaultImplementations":1,"kind":"symbol","url":"\/documentation\/auth0\/authentication\/login(appleauthorizationcode:fullname:profile:audience:scope:)"},"https://auth0.com/docs/api/authentication":{"identifier":"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"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"type":"topic","role":"symbol","title":"Authentication","abstract":[{"text":"Client for the ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"text":".","type":"text"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"url":"\/documentation\/auth0\/credentials","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"role":"symbol","type":"topic","abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}]},"https://auth0.com/docs/api/authentication/token-exchange-for-native-social/token-exchange-native-social":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/token-exchange-for-native-social\/token-exchange-native-social","type":"link","url":"https:\/\/auth0.com\/docs\/api\/authentication\/token-exchange-for-native-social\/token-exchange-native-social","title":"Authentication API Endpoint","titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(appleAuthorizationCode:fullName:profile:audience:scope:)-6sf9m":{"title":"login(appleAuthorizationCode:fullName:profile:audience:scope:)","abstract":[{"text":"Logs a user in with their Sign In with Apple authorization code.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(appleAuthorizationCode:fullName:profile:audience:scope:)-6sf9m","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"kind":"externalParam","text":"appleAuthorizationCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"fullName"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"PersonNameComponents","preciseIdentifier":"s:10Foundation20PersonNameComponentsV"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"profile"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]?, "},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"type":"topic","kind":"symbol","url":"\/documentation\/auth0\/authentication\/login(appleauthorizationcode:fullname:profile:audience:scope:)-6sf9m"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/request","kind":"symbol","abstract":[{"type":"text","text":"Auth0 API request."}]}}} \ No newline at end of file +{"metadata":{"symbolKind":"method","title":"login(appleAuthorizationCode:fullName:profile:audience:scope:)","externalID":"s:5Auth014AuthenticationP5login22appleAuthorizationCode8fullName7profile8audience5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_10Foundation06PersonH10ComponentsVSgSDySSypGSgSSSgSStF","roleHeading":"Instance Method","modules":[{"name":"Auth0"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"appleAuthorizationCode","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"fullName","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"PersonNameComponents","preciseIdentifier":"s:10Foundation20PersonNameComponentsV","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"profile","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"]?, ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"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"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"role":"symbol","required":true},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/login(appleauthorizationcode:fullname:profile:audience:scope:)"]}],"defaultImplementationsSections":[{"title":"Authentication Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(appleAuthorizationCode:fullName:profile:audience:scope:)-6sf9m"],"anchor":"Authentication-Implementations"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(appleAuthorizationCode:fullName:profile:audience:scope:)"},"kind":"symbol","abstract":[{"text":"Logs a user in with their Sign In with Apple authorization code.","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication\/token-exchange-for-native-social\/token-exchange-native-social"],"anchor":"Related-Documentation"}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"appleAuthorizationCode","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"authorizationCode","kind":"internalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"fullName","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation20PersonNameComponentsV","text":"PersonNameComponents","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"profile","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"]?, ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","text":"Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"platforms":["iOS"]}],"kind":"declarations"},{"parameters":[{"content":[{"inlineContent":[{"text":"Authorization Code retrieved from Apple Authorization.","type":"text"}],"type":"paragraph"}],"name":"authorizationCode"},{"name":"fullName","content":[{"inlineContent":[{"text":"The full name property returned with the Apple ID Credentials.","type":"text"}],"type":"paragraph"}]},{"name":"profile","content":[{"inlineContent":[{"text":"Additional user profile data returned with the Apple ID Credentials.","type":"text"}],"type":"paragraph"}]},{"name":"audience","content":[{"inlineContent":[{"type":"text","text":"API Identifier that your application is requesting access to."}],"type":"paragraph"}]},{"name":"scope","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"}]}],"kind":"parameters"},{"content":[{"text":"Return Value","level":2,"type":"heading","anchor":"return-value"},{"type":"paragraph","inlineContent":[{"text":"A request that will yield Auth0 user’s credentials.","type":"text"}]}],"kind":"content"},{"content":[{"anchor":"Usage","type":"heading","level":2,"text":"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) }"],"syntax":"swift","type":"codeListing"}],"kind":"content"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"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"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(appleAuthorizationCode:fullName:profile:audience:scope:)-6sf9m":{"type":"topic","abstract":[{"type":"text","text":"Logs a user in with their Sign In with Apple authorization code."}],"kind":"symbol","url":"\/documentation\/auth0\/authentication\/login(appleauthorizationcode:fullname:profile:audience:scope:)-6sf9m","title":"login(appleAuthorizationCode:fullName:profile:audience:scope:)","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"kind":"externalParam","text":"appleAuthorizationCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"fullName"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation20PersonNameComponentsV","text":"PersonNameComponents"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"profile"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]?, "},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","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":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(appleAuthorizationCode:fullName:profile:audience:scope:)-6sf9m"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"title":"Request","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"abstract":[{"text":"Auth0 API request.","type":"text"}],"url":"\/documentation\/auth0\/request","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(appleAuthorizationCode:fullName:profile:audience:scope:)":{"defaultImplementations":1,"type":"topic","abstract":[{"type":"text","text":"Logs a user in with their Sign In with Apple authorization code."}],"title":"login(appleAuthorizationCode:fullName:profile:audience:scope:)","kind":"symbol","url":"\/documentation\/auth0\/authentication\/login(appleauthorizationcode:fullname:profile:audience:scope:)","required":true,"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"kind":"externalParam","text":"appleAuthorizationCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"fullName"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"PersonNameComponents","preciseIdentifier":"s:10Foundation20PersonNameComponentsV"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"profile"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]?, "},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(appleAuthorizationCode:fullName:profile:audience:scope:)"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"Credentials","kind":"identifier"}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"https://auth0.com/docs/api/authentication/token-exchange-for-native-social/token-exchange-native-social":{"title":"Authentication API Endpoint","titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}],"type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/token-exchange-for-native-social\/token-exchange-native-social","url":"https:\/\/auth0.com\/docs\/api\/authentication\/token-exchange-for-native-social\/token-exchange-native-social"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","abstract":[{"type":"text","text":"Client for the "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","isActive":true},{"type":"text","text":"."}],"type":"topic","title":"Authentication","url":"\/documentation\/auth0\/authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]}}} \ 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 b7e4971e9..4679fd8bd 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","metadata":{"roleHeading":"Instance Method","title":"login(email:code:audience:scope:)","modules":[{"name":"Auth0"}],"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"email","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"code","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"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"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"extendedModule":"Auth0","externalID":"s:5Auth014AuthenticationPAAE5login5email4code8audience5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_S2SSgSStF","symbolKind":"method"},"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"abstract":[{"text":"Logs a user in 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"}],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication\/passwordless\/authenticate-user"],"anchor":"Related-Documentation"}],"primaryContentSections":[{"declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"email","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"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"? = nil, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" = defaultScope) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"},{"text":">","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"email","content":[{"type":"paragraph","inlineContent":[{"text":"Email the user used to start the passwordless login flow.","type":"text"}]}]},{"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":[{"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":[{"text":"Space-separated list of requested scope values. Defaults to ","type":"text"},{"code":"openid profile email","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"}]}]},{"content":[{"type":"heading","level":2,"text":"Return Value","anchor":"return-value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Request that will yield Auth0 user’s credentials."}]}],"kind":"content"},{"content":[{"anchor":"Usage","type":"heading","level":2,"text":"Usage"},{"syntax":"swift","code":["Auth0"," .authentication()"," .login(email: \"support@auth0.com\", code: \"123456\")"," .start { result in"," switch result {"," case .success(let credentials):"," print(\"Obtained credentials: \\(credentials)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"],"type":"codeListing"},{"inlineContent":[{"type":"text","text":"You can also specify audience (the Auth0 API identifier) and scope values:"}],"type":"paragraph"},{"syntax":"swift","code":["Auth0"," .authentication()"," .login(email: \"support@auth0.com\","," code: \"123456\","," audience: \"https:\/\/example.com\/api\","," scope: \"openid profile email offline_access\")"," .start { print($0) }"],"type":"codeListing"},{"style":"note","content":[{"inlineContent":[{"type":"text","text":"Passwordless OTP Grant "},{"type":"codeVoice","code":"http:\/\/auth0.com\/oauth\/grant-type\/passwordless\/otp"},{"type":"text","text":". Check"},{"type":"text","text":" "},{"type":"reference","isActive":true,"identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types"},{"type":"text","text":" for more information."}],"type":"paragraph"}],"type":"aside","name":"Requires"}],"kind":"content"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/login(email:code:audience:scope:)-39g8b"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(email:code:audience:scope:)-39g8b","interfaceLanguage":"swift"},"sections":[],"references":{"https://auth0.com/docs/api/authentication/passwordless/authenticate-user":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/passwordless\/authenticate-user","type":"link","url":"https:\/\/auth0.com\/docs\/api\/authentication\/passwordless\/authenticate-user","title":"Authentication API Endpoint","titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}]},"https://auth0.com/docs/api/authentication":{"identifier":"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"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"url":"\/documentation\/auth0\/credentials","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"role":"symbol","type":"topic","abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/request","kind":"symbol","abstract":[{"type":"text","text":"Auth0 API request."}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(email:code:audience:scope:)-39g8b":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(email:code:audience:scope:)-39g8b","title":"login(email:code:audience:scope:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"email","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"code","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"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"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"url":"\/documentation\/auth0\/authentication\/login(email:code:audience:scope:)-39g8b","abstract":[{"type":"text","text":"Logs a user in 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"}],"role":"symbol","kind":"symbol","type":"topic"},"https://auth0.com/docs/get-started/applications/application-grant-types":{"identifier":"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","titleInlineContent":[{"text":"our documentation","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"type":"topic","role":"symbol","title":"Authentication","abstract":[{"text":"Client for the ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"text":".","type":"text"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]}}} \ No newline at end of file +{"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/login(email:code:audience:scope:)-39g8b"]}],"kind":"symbol","seeAlsoSections":[{"anchor":"Related-Documentation","title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication\/passwordless\/authenticate-user"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"abstract":[{"text":"Logs a user in 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"}],"schemaVersion":{"major":0,"patch":0,"minor":3},"metadata":{"role":"symbol","title":"login(email:code:audience:scope:)","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"text":"email","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"code","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","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"},{"kind":"text","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":">"}],"externalID":"s:5Auth014AuthenticationPAAE5login5email4code8audience5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_S2SSgSStF","extendedModule":"Auth0","roleHeading":"Instance Method","symbolKind":"method"},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"email","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"code"},{"kind":"text","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"},{"kind":"text","text":"? = nil, "},{"kind":"externalParam","text":"scope"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" = defaultScope) -> ","kind":"text"},{"text":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"},{"text":">","kind":"text"}],"platforms":["iOS"]}]},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"text":"Email the user used to start the passwordless login flow.","type":"text"}],"type":"paragraph"}],"name":"email"},{"content":[{"inlineContent":[{"text":"One-time password (OTP) code the user received via email.","type":"text"}],"type":"paragraph"}],"name":"code"},{"content":[{"inlineContent":[{"text":"API Identifier that your application is requesting access to. Defaults to ","type":"text"},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}],"type":"paragraph"}],"name":"audience"},{"content":[{"inlineContent":[{"text":"Space-separated list of requested scope values. Defaults to ","type":"text"},{"code":"openid profile email","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"}],"name":"scope"}]},{"kind":"content","content":[{"text":"Return Value","level":2,"type":"heading","anchor":"return-value"},{"inlineContent":[{"text":"Request that will yield Auth0 user’s credentials.","type":"text"}],"type":"paragraph"}]},{"kind":"content","content":[{"text":"Usage","level":2,"type":"heading","anchor":"Usage"},{"syntax":"swift","code":["Auth0"," .authentication()"," .login(email: \"support@auth0.com\", code: \"123456\")"," .start { result in"," switch result {"," case .success(let credentials):"," print(\"Obtained credentials: \\(credentials)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"],"type":"codeListing"},{"inlineContent":[{"text":"You can also specify audience (the Auth0 API identifier) and scope values:","type":"text"}],"type":"paragraph"},{"syntax":"swift","code":["Auth0"," .authentication()"," .login(email: \"support@auth0.com\","," code: \"123456\","," audience: \"https:\/\/example.com\/api\","," scope: \"openid profile email offline_access\")"," .start { print($0) }"],"type":"codeListing"},{"content":[{"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","isActive":true,"type":"reference"},{"text":" for more information.","type":"text"}],"type":"paragraph"}],"style":"note","name":"Requires","type":"aside"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(email:code:audience:scope:)-39g8b","interfaceLanguage":"swift"},"references":{"https://auth0.com/docs/api/authentication":{"titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication","type":"link","title":"Auth0 Authentication API","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(email:code:audience:scope:)-39g8b":{"kind":"symbol","title":"login(email:code:audience:scope:)","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"kind":"externalParam","text":"email"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"code"},{"kind":"text","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":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","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":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(email:code:audience:scope:)-39g8b","abstract":[{"type":"text","text":"Logs a user in 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."}],"url":"\/documentation\/auth0\/authentication\/login(email:code:audience:scope:)-39g8b"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"title":"Request","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"abstract":[{"text":"Auth0 API request.","type":"text"}],"url":"\/documentation\/auth0\/request","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"Credentials","kind":"identifier"}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","abstract":[{"type":"text","text":"Client for the "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","isActive":true},{"type":"text","text":"."}],"type":"topic","title":"Authentication","url":"\/documentation\/auth0\/authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"https://auth0.com/docs/get-started/applications/application-grant-types":{"titleInlineContent":[{"type":"text","text":"our documentation"}],"url":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","type":"link","title":"our documentation","identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types"},"https://auth0.com/docs/api/authentication/passwordless/authenticate-user":{"title":"Authentication API Endpoint","type":"link","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/passwordless\/authenticate-user","url":"https:\/\/auth0.com\/docs\/api\/authentication\/passwordless\/authenticate-user"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authentication/login(email:code:audience:scope:).json b/docs/data/documentation/auth0/authentication/login(email:code:audience:scope:).json index fa18a168c..90073b40f 100644 --- a/docs/data/documentation/auth0/authentication/login(email:code:audience:scope:).json +++ b/docs/data/documentation/auth0/authentication/login(email:code:audience:scope:).json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"email","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"code","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"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"},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"},{"text":", ","kind":"text"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"},{"text":">","kind":"text"}],"platforms":["iOS"]}]},{"parameters":[{"content":[{"inlineContent":[{"text":"Email the user used to start the passwordless login flow.","type":"text"}],"type":"paragraph"}],"name":"email"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"One-time password (OTP) code the user received via email."}]}],"name":"code"},{"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":"audience"},{"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"}]}],"name":"scope"}],"kind":"parameters"},{"content":[{"text":"Return Value","level":2,"anchor":"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(email: \"support@auth0.com\", code: \"123456\")"," .start { result in"," switch result {"," case .success(let credentials):"," print(\"Obtained credentials: \\(credentials)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"],"type":"codeListing","syntax":"swift"},{"type":"paragraph","inlineContent":[{"type":"text","text":"You can also specify audience (the Auth0 API identifier) and scope values:"}]},{"code":["Auth0"," .authentication()"," .login(email: \"support@auth0.com\","," code: \"123456\","," audience: \"https:\/\/example.com\/api\","," scope: \"openid profile email offline_access\")"," .start { print($0) }"],"type":"codeListing","syntax":"swift"},{"content":[{"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."}]}],"type":"aside","name":"Requires","style":"note"}],"kind":"content"}],"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/api\/authentication\/passwordless\/authenticate-user"],"anchor":"Related-Documentation","title":"Related Documentation"}],"metadata":{"modules":[{"name":"Auth0"}],"externalID":"s:5Auth014AuthenticationP5login5email4code8audience5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_S2SSgSStF","title":"login(email:code:audience:scope:)","roleHeading":"Instance Method","role":"symbol","symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"email","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"code","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"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"}],"required":true},"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","abstract":[{"text":"Logs a user in 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"}],"defaultImplementationsSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(email:code:audience:scope:)-39g8b"],"anchor":"Authentication-Implementations","title":"Authentication Implementations"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/login(email:code:audience:scope:)"]}],"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(email:code:audience:scope:)","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"https://auth0.com/docs/api/authentication/passwordless/authenticate-user":{"type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/passwordless\/authenticate-user","title":"Authentication API Endpoint","url":"https:\/\/auth0.com\/docs\/api\/authentication\/passwordless\/authenticate-user","titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}]},"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"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"url":"\/documentation\/auth0\/credentials","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"role":"symbol","type":"topic","abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(email:code:audience:scope:)":{"type":"topic","defaultImplementations":1,"role":"symbol","title":"login(email:code:audience:scope:)","abstract":[{"text":"Logs a user in 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"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"email","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"code","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"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"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"url":"\/documentation\/auth0\/authentication\/login(email:code:audience:scope:)","required":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(email:code:audience:scope:)","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"type":"topic","role":"symbol","title":"Authentication","abstract":[{"text":"Client for the ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"text":".","type":"text"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/request","kind":"symbol","abstract":[{"type":"text","text":"Auth0 API request."}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(email:code:audience:scope:)-39g8b":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(email:code:audience:scope:)-39g8b","title":"login(email:code:audience:scope:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"email","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"code","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"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"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"url":"\/documentation\/auth0\/authentication\/login(email:code:audience:scope:)-39g8b","abstract":[{"type":"text","text":"Logs a user in 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"}],"role":"symbol","kind":"symbol","type":"topic"},"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","titleInlineContent":[{"type":"text","text":"our documentation"}],"title":"our documentation"}}} \ No newline at end of file +{"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"email","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"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"},{"text":">","kind":"text"}],"platforms":["iOS"]}]},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"type":"text","text":"Email the user used to start the passwordless login flow."}],"type":"paragraph"}],"name":"email"},{"content":[{"inlineContent":[{"type":"text","text":"One-time password (OTP) code the user received via email."}],"type":"paragraph"}],"name":"code"},{"content":[{"inlineContent":[{"text":"API Identifier that your application is requesting access to. Defaults to ","type":"text"},{"code":"nil","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"}],"name":"audience"},{"content":[{"inlineContent":[{"type":"text","text":"Space-separated list of requested scope values. Defaults to "},{"type":"codeVoice","code":"openid profile email"},{"type":"text","text":"."}],"type":"paragraph"}],"name":"scope"}]},{"content":[{"type":"heading","level":2,"anchor":"return-value","text":"Return Value"},{"type":"paragraph","inlineContent":[{"text":"Request that will yield Auth0 user’s credentials.","type":"text"}]}],"kind":"content"},{"content":[{"text":"Usage","level":2,"type":"heading","anchor":"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)\")"," }"," }"]},{"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(email: \"support@auth0.com\","," code: \"123456\","," audience: \"https:\/\/example.com\/api\","," scope: \"openid profile email offline_access\")"," .start { print($0) }"]},{"type":"aside","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","isActive":true,"identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types"},{"text":" for more information.","type":"text"}],"type":"paragraph"}],"style":"note"}],"kind":"content"}],"sections":[],"abstract":[{"text":"Logs a user in 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."}],"kind":"symbol","defaultImplementationsSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(email:code:audience:scope:)-39g8b"],"title":"Authentication Implementations","anchor":"Authentication-Implementations"}],"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/api\/authentication\/passwordless\/authenticate-user"],"title":"Related Documentation","anchor":"Related-Documentation"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/login(email:code:audience:scope:)"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(email:code:audience:scope:)","interfaceLanguage":"swift"},"metadata":{"roleHeading":"Instance Method","symbolKind":"method","title":"login(email:code:audience:scope:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"email","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"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"required":true,"externalID":"s:5Auth014AuthenticationP5login5email4code8audience5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_S2SSgSStF","modules":[{"name":"Auth0"}]},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(email:code:audience:scope:)":{"title":"login(email:code:audience:scope:)","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(email:code:audience:scope:)","role":"symbol","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"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":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"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":"<"},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"abstract":[{"type":"text","text":"Logs a user in 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"}],"defaultImplementations":1,"url":"\/documentation\/auth0\/authentication\/login(email:code:audience:scope:)","required":true},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"},"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/Credentials":{"title":"Credentials","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"Credentials","kind":"identifier"}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","abstract":[{"type":"text","text":"Client for the "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","isActive":true},{"type":"text","text":"."}],"type":"topic","title":"Authentication","url":"\/documentation\/auth0\/authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"https://auth0.com/docs/api/authentication/passwordless/authenticate-user":{"url":"https:\/\/auth0.com\/docs\/api\/authentication\/passwordless\/authenticate-user","type":"link","title":"Authentication API Endpoint","titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}],"identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/passwordless\/authenticate-user"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"title":"Request","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"abstract":[{"text":"Auth0 API request.","type":"text"}],"url":"\/documentation\/auth0\/request","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(email:code:audience:scope:)-39g8b":{"kind":"symbol","title":"login(email:code:audience:scope:)","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"kind":"externalParam","text":"email"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"code"},{"kind":"text","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":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","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":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(email:code:audience:scope:)-39g8b","abstract":[{"type":"text","text":"Logs a user in 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."}],"url":"\/documentation\/auth0\/authentication\/login(email:code:audience:scope:)-39g8b"},"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"}}} \ 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 a88722367..b009461de 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 @@ -{"abstract":[{"type":"text","text":"Logs a user in with their Facebook "},{"type":"reference","isActive":true,"identifier":"https:\/\/developers.facebook.com\/docs\/facebook-login\/access-tokens\/session-info-access-token\/"},{"type":"text","text":" and profile data."}],"primaryContentSections":[{"kind":"declarations","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"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"profile"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"? = nil, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" = defaultScope) -> "},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","preciseIdentifier":"s:5Auth07RequestV","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":", "},{"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":"sessionAccessToken","content":[{"type":"paragraph","inlineContent":[{"text":"Session info access token retrieved from Facebook.","type":"text"}]}]},{"name":"profile","content":[{"inlineContent":[{"type":"text","text":"The user profile data retrieved from Facebook."}],"type":"paragraph"}]},{"name":"audience","content":[{"inlineContent":[{"text":"API Identifier that your application is requesting access to.","type":"text"}],"type":"paragraph"}]},{"name":"scope","content":[{"inlineContent":[{"text":"Space-separated list of requested scope values. Defaults to ","type":"text"},{"type":"codeVoice","code":"openid profile email"},{"text":".","type":"text"}],"type":"paragraph"}]}]},{"kind":"content","content":[{"level":2,"text":"Return Value","anchor":"return-value","type":"heading"},{"inlineContent":[{"text":"A request that will yield Auth0 user’s credentials.","type":"text"}],"type":"paragraph"}]},{"kind":"content","content":[{"text":"Usage","level":2,"type":"heading","anchor":"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"},{"inlineContent":[{"text":"You can also specify audience (the Auth0 API identifier) and scope values:","type":"text"}],"type":"paragraph"},{"syntax":"swift","code":["Auth0"," .authentication()"," .login(facebookSessionAccessToken: \"session-info-access-token\","," profile: [\"key\": \"value\"],"," audience: \"https:\/\/example.com\/api\","," scope: \"openid profile email offline_access\")"," .start { print($0) }"],"type":"codeListing"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"sections":[],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication\/token-exchange-for-native-social\/token-exchange-native-social"],"anchor":"Related-Documentation"}],"variants":[{"paths":["\/documentation\/auth0\/authentication\/login(facebooksessionaccesstoken:profile:audience:scope:)-28ncj"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","metadata":{"externalID":"s:5Auth014AuthenticationPAAE5login26facebookSessionAccessToken7profile8audience5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_SDySSypGSSSgSStF","modules":[{"name":"Auth0"}],"roleHeading":"Instance Method","symbolKind":"method","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"kind":"externalParam","text":"facebookSessionAccessToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"profile"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"extendedModule":"Auth0","title":"login(facebookSessionAccessToken:profile:audience:scope:)"},"schemaVersion":{"minor":3,"patch":0,"major":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(facebookSessionAccessToken:profile:audience:scope:)-28ncj","interfaceLanguage":"swift"},"references":{"https://auth0.com/docs/api/authentication":{"titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","title":"Auth0 Authentication API"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"type":"topic","role":"symbol","title":"Authentication","abstract":[{"text":"Client for the ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"text":".","type":"text"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"url":"\/documentation\/auth0\/credentials","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"role":"symbol","type":"topic","abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/request","kind":"symbol","abstract":[{"type":"text","text":"Auth0 API request."}]},"https://developers.facebook.com/docs/facebook-login/access-tokens/session-info-access-token/":{"titleInlineContent":[{"type":"text","text":"session info access token"}],"url":"https:\/\/developers.facebook.com\/docs\/facebook-login\/access-tokens\/session-info-access-token\/","type":"link","identifier":"https:\/\/developers.facebook.com\/docs\/facebook-login\/access-tokens\/session-info-access-token\/","title":"session info access token"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(facebookSessionAccessToken:profile:audience:scope:)-28ncj":{"kind":"symbol","role":"symbol","url":"\/documentation\/auth0\/authentication\/login(facebooksessionaccesstoken:profile:audience:scope:)-28ncj","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"kind":"externalParam","text":"facebookSessionAccessToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"profile"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(facebookSessionAccessToken:profile:audience:scope:)-28ncj","abstract":[{"text":"Logs a user in with their Facebook ","type":"text"},{"isActive":true,"identifier":"https:\/\/developers.facebook.com\/docs\/facebook-login\/access-tokens\/session-info-access-token\/","type":"reference"},{"text":" and profile data.","type":"text"}],"type":"topic","title":"login(facebookSessionAccessToken:profile:audience:scope:)"},"https://auth0.com/docs/api/authentication/token-exchange-for-native-social/token-exchange-native-social":{"titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication\/token-exchange-for-native-social\/token-exchange-native-social","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/token-exchange-for-native-social\/token-exchange-native-social","title":"Authentication API Endpoint"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/login(facebooksessionaccesstoken:profile:audience:scope:)-28ncj"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"abstract":[{"type":"text","text":"Logs a user in 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."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"facebookSessionAccessToken","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"sessionAccessToken","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"profile","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"], ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"? = nil, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" = defaultScope) -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"},{"text":"<","kind":"text"},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"},{"text":", ","kind":"text"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"},{"text":">","kind":"text"}]}]},{"kind":"parameters","parameters":[{"name":"sessionAccessToken","content":[{"inlineContent":[{"type":"text","text":"Session info access token retrieved from Facebook."}],"type":"paragraph"}]},{"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"}]},{"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"}]}]},{"content":[{"anchor":"return-value","type":"heading","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","level":2,"text":"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"},{"inlineContent":[{"text":"You can also specify audience (the Auth0 API identifier) and scope values:","type":"text"}],"type":"paragraph"},{"type":"codeListing","code":["Auth0"," .authentication()"," .login(facebookSessionAccessToken: \"session-info-access-token\","," profile: [\"key\": \"value\"],"," audience: \"https:\/\/example.com\/api\","," scope: \"openid profile email offline_access\")"," .start { print($0) }"],"syntax":"swift"}],"kind":"content"}],"schemaVersion":{"minor":3,"patch":0,"major":0},"kind":"symbol","sections":[],"seeAlsoSections":[{"title":"Related Documentation","anchor":"Related-Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication\/token-exchange-for-native-social\/token-exchange-native-social"]}],"metadata":{"externalID":"s:5Auth014AuthenticationPAAE5login26facebookSessionAccessToken7profile8audience5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_SDySSypGSSSgSStF","extendedModule":"Auth0","symbolKind":"method","title":"login(facebookSessionAccessToken:profile:audience:scope:)","role":"symbol","roleHeading":"Instance Method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"facebookSessionAccessToken","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"profile","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"], ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"kind":"text","text":">"}],"modules":[{"name":"Auth0"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(facebookSessionAccessToken:profile:audience:scope:)-28ncj","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"},"https://auth0.com/docs/api/authentication/token-exchange-for-native-social/token-exchange-native-social":{"title":"Authentication API Endpoint","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication\/token-exchange-for-native-social\/token-exchange-native-social","identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/token-exchange-for-native-social\/token-exchange-native-social","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"Credentials","kind":"identifier"}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","abstract":[{"type":"text","text":"Client for the "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","isActive":true},{"type":"text","text":"."}],"type":"topic","title":"Authentication","url":"\/documentation\/auth0\/authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(facebookSessionAccessToken:profile:audience:scope:)-28ncj":{"role":"symbol","title":"login(facebookSessionAccessToken:profile:audience:scope:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"kind":"externalParam","text":"facebookSessionAccessToken"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"profile"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","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","kind":"typeIdentifier","text":"AuthenticationError"},{"kind":"text","text":">"}],"abstract":[{"type":"text","text":"Logs a user in 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."}],"kind":"symbol","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"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"title":"Request","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"abstract":[{"text":"Auth0 API request.","type":"text"}],"url":"\/documentation\/auth0\/request","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"https://auth0.com/docs/api/authentication":{"title":"Auth0 Authentication API","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"link"},"https://developers.facebook.com/docs/facebook-login/access-tokens/session-info-access-token/":{"title":"session info access token","titleInlineContent":[{"type":"text","text":"session info access token"}],"url":"https:\/\/developers.facebook.com\/docs\/facebook-login\/access-tokens\/session-info-access-token\/","identifier":"https:\/\/developers.facebook.com\/docs\/facebook-login\/access-tokens\/session-info-access-token\/","type":"link"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authentication/login(facebooksessionaccesstoken:profile:audience:scope:).json b/docs/data/documentation/auth0/authentication/login(facebooksessionaccesstoken:profile:audience:scope:).json index 0e9baeea8..32e892ef7 100644 --- a/docs/data/documentation/auth0/authentication/login(facebooksessionaccesstoken:profile:audience:scope:).json +++ b/docs/data/documentation/auth0/authentication/login(facebooksessionaccesstoken:profile:audience:scope:).json @@ -1 +1 @@ -{"schemaVersion":{"minor":3,"major":0,"patch":0},"metadata":{"externalID":"s:5Auth014AuthenticationP5login26facebookSessionAccessToken7profile8audience5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_SDySSypGSSSgSStF","symbolKind":"method","role":"symbol","roleHeading":"Instance Method","title":"login(facebookSessionAccessToken:profile:audience:scope:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"facebookSessionAccessToken","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"profile","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"], ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"required":true,"modules":[{"name":"Auth0"}]},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"sections":[],"kind":"symbol","abstract":[{"type":"text","text":"Logs a user in with their Facebook "},{"type":"reference","isActive":true,"identifier":"https:\/\/developers.facebook.com\/docs\/facebook-login\/access-tokens\/session-info-access-token\/"},{"type":"text","text":" and profile data."}],"defaultImplementationsSections":[{"title":"Authentication Implementations","anchor":"Authentication-Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(facebookSessionAccessToken:profile:audience:scope:)-28ncj"]}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"facebookSessionAccessToken","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"sessionAccessToken","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"profile","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"], ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"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\/Credentials","text":"Credentials","kind":"typeIdentifier","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"}],"platforms":["iOS"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"sessionAccessToken","content":[{"type":"paragraph","inlineContent":[{"text":"Session info access token retrieved from Facebook.","type":"text"}]}]},{"name":"profile","content":[{"type":"paragraph","inlineContent":[{"text":"The user profile data retrieved from Facebook.","type":"text"}]}]},{"name":"audience","content":[{"inlineContent":[{"text":"API Identifier that your application is requesting access to.","type":"text"}],"type":"paragraph"}]},{"name":"scope","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Space-separated list of requested scope values. Defaults to "},{"type":"codeVoice","code":"openid profile email"},{"type":"text","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"}]},{"kind":"content","content":[{"level":2,"anchor":"Usage","text":"Usage","type":"heading"},{"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"},{"inlineContent":[{"type":"text","text":"You can also specify audience (the Auth0 API identifier) and scope values:"}],"type":"paragraph"},{"syntax":"swift","code":["Auth0"," .authentication()"," .login(facebookSessionAccessToken: \"session-info-access-token\","," profile: [\"key\": \"value\"],"," audience: \"https:\/\/example.com\/api\","," scope: \"openid profile email offline_access\")"," .start { print($0) }"],"type":"codeListing"}]}],"variants":[{"paths":["\/documentation\/auth0\/authentication\/login(facebooksessionaccesstoken:profile:audience:scope:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(facebookSessionAccessToken:profile:audience:scope:)","interfaceLanguage":"swift"},"seeAlsoSections":[{"title":"Related Documentation","anchor":"Related-Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication\/token-exchange-for-native-social\/token-exchange-native-social"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Request":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/request","kind":"symbol","abstract":[{"type":"text","text":"Auth0 API request."}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(facebookSessionAccessToken:profile:audience:scope:)":{"kind":"symbol","role":"symbol","url":"\/documentation\/auth0\/authentication\/login(facebooksessionaccesstoken:profile:audience:scope:)","defaultImplementations":1,"required":true,"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"facebookSessionAccessToken","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"profile","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"], ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(facebookSessionAccessToken:profile:audience:scope:)","abstract":[{"type":"text","text":"Logs a user in with their Facebook "},{"type":"reference","isActive":true,"identifier":"https:\/\/developers.facebook.com\/docs\/facebook-login\/access-tokens\/session-info-access-token\/"},{"type":"text","text":" and profile data."}],"type":"topic","title":"login(facebookSessionAccessToken:profile:audience:scope:)"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(facebookSessionAccessToken:profile:audience:scope:)-28ncj":{"kind":"symbol","role":"symbol","url":"\/documentation\/auth0\/authentication\/login(facebooksessionaccesstoken:profile:audience:scope:)-28ncj","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"kind":"externalParam","text":"facebookSessionAccessToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"profile"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(facebookSessionAccessToken:profile:audience:scope:)-28ncj","abstract":[{"text":"Logs a user in with their Facebook ","type":"text"},{"isActive":true,"identifier":"https:\/\/developers.facebook.com\/docs\/facebook-login\/access-tokens\/session-info-access-token\/","type":"reference"},{"text":" and profile data.","type":"text"}],"type":"topic","title":"login(facebookSessionAccessToken:profile:audience:scope:)"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"type":"topic","role":"symbol","title":"Authentication","abstract":[{"text":"Client for the ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"text":".","type":"text"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"https://developers.facebook.com/docs/facebook-login/access-tokens/session-info-access-token/":{"type":"link","title":"session info access token","titleInlineContent":[{"type":"text","text":"session info access token"}],"url":"https:\/\/developers.facebook.com\/docs\/facebook-login\/access-tokens\/session-info-access-token\/","identifier":"https:\/\/developers.facebook.com\/docs\/facebook-login\/access-tokens\/session-info-access-token\/"},"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","type":"link","title":"Auth0 Authentication API"},"https://auth0.com/docs/api/authentication/token-exchange-for-native-social/token-exchange-native-social":{"type":"link","title":"Authentication API Endpoint","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication\/token-exchange-for-native-social\/token-exchange-native-social","identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/token-exchange-for-native-social\/token-exchange-native-social"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"url":"\/documentation\/auth0\/credentials","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"role":"symbol","type":"topic","abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}]}}} \ No newline at end of file +{"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"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"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"profile"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"},{"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":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"},{"kind":"text","text":">"}]}],"kind":"declarations"},{"parameters":[{"content":[{"inlineContent":[{"type":"text","text":"Session info access token retrieved from Facebook."}],"type":"paragraph"}],"name":"sessionAccessToken"},{"content":[{"inlineContent":[{"type":"text","text":"The user profile data retrieved from Facebook."}],"type":"paragraph"}],"name":"profile"},{"content":[{"inlineContent":[{"type":"text","text":"API Identifier that your application is requesting access to."}],"type":"paragraph"}],"name":"audience"},{"content":[{"inlineContent":[{"type":"text","text":"Space-separated list of requested scope values. Defaults to "},{"type":"codeVoice","code":"openid profile email"},{"type":"text","text":"."}],"type":"paragraph"}],"name":"scope"}],"kind":"parameters"},{"content":[{"level":2,"type":"heading","anchor":"return-value","text":"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"},{"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:"}]},{"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) }"]}],"kind":"content"}],"sections":[],"abstract":[{"type":"text","text":"Logs a user in with their Facebook "},{"identifier":"https:\/\/developers.facebook.com\/docs\/facebook-login\/access-tokens\/session-info-access-token\/","type":"reference","isActive":true},{"type":"text","text":" and profile data."}],"kind":"symbol","defaultImplementationsSections":[{"title":"Authentication Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(facebookSessionAccessToken:profile:audience:scope:)-28ncj"],"anchor":"Authentication-Implementations"}],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication\/token-exchange-for-native-social\/token-exchange-native-social"],"anchor":"Related-Documentation"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/login(facebooksessionaccesstoken:profile:audience:scope:)"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(facebookSessionAccessToken:profile:audience:scope:)","interfaceLanguage":"swift"},"metadata":{"role":"symbol","title":"login(facebookSessionAccessToken:profile:audience:scope:)","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"kind":"externalParam","text":"facebookSessionAccessToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"profile"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"externalID":"s:5Auth014AuthenticationP5login26facebookSessionAccessToken7profile8audience5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_SDySSypGSSSgSStF","roleHeading":"Instance Method","required":true,"symbolKind":"method"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"},"https://auth0.com/docs/api/authentication/token-exchange-for-native-social/token-exchange-native-social":{"title":"Authentication API Endpoint","url":"https:\/\/auth0.com\/docs\/api\/authentication\/token-exchange-for-native-social\/token-exchange-native-social","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/token-exchange-for-native-social\/token-exchange-native-social","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","abstract":[{"type":"text","text":"Client for the "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","isActive":true},{"type":"text","text":"."}],"type":"topic","title":"Authentication","url":"\/documentation\/auth0\/authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"Credentials","kind":"identifier"}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(facebookSessionAccessToken:profile:audience:scope:)-28ncj":{"role":"symbol","title":"login(facebookSessionAccessToken:profile:audience:scope:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"kind":"externalParam","text":"facebookSessionAccessToken"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"profile"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","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","kind":"typeIdentifier","text":"AuthenticationError"},{"kind":"text","text":">"}],"abstract":[{"type":"text","text":"Logs a user in 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."}],"kind":"symbol","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"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"title":"Request","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"abstract":[{"text":"Auth0 API request.","type":"text"}],"url":"\/documentation\/auth0\/request","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(facebookSessionAccessToken:profile:audience:scope:)":{"role":"symbol","title":"login(facebookSessionAccessToken:profile:audience:scope:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"kind":"externalParam","text":"facebookSessionAccessToken"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"profile"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","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","kind":"typeIdentifier","text":"AuthenticationError"},{"kind":"text","text":">"}],"abstract":[{"type":"text","text":"Logs a user in 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."}],"kind":"symbol","defaultImplementations":1,"url":"\/documentation\/auth0\/authentication\/login(facebooksessionaccesstoken:profile:audience:scope:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(facebookSessionAccessToken:profile:audience:scope:)","required":true,"type":"topic"},"https://auth0.com/docs/api/authentication":{"title":"Auth0 Authentication API","url":"https:\/\/auth0.com\/docs\/api\/authentication","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}]},"https://developers.facebook.com/docs/facebook-login/access-tokens/session-info-access-token/":{"title":"session info access token","url":"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"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authentication/login(passkey:challenge:connection:audience:scope:organization:)-1gm8k.json b/docs/data/documentation/auth0/authentication/login(passkey:challenge:connection:audience:scope:organization:)-1gm8k.json index 661d5dfdb..1c7c1dfb8 100644 --- a/docs/data/documentation/auth0/authentication/login(passkey:challenge:connection:audience:scope:organization:)-1gm8k.json +++ b/docs/data/documentation/auth0/authentication/login(passkey:challenge:connection:audience:scope:organization:)-1gm8k.json @@ -1 +1 @@ -{"defaultImplementationsSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(passkey:challenge:connection:audience:scope:organization:)-59b3j","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(passkey:challenge:connection:audience:scope:organization:)-4e7pl"],"title":"Authentication Implementations","anchor":"Authentication-Implementations"}],"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/native-passkeys-api#authenticate-existing-user","https:\/\/auth0.com\/docs\/native-passkeys-for-mobile-applications","https:\/\/developer.apple.com\/documentation\/authenticationservices\/supporting-passkeys#Connect-to-a-service-with-an-existing-account"],"title":"Related Documentation","anchor":"Related-Documentation"}],"sections":[],"schemaVersion":{"minor":3,"major":0,"patch":0},"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(passkey:challenge:connection:audience:scope:organization:)-1gm8k","interfaceLanguage":"swift"},"metadata":{"platforms":[{"unavailable":false,"introducedAt":"16.6","deprecated":false,"name":"iOS","beta":false},{"unavailable":false,"introducedAt":"16.6","deprecated":false,"name":"iPadOS","beta":false},{"unavailable":false,"introducedAt":"16.6","deprecated":false,"name":"Mac Catalyst","beta":false},{"unavailable":false,"introducedAt":"13.5","deprecated":false,"name":"macOS","beta":false},{"unavailable":false,"introducedAt":"1.0","deprecated":false,"name":"visionOS","beta":false}],"title":"login(passkey:challenge:connection:audience:scope:organization:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"kind":"externalParam","text":"passkey"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth012LoginPasskeyP","kind":"typeIdentifier","text":"LoginPasskey"},{"kind":"text","text":", "},{"kind":"externalParam","text":"challenge"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth021PasskeyLoginChallengeV","kind":"typeIdentifier","text":"PasskeyLoginChallenge"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"organization"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","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","kind":"typeIdentifier","text":"AuthenticationError"},{"kind":"text","text":">"}],"required":true,"role":"symbol","externalID":"s:5Auth014AuthenticationP5login7passkey9challenge10connection8audience5scope12organizationAA7RequestVyAA11CredentialsCAA0B5ErrorVGAA12LoginPasskey_p_AA0nM9ChallengeVSSSgAUSSAUtF","modules":[{"name":"Auth0"}],"symbolKind":"method","roleHeading":"Instance Method"},"abstract":[{"type":"text","text":"Logs a user in using an existing passkey credential and the login challenge. This is the last part of the passkey login flow."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"passkey","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth012LoginPasskeyP","text":"LoginPasskey","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey"},{"text":", ","kind":"text"},{"text":"challenge","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth021PasskeyLoginChallengeV","text":"PasskeyLoginChallenge","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"organization","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"},{"text":">","kind":"text"}],"platforms":["iOS"]}]},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"type":"text","text":"The existing passkey credential obtained from the "},{"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","isActive":true},{"type":"text","text":" delegate."}],"type":"paragraph"}],"name":"passkey"},{"content":[{"inlineContent":[{"text":"The passkey challenge obtained from ","type":"text"},{"code":"passkeyLoginChallenge(connection:)","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"}],"name":"challenge"},{"content":[{"inlineContent":[{"type":"text","text":"Name of the database connection. If a connection name is not specified, your tenant’s default directory will be used."}],"type":"paragraph"}],"name":"connection"},{"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":"audience"},{"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"}]}],"name":"scope"},{"content":[{"inlineContent":[{"text":"Identifier of an organization the user is a member of.","type":"text"}],"type":"paragraph"}],"name":"organization"}]},{"kind":"content","content":[{"text":"Return Value","anchor":"return-value","level":2,"type":"heading"},{"inlineContent":[{"type":"text","text":"A request that will yield Auth0 user’s credentials."}],"type":"paragraph"}]},{"kind":"content","content":[{"anchor":"Availability","text":"Availability","level":2,"type":"heading"},{"inlineContent":[{"type":"text","text":"This feature is currently available in"},{"type":"text","text":" "},{"type":"reference","isActive":true,"identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access"},{"type":"text","text":"."},{"type":"text","text":" "},{"type":"text","text":"Please reach out to Auth0 support to get it enabled for your tenant."}],"type":"paragraph"},{"anchor":"Usage","text":"Usage","level":2,"type":"heading"},{"syntax":"swift","code":["Auth0"," .authentication()"," .login(passkey: loginPasskey,"," challenge: loginChallenge,"," connection: \"Username-Password-Authentication\")"," .start { result in"," switch result {"," case .success(let credentials):"," print(\"Obtained credentials: \\(credentials)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"],"type":"codeListing"},{"inlineContent":[{"text":"You can also specify audience (the Auth0 API identifier) and scope values:","type":"text"}],"type":"paragraph"},{"syntax":"swift","code":["Auth0"," .authentication()"," .login(passkey: loginPasskey,"," challenge: loginChallenge,"," connection: \"Username-Password-Authentication\","," audience: \"https:\/\/example.com\/api\","," scope: \"openid profile email offline_access\","," organization: \"org_aaAA1aa11aAAAA1a\")"," .start { print($0) }"],"type":"codeListing"}]}],"variants":[{"paths":["\/documentation\/auth0\/authentication\/login(passkey:challenge:connection:audience:scope:organization:)-1gm8k"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Request":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/request","kind":"symbol","abstract":[{"type":"text","text":"Auth0 API request."}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"https://developer.apple.com/documentation/authenticationservices/supporting-passkeys#Connect-to-a-service-with-an-existing-account":{"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/supporting-passkeys#Connect-to-a-service-with-an-existing-account","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/supporting-passkeys#Connect-to-a-service-with-an-existing-account","title":"Supporting passkeys","titleInlineContent":[{"type":"text","text":"Supporting passkeys"}],"type":"link"},"https://developer.apple.com/documentation/authenticationservices/asauthorizationcontrollerdelegate":{"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","title":"ASAuthorizationControllerDelegate","titleInlineContent":[{"type":"codeVoice","code":"ASAuthorizationControllerDelegate"}],"type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"url":"\/documentation\/auth0\/credentials","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"role":"symbol","type":"topic","abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(passkey:challenge:connection:audience:scope:organization:)-59b3j":{"role":"symbol","title":"login(passkey:challenge:connection:audience:scope:organization:)","url":"\/documentation\/auth0\/authentication\/login(passkey:challenge:connection:audience:scope:organization:)-59b3j","type":"topic","abstract":[{"type":"text","text":"Logs a new user in using a signup passkey credential and the signup challenge. This is the last part of the passkey signup flow."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(passkey:challenge:connection:audience:scope:organization:)-59b3j","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"passkey","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth013SignupPasskeyP","text":"SignupPasskey","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"challenge","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth022PasskeySignupChallengeV","text":"PasskeySignupChallenge","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"organization","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyLoginChallenge":{"title":"PasskeyLoginChallenge","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasskeyLoginChallenge"}],"navigatorTitle":[{"kind":"identifier","text":"PasskeyLoginChallenge"}],"abstract":[{"text":"A passkey login challenge.","type":"text"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge","url":"\/documentation\/auth0\/passkeyloginchallenge","type":"topic"},"https://auth0.com/docs/api/authentication":{"url":"https:\/\/auth0.com\/docs\/api\/authentication","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","title":"Auth0 Authentication API","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"type":"link"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"https://auth0.com/docs/native-passkeys-for-mobile-applications":{"url":"https:\/\/auth0.com\/docs\/native-passkeys-for-mobile-applications","identifier":"https:\/\/auth0.com\/docs\/native-passkeys-for-mobile-applications","title":"Native Passkeys for Mobile Applications","titleInlineContent":[{"type":"text","text":"Native Passkeys for Mobile Applications"}],"type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(passkey:challenge:connection:audience:scope:organization:)-4e7pl":{"abstract":[{"type":"text","text":"Logs a user in using an existing passkey credential and the login challenge. This is the last part of the passkey login flow."}],"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"kind":"externalParam","text":"passkey"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth012LoginPasskeyP","kind":"typeIdentifier","text":"LoginPasskey"},{"kind":"text","text":", "},{"kind":"externalParam","text":"challenge"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth021PasskeyLoginChallengeV","kind":"typeIdentifier","text":"PasskeyLoginChallenge"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"organization"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","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","kind":"typeIdentifier","text":"AuthenticationError"},{"kind":"text","text":">"}],"url":"\/documentation\/auth0\/authentication\/login(passkey:challenge:connection:audience:scope:organization:)-4e7pl","title":"login(passkey:challenge:connection:audience:scope:organization:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(passkey:challenge:connection:audience:scope:organization:)-4e7pl","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"type":"topic","role":"symbol","title":"Authentication","abstract":[{"text":"Client for the ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"text":".","type":"text"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access":{"url":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","title":"Early Access","titleInlineContent":[{"type":"text","text":"Early Access"}],"type":"link"},"https://developer.apple.com/documentation/authenticationservices/asauthorizationplatformpublickeycredentialassertion":{"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialassertion","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialassertion","title":"ASAuthorizationPlatformPublicKeyCredentialAssertion","titleInlineContent":[{"type":"codeVoice","code":"ASAuthorizationPlatformPublicKeyCredentialAssertion"}],"type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/LoginPasskey":{"role":"symbol","url":"\/documentation\/auth0\/loginpasskey","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"LoginPasskey"}],"navigatorTitle":[{"kind":"identifier","text":"LoginPasskey"}],"title":"LoginPasskey","abstract":[{"type":"text","text":"The login passkey credential obtained from the "},{"isActive":true,"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate"},{"type":"text","text":" delegate."},{"type":"text","text":" "},{"type":"text","text":"Contains the subset of relevant properties from "},{"isActive":true,"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialassertion"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey"},"https://auth0.com/docs/native-passkeys-api#authenticate-existing-user":{"url":"https:\/\/auth0.com\/docs\/native-passkeys-api#authenticate-existing-user","identifier":"https:\/\/auth0.com\/docs\/native-passkeys-api#authenticate-existing-user","title":"Authentication API Endpoint","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(passkey:challenge:connection:audience:scope:organization:)-1gm8k":{"role":"symbol","abstract":[{"type":"text","text":"Logs a user in using an existing passkey credential and the login challenge. This is the last part of the passkey login flow."}],"title":"login(passkey:challenge:connection:audience:scope:organization:)","defaultImplementations":2,"required":true,"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(passkey:challenge:connection:audience:scope:organization:)-1gm8k","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"passkey","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth012LoginPasskeyP","text":"LoginPasskey","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"challenge","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth021PasskeyLoginChallengeV","text":"PasskeyLoginChallenge","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"organization","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"url":"\/documentation\/auth0\/authentication\/login(passkey:challenge:connection:audience:scope:organization:)-1gm8k","type":"topic"}}} \ No newline at end of file +{"sections":[],"metadata":{"platforms":[{"name":"iOS","deprecated":false,"introducedAt":"16.6","beta":false,"unavailable":false},{"name":"iPadOS","deprecated":false,"introducedAt":"16.6","beta":false,"unavailable":false},{"name":"Mac Catalyst","deprecated":false,"introducedAt":"16.6","beta":false,"unavailable":false},{"name":"macOS","deprecated":false,"introducedAt":"13.5","beta":false,"unavailable":false},{"name":"visionOS","deprecated":false,"introducedAt":"1.0","beta":false,"unavailable":false}],"symbolKind":"method","title":"login(passkey:challenge:connection:audience:scope:organization:)","roleHeading":"Instance Method","externalID":"s:5Auth014AuthenticationP5login7passkey9challenge10connection8audience5scope12organizationAA7RequestVyAA11CredentialsCAA0B5ErrorVGAA12LoginPasskey_p_AA0nM9ChallengeVSSSgAUSSAUtF","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"kind":"externalParam","text":"passkey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012LoginPasskeyP","text":"LoginPasskey"},{"kind":"text","text":", "},{"kind":"externalParam","text":"challenge"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth021PasskeyLoginChallengeV","text":"PasskeyLoginChallenge"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"kind":"text","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":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"organization"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","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":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"role":"symbol","required":true},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(passkey:challenge:connection:audience:scope:organization:)-1gm8k","interfaceLanguage":"swift"},"kind":"symbol","seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/native-passkeys-api#authenticate-existing-user","https:\/\/auth0.com\/docs\/native-passkeys-for-mobile-applications","https:\/\/developer.apple.com\/documentation\/authenticationservices\/supporting-passkeys#Connect-to-a-service-with-an-existing-account"],"title":"Related Documentation","anchor":"Related-Documentation"}],"defaultImplementationsSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(passkey:challenge:connection:audience:scope:organization:)-4e7pl","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(passkey:challenge:connection:audience:scope:organization:)-59b3j"],"title":"Authentication Implementations","anchor":"Authentication-Implementations"}],"variants":[{"paths":["\/documentation\/auth0\/authentication\/login(passkey:challenge:connection:audience:scope:organization:)-1gm8k"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"kind":"externalParam","text":"passkey"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth012LoginPasskeyP","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey","kind":"typeIdentifier","text":"LoginPasskey"},{"kind":"text","text":", "},{"kind":"externalParam","text":"challenge"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth021PasskeyLoginChallengeV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge","kind":"typeIdentifier","text":"PasskeyLoginChallenge"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"organization"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?) -> "},{"preciseIdentifier":"s:5Auth07RequestV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier","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":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","kind":"typeIdentifier","text":"AuthenticationError"},{"kind":"text","text":">"}]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"type":"text","text":"The existing passkey credential obtained from the "},{"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","isActive":true},{"type":"text","text":" delegate."}],"type":"paragraph"}],"name":"passkey"},{"content":[{"inlineContent":[{"type":"text","text":"The passkey challenge obtained from "},{"type":"codeVoice","code":"passkeyLoginChallenge(connection:)"},{"type":"text","text":"."}],"type":"paragraph"}],"name":"challenge"},{"content":[{"inlineContent":[{"type":"text","text":"Name of the database connection. If a connection name is not specified, your tenant’s default directory will be used."}],"type":"paragraph"}],"name":"connection"},{"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":"audience"},{"content":[{"inlineContent":[{"type":"text","text":"Space-separated list of requested scope values. Defaults to "},{"type":"codeVoice","code":"openid profile email"},{"type":"text","text":"."}],"type":"paragraph"}],"name":"scope"},{"content":[{"inlineContent":[{"type":"text","text":"Identifier of an organization the user is a member of."}],"type":"paragraph"}],"name":"organization"}]},{"kind":"content","content":[{"level":2,"type":"heading","anchor":"return-value","text":"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":"Availability","text":"Availability"},{"type":"paragraph","inlineContent":[{"type":"text","text":"This feature is currently available in"},{"type":"text","text":" "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","isActive":true},{"type":"text","text":"."},{"type":"text","text":" "},{"type":"text","text":"Please reach out to Auth0 support to get it enabled for your tenant."}]},{"level":2,"type":"heading","anchor":"Usage","text":"Usage"},{"type":"codeListing","syntax":"swift","code":["Auth0"," .authentication()"," .login(passkey: loginPasskey,"," challenge: loginChallenge,"," connection: \"Username-Password-Authentication\")"," .start { result in"," switch result {"," case .success(let credentials):"," print(\"Obtained credentials: \\(credentials)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"]},{"type":"paragraph","inlineContent":[{"type":"text","text":"You can also specify audience (the Auth0 API identifier) and scope values:"}]},{"type":"codeListing","syntax":"swift","code":["Auth0"," .authentication()"," .login(passkey: loginPasskey,"," challenge: loginChallenge,"," connection: \"Username-Password-Authentication\","," audience: \"https:\/\/example.com\/api\","," scope: \"openid profile email offline_access\","," organization: \"org_aaAA1aa11aAAAA1a\")"," .start { print($0) }"]}]}],"abstract":[{"type":"text","text":"Logs a user in using an existing passkey credential and the login challenge. This is the last part of the passkey login flow."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"Credentials","kind":"identifier"}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}]},"https://developer.apple.com/documentation/authenticationservices/asauthorizationplatformpublickeycredentialassertion":{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialassertion","url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialassertion","titleInlineContent":[{"type":"codeVoice","code":"ASAuthorizationPlatformPublicKeyCredentialAssertion"}],"type":"link","title":"ASAuthorizationPlatformPublicKeyCredentialAssertion"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/LoginPasskey":{"title":"LoginPasskey","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"LoginPasskey"}],"abstract":[{"text":"The login passkey credential obtained from the ","type":"text"},{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","isActive":true,"type":"reference"},{"text":" delegate.","type":"text"},{"text":" ","type":"text"},{"text":"Contains the subset of relevant properties from ","type":"text"},{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialassertion","isActive":true,"type":"reference"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/loginpasskey","navigatorTitle":[{"kind":"identifier","text":"LoginPasskey"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(passkey:challenge:connection:audience:scope:organization:)-59b3j":{"role":"symbol","title":"login(passkey:challenge:connection:audience:scope:organization:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"kind":"externalParam","text":"passkey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"SignupPasskey","preciseIdentifier":"s:5Auth013SignupPasskeyP"},{"kind":"text","text":", "},{"kind":"externalParam","text":"challenge"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth022PasskeySignupChallengeV","kind":"typeIdentifier","text":"PasskeySignupChallenge"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"organization"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?) -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"abstract":[{"type":"text","text":"Logs a new user in using a signup passkey credential and the signup challenge. This is the last part of the passkey signup flow."}],"kind":"symbol","url":"\/documentation\/auth0\/authentication\/login(passkey:challenge:connection:audience:scope:organization:)-59b3j","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(passkey:challenge:connection:audience:scope:organization:)-59b3j","type":"topic"},"https://developer.apple.com/documentation/authenticationservices/asauthorizationcontrollerdelegate":{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","titleInlineContent":[{"type":"codeVoice","code":"ASAuthorizationControllerDelegate"}],"type":"link","title":"ASAuthorizationControllerDelegate"},"https://auth0.com/docs/native-passkeys-api#authenticate-existing-user":{"identifier":"https:\/\/auth0.com\/docs\/native-passkeys-api#authenticate-existing-user","url":"https:\/\/auth0.com\/docs\/native-passkeys-api#authenticate-existing-user","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"type":"link","title":"Authentication API Endpoint"},"https://developer.apple.com/documentation/authenticationservices/supporting-passkeys#Connect-to-a-service-with-an-existing-account":{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/supporting-passkeys#Connect-to-a-service-with-an-existing-account","url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/supporting-passkeys#Connect-to-a-service-with-an-existing-account","titleInlineContent":[{"type":"text","text":"Supporting passkeys"}],"type":"link","title":"Supporting passkeys"},"https://auth0.com/docs/api/authentication":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","url":"https:\/\/auth0.com\/docs\/api\/authentication","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"type":"link","title":"Auth0 Authentication API"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyLoginChallenge":{"title":"PasskeyLoginChallenge","role":"symbol","navigatorTitle":[{"text":"PasskeyLoginChallenge","kind":"identifier"}],"kind":"symbol","abstract":[{"text":"A passkey login challenge.","type":"text"}],"url":"\/documentation\/auth0\/passkeyloginchallenge","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"PasskeyLoginChallenge"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(passkey:challenge:connection:audience:scope:organization:)-4e7pl":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(passkey:challenge:connection:audience:scope:organization:)-4e7pl","kind":"symbol","title":"login(passkey:challenge:connection:audience:scope:organization:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"passkey","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"LoginPasskey","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012LoginPasskeyP"},{"text":", ","kind":"text"},{"text":"challenge","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"PasskeyLoginChallenge","kind":"typeIdentifier","preciseIdentifier":"s:5Auth021PasskeyLoginChallengeV"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"organization","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?) -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"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"}],"role":"symbol","url":"\/documentation\/auth0\/authentication\/login(passkey:challenge:connection:audience:scope:organization:)-4e7pl","abstract":[{"type":"text","text":"Logs a user in using an existing passkey credential and the login challenge. This is the last part of the passkey login flow."}],"type":"topic"},"https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access":{"title":"Early Access","url":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","type":"link","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","titleInlineContent":[{"type":"text","text":"Early Access"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(passkey:challenge:connection:audience:scope:organization:)-1gm8k":{"defaultImplementations":2,"type":"topic","title":"login(passkey:challenge:connection:audience:scope:organization:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(passkey:challenge:connection:audience:scope:organization:)-1gm8k","kind":"symbol","abstract":[{"type":"text","text":"Logs a user in using an existing passkey credential and the login challenge. This is the last part of the passkey login flow."}],"url":"\/documentation\/auth0\/authentication\/login(passkey:challenge:connection:audience:scope:organization:)-1gm8k","required":true,"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"login"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"passkey"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012LoginPasskeyP","text":"LoginPasskey"},{"text":", ","kind":"text"},{"text":"challenge","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"PasskeyLoginChallenge","kind":"typeIdentifier","preciseIdentifier":"s:5Auth021PasskeyLoginChallengeV"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"organization"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?) -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"text":">","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"https://auth0.com/docs/native-passkeys-for-mobile-applications":{"title":"Native Passkeys for Mobile Applications","url":"https:\/\/auth0.com\/docs\/native-passkeys-for-mobile-applications","type":"link","identifier":"https:\/\/auth0.com\/docs\/native-passkeys-for-mobile-applications","titleInlineContent":[{"type":"text","text":"Native Passkeys for Mobile Applications"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"title":"Request","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"abstract":[{"text":"Auth0 API request.","type":"text"}],"url":"\/documentation\/auth0\/request","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","abstract":[{"type":"text","text":"Client for the "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","isActive":true},{"type":"text","text":"."}],"type":"topic","title":"Authentication","url":"\/documentation\/auth0\/authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authentication/login(passkey:challenge:connection:audience:scope:organization:)-340n2.json b/docs/data/documentation/auth0/authentication/login(passkey:challenge:connection:audience:scope:organization:)-340n2.json index 2894c46c0..f31724a49 100644 --- a/docs/data/documentation/auth0/authentication/login(passkey:challenge:connection:audience:scope:organization:)-340n2.json +++ b/docs/data/documentation/auth0/authentication/login(passkey:challenge:connection:audience:scope:organization:)-340n2.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"sections":[],"schemaVersion":{"major":0,"patch":0,"minor":3},"abstract":[{"type":"text","text":"Logs a new user in using a signup passkey credential and the signup challenge. This is the last part of the passkey signup flow."}],"defaultImplementationsSections":[{"title":"Authentication Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(passkey:challenge:connection:audience:scope:organization:)-59b3j","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(passkey:challenge:connection:audience:scope:organization:)-4e7pl"],"anchor":"Authentication-Implementations"}],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/native-passkeys-api#authenticate-new-user","https:\/\/auth0.com\/docs\/native-passkeys-for-mobile-applications","https:\/\/developer.apple.com\/documentation\/authenticationservices\/supporting-passkeys#Register-a-new-account-on-a-service"],"anchor":"Related-Documentation"}],"primaryContentSections":[{"declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"passkey","kind":"externalParam"},{"text":": ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SignupPasskey","text":"SignupPasskey","kind":"typeIdentifier","preciseIdentifier":"s:5Auth013SignupPasskeyP"},{"text":", ","kind":"text"},{"text":"challenge","kind":"externalParam"},{"text":": ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge","text":"PasskeySignupChallenge","kind":"typeIdentifier","preciseIdentifier":"s:5Auth022PasskeySignupChallengeV"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"organization","kind":"externalParam"},{"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\/Credentials","text":"Credentials","kind":"typeIdentifier","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"],"platforms":["iOS"]}],"kind":"declarations"},{"parameters":[{"name":"passkey","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The signup passkey credential obtained from the "},{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","type":"reference","isActive":true},{"type":"text","text":" delegate."}]}]},{"name":"challenge","content":[{"inlineContent":[{"text":"The passkey signup challenge obtained from ","type":"text"},{"code":"passkeySignupChallenge(email:phoneNumber:username:name:connection:)","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"}]},{"name":"connection","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Name of the database connection where the user will be created. If a connection name is not specified, your tenant’s default directory will be used."}]}]},{"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 "},{"code":"openid profile email","type":"codeVoice"},{"type":"text","text":"."}],"type":"paragraph"}]},{"name":"organization","content":[{"inlineContent":[{"text":"Identifier of an organization the user is a member of.","type":"text"}],"type":"paragraph"}]}],"kind":"parameters"},{"content":[{"text":"Return Value","level":2,"anchor":"return-value","type":"heading"},{"inlineContent":[{"type":"text","text":"A request that will yield Auth0 user’s credentials."}],"type":"paragraph"}],"kind":"content"},{"content":[{"type":"heading","text":"Availability","level":2,"anchor":"Availability"},{"type":"paragraph","inlineContent":[{"text":"This feature is currently available in","type":"text"},{"text":" ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","isActive":true,"type":"reference"},{"text":".","type":"text"},{"text":" ","type":"text"},{"text":"Please reach out to Auth0 support to get it enabled for your tenant.","type":"text"}]},{"type":"heading","text":"Usage","level":2,"anchor":"Usage"},{"type":"codeListing","code":["Auth0"," .authentication()"," .login(passkey: signupPasskey,"," challenge: signupChallenge,"," connection: \"Username-Password-Authentication\")"," .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","code":["Auth0"," .authentication()"," .login(passkey: signupPasskey,"," challenge: signupChallenge,"," connection: \"Username-Password-Authentication\","," audience: \"https:\/\/example.com\/api\","," scope: \"openid profile email offline_access\","," organization: \"org_aaAA1aa11aAAAA1a\")"," .start { print($0) }"],"syntax":"swift"}],"kind":"content"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(passkey:challenge:connection:audience:scope:organization:)-340n2"},"metadata":{"title":"login(passkey:challenge:connection:audience:scope:organization:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"passkey","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"SignupPasskey","preciseIdentifier":"s:5Auth013SignupPasskeyP","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"challenge","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"PasskeySignupChallenge","preciseIdentifier":"s:5Auth022PasskeySignupChallengeV","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"organization","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"roleHeading":"Instance Method","role":"symbol","required":true,"externalID":"s:5Auth014AuthenticationP5login7passkey9challenge10connection8audience5scope12organizationAA7RequestVyAA11CredentialsCAA0B5ErrorVGAA13SignupPasskey_p_AA0nM9ChallengeVSSSgAUSSAUtF","symbolKind":"method","modules":[{"name":"Auth0"}],"platforms":[{"introducedAt":"16.6","name":"iOS","beta":false,"deprecated":false,"unavailable":false},{"introducedAt":"16.6","name":"iPadOS","beta":false,"deprecated":false,"unavailable":false},{"introducedAt":"16.6","name":"Mac Catalyst","beta":false,"deprecated":false,"unavailable":false},{"introducedAt":"13.5","name":"macOS","beta":false,"deprecated":false,"unavailable":false},{"introducedAt":"1.0","name":"visionOS","beta":false,"deprecated":false,"unavailable":false}]},"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/authentication\/login(passkey:challenge:connection:audience:scope:organization:)-340n2"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(passkey:challenge:connection:audience:scope:organization:)-340n2":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"passkey","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"SignupPasskey","preciseIdentifier":"s:5Auth013SignupPasskeyP","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"challenge","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"PasskeySignupChallenge","preciseIdentifier":"s:5Auth022PasskeySignupChallengeV","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"organization","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"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"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"kind":"symbol","role":"symbol","defaultImplementations":2,"url":"\/documentation\/auth0\/authentication\/login(passkey:challenge:connection:audience:scope:organization:)-340n2","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(passkey:challenge:connection:audience:scope:organization:)-340n2","abstract":[{"text":"Logs a new user in using a signup passkey credential and the signup challenge. This is the last part of the passkey signup flow.","type":"text"}],"required":true,"type":"topic","title":"login(passkey:challenge:connection:audience:scope:organization:)"},"https://auth0.com/docs/native-passkeys-api#authenticate-new-user":{"url":"https:\/\/auth0.com\/docs\/native-passkeys-api#authenticate-new-user","title":"Authentication API Endpoint","type":"link","identifier":"https:\/\/auth0.com\/docs\/native-passkeys-api#authenticate-new-user","titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(passkey:challenge:connection:audience:scope:organization:)-59b3j":{"role":"symbol","title":"login(passkey:challenge:connection:audience:scope:organization:)","url":"\/documentation\/auth0\/authentication\/login(passkey:challenge:connection:audience:scope:organization:)-59b3j","type":"topic","abstract":[{"type":"text","text":"Logs a new user in using a signup passkey credential and the signup challenge. This is the last part of the passkey signup flow."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(passkey:challenge:connection:audience:scope:organization:)-59b3j","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"passkey","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth013SignupPasskeyP","text":"SignupPasskey","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"challenge","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth022PasskeySignupChallengeV","text":"PasskeySignupChallenge","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"organization","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/PasskeySignupChallenge":{"type":"topic","abstract":[{"type":"text","text":"A passkey signup challenge."}],"kind":"symbol","title":"PasskeySignupChallenge","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge","role":"symbol","url":"\/documentation\/auth0\/passkeysignupchallenge","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasskeySignupChallenge"}],"navigatorTitle":[{"kind":"identifier","text":"PasskeySignupChallenge"}]},"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"}]},"https://developer.apple.com/documentation/authenticationservices/asauthorizationplatformpublickeycredentialregistration":{"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialregistration","title":"ASAuthorizationPlatformPublicKeyCredentialRegistration","type":"link","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialregistration","titleInlineContent":[{"code":"ASAuthorizationPlatformPublicKeyCredentialRegistration","type":"codeVoice"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/request","kind":"symbol","abstract":[{"type":"text","text":"Auth0 API request."}]},"https://developer.apple.com/documentation/authenticationservices/asauthorizationcontrollerdelegate":{"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","title":"ASAuthorizationControllerDelegate","type":"link","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","titleInlineContent":[{"type":"codeVoice","code":"ASAuthorizationControllerDelegate"}]},"https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access":{"url":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","title":"Early Access","type":"link","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","titleInlineContent":[{"text":"Early Access","type":"text"}]},"https://auth0.com/docs/native-passkeys-for-mobile-applications":{"url":"https:\/\/auth0.com\/docs\/native-passkeys-for-mobile-applications","title":"Native Passkeys for Mobile Applications","type":"link","identifier":"https:\/\/auth0.com\/docs\/native-passkeys-for-mobile-applications","titleInlineContent":[{"text":"Native Passkeys for Mobile Applications","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/SignupPasskey":{"type":"topic","kind":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"SignupPasskey","kind":"identifier"}],"url":"\/documentation\/auth0\/signuppasskey","abstract":[{"type":"text","text":"The signup passkey credential obtained from the "},{"isActive":true,"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","type":"reference"},{"type":"text","text":" delegate."},{"type":"text","text":" "},{"type":"text","text":"Contains the subset of relevant properties from "},{"isActive":true,"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialregistration","type":"reference"},{"type":"text","text":"."}],"role":"symbol","navigatorTitle":[{"text":"SignupPasskey","kind":"identifier"}],"title":"SignupPasskey","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SignupPasskey"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"url":"\/documentation\/auth0\/credentials","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"role":"symbol","type":"topic","abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}]},"https://developer.apple.com/documentation/authenticationservices/supporting-passkeys#Register-a-new-account-on-a-service":{"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/supporting-passkeys#Register-a-new-account-on-a-service","title":"Supporting passkeys","type":"link","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/supporting-passkeys#Register-a-new-account-on-a-service","titleInlineContent":[{"text":"Supporting passkeys","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(passkey:challenge:connection:audience:scope:organization:)-4e7pl":{"abstract":[{"type":"text","text":"Logs a user in using an existing passkey credential and the login challenge. This is the last part of the passkey login flow."}],"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"kind":"externalParam","text":"passkey"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth012LoginPasskeyP","kind":"typeIdentifier","text":"LoginPasskey"},{"kind":"text","text":", "},{"kind":"externalParam","text":"challenge"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth021PasskeyLoginChallengeV","kind":"typeIdentifier","text":"PasskeyLoginChallenge"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"organization"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","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","kind":"typeIdentifier","text":"AuthenticationError"},{"kind":"text","text":">"}],"url":"\/documentation\/auth0\/authentication\/login(passkey:challenge:connection:audience:scope:organization:)-4e7pl","title":"login(passkey:challenge:connection:audience:scope:organization:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(passkey:challenge:connection:audience:scope:organization:)-4e7pl","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"type":"topic","role":"symbol","title":"Authentication","abstract":[{"text":"Client for the ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"text":".","type":"text"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]}}} \ No newline at end of file +{"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"kind":"externalParam","text":"passkey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth013SignupPasskeyP","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SignupPasskey","text":"SignupPasskey"},{"kind":"text","text":", "},{"kind":"externalParam","text":"challenge"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth022PasskeySignupChallengeV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge","text":"PasskeySignupChallenge"},{"kind":"text","text":", "},{"text":"connection","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"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","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"organization","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?) -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","text":"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":", "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"platforms":["iOS"],"languages":["swift"]}]},{"parameters":[{"name":"passkey","content":[{"inlineContent":[{"type":"text","text":"The signup passkey credential obtained from the "},{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","type":"reference","isActive":true},{"type":"text","text":" delegate."}],"type":"paragraph"}]},{"name":"challenge","content":[{"inlineContent":[{"type":"text","text":"The passkey signup challenge obtained from "},{"code":"passkeySignupChallenge(email:phoneNumber:username:name:connection:)","type":"codeVoice"},{"type":"text","text":"."}],"type":"paragraph"}]},{"name":"connection","content":[{"inlineContent":[{"type":"text","text":"Name of the database connection where the user will be created. If a connection name is not specified, your tenant’s default directory will be used."}],"type":"paragraph"}]},{"name":"audience","content":[{"inlineContent":[{"type":"text","text":"API Identifier that your application is requesting access to. Defaults to "},{"code":"nil","type":"codeVoice"},{"type":"text","text":"."}],"type":"paragraph"}]},{"name":"scope","content":[{"inlineContent":[{"type":"text","text":"Space-separated list of requested scope values. Defaults to "},{"code":"openid profile email","type":"codeVoice"},{"type":"text","text":"."}],"type":"paragraph"}]},{"name":"organization","content":[{"inlineContent":[{"type":"text","text":"Identifier of an organization the user is a member of."}],"type":"paragraph"}]}],"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"}]},{"kind":"content","content":[{"type":"heading","level":2,"text":"Availability","anchor":"Availability"},{"inlineContent":[{"type":"text","text":"This feature is currently available in"},{"type":"text","text":" "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access"},{"type":"text","text":"."},{"type":"text","text":" "},{"type":"text","text":"Please reach out to Auth0 support to get it enabled for your tenant."}],"type":"paragraph"},{"type":"heading","level":2,"text":"Usage","anchor":"Usage"},{"syntax":"swift","code":["Auth0"," .authentication()"," .login(passkey: signupPasskey,"," challenge: signupChallenge,"," connection: \"Username-Password-Authentication\")"," .start { result in"," switch result {"," case .success(let credentials):"," print(\"Obtained credentials: \\(credentials)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"],"type":"codeListing"},{"inlineContent":[{"type":"text","text":"You can also specify audience (the Auth0 API identifier) and scope values:"}],"type":"paragraph"},{"syntax":"swift","code":["Auth0"," .authentication()"," .login(passkey: signupPasskey,"," challenge: signupChallenge,"," connection: \"Username-Password-Authentication\","," audience: \"https:\/\/example.com\/api\","," scope: \"openid profile email offline_access\","," organization: \"org_aaAA1aa11aAAAA1a\")"," .start { print($0) }"],"type":"codeListing"}]}],"sections":[],"abstract":[{"type":"text","text":"Logs a new user in using a signup passkey credential and the signup challenge. This is the last part of the passkey signup flow."}],"kind":"symbol","defaultImplementationsSections":[{"title":"Authentication Implementations","anchor":"Authentication-Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(passkey:challenge:connection:audience:scope:organization:)-4e7pl","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(passkey:challenge:connection:audience:scope:organization:)-59b3j"]}],"seeAlsoSections":[{"title":"Related Documentation","anchor":"Related-Documentation","identifiers":["https:\/\/auth0.com\/docs\/native-passkeys-api#authenticate-new-user","https:\/\/auth0.com\/docs\/native-passkeys-for-mobile-applications","https:\/\/developer.apple.com\/documentation\/authenticationservices\/supporting-passkeys#Register-a-new-account-on-a-service"]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/login(passkey:challenge:connection:audience:scope:organization:)-340n2"]}],"metadata":{"role":"symbol","title":"login(passkey:challenge:connection:audience:scope:organization:)","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"kind":"externalParam","text":"passkey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"SignupPasskey","preciseIdentifier":"s:5Auth013SignupPasskeyP"},{"kind":"text","text":", "},{"kind":"externalParam","text":"challenge"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"PasskeySignupChallenge","preciseIdentifier":"s:5Auth022PasskeySignupChallengeV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"organization"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","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","kind":"typeIdentifier","text":"AuthenticationError"},{"kind":"text","text":">"}],"externalID":"s:5Auth014AuthenticationP5login7passkey9challenge10connection8audience5scope12organizationAA7RequestVyAA11CredentialsCAA0B5ErrorVGAA13SignupPasskey_p_AA0nM9ChallengeVSSSgAUSSAUtF","roleHeading":"Instance Method","required":true,"platforms":[{"deprecated":false,"introducedAt":"16.6","unavailable":false,"name":"iOS","beta":false},{"deprecated":false,"introducedAt":"16.6","unavailable":false,"name":"iPadOS","beta":false},{"deprecated":false,"introducedAt":"16.6","unavailable":false,"name":"Mac Catalyst","beta":false},{"deprecated":false,"introducedAt":"13.5","unavailable":false,"name":"macOS","beta":false},{"deprecated":false,"introducedAt":"1.0","unavailable":false,"name":"visionOS","beta":false}],"symbolKind":"method"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(passkey:challenge:connection:audience:scope:organization:)-340n2","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(passkey:challenge:connection:audience:scope:organization:)-4e7pl":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(passkey:challenge:connection:audience:scope:organization:)-4e7pl","kind":"symbol","title":"login(passkey:challenge:connection:audience:scope:organization:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"passkey","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"LoginPasskey","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012LoginPasskeyP"},{"text":", ","kind":"text"},{"text":"challenge","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"PasskeyLoginChallenge","kind":"typeIdentifier","preciseIdentifier":"s:5Auth021PasskeyLoginChallengeV"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"organization","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?) -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"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"}],"role":"symbol","url":"\/documentation\/auth0\/authentication\/login(passkey:challenge:connection:audience:scope:organization:)-4e7pl","abstract":[{"type":"text","text":"Logs a user in using an existing passkey credential and the login challenge. This is the last part of the passkey login flow."}],"type":"topic"},"https://developer.apple.com/documentation/authenticationservices/asauthorizationplatformpublickeycredentialregistration":{"title":"ASAuthorizationPlatformPublicKeyCredentialRegistration","type":"link","titleInlineContent":[{"code":"ASAuthorizationPlatformPublicKeyCredentialRegistration","type":"codeVoice"}],"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialregistration","url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialregistration"},"https://developer.apple.com/documentation/authenticationservices/supporting-passkeys#Register-a-new-account-on-a-service":{"title":"Supporting passkeys","type":"link","titleInlineContent":[{"type":"text","text":"Supporting passkeys"}],"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/supporting-passkeys#Register-a-new-account-on-a-service","url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/supporting-passkeys#Register-a-new-account-on-a-service"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"},"https://auth0.com/docs/native-passkeys-api#authenticate-new-user":{"title":"Authentication API Endpoint","type":"link","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"identifier":"https:\/\/auth0.com\/docs\/native-passkeys-api#authenticate-new-user","url":"https:\/\/auth0.com\/docs\/native-passkeys-api#authenticate-new-user"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeySignupChallenge":{"title":"PasskeySignupChallenge","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge","role":"symbol","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"PasskeySignupChallenge","kind":"identifier"}],"abstract":[{"text":"A passkey signup challenge.","type":"text"}],"url":"\/documentation\/auth0\/passkeysignupchallenge","navigatorTitle":[{"text":"PasskeySignupChallenge","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(passkey:challenge:connection:audience:scope:organization:)-340n2":{"role":"symbol","title":"login(passkey:challenge:connection:audience:scope:organization:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"kind":"externalParam","text":"passkey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth013SignupPasskeyP","text":"SignupPasskey"},{"kind":"text","text":", "},{"kind":"externalParam","text":"challenge"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth022PasskeySignupChallengeV","text":"PasskeySignupChallenge"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"kind":"text","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":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"organization"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","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":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"abstract":[{"type":"text","text":"Logs a new user in using a signup passkey credential and the signup challenge. This is the last part of the passkey signup flow."}],"kind":"symbol","defaultImplementations":2,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(passkey:challenge:connection:audience:scope:organization:)-340n2","url":"\/documentation\/auth0\/authentication\/login(passkey:challenge:connection:audience:scope:organization:)-340n2","required":true,"type":"topic"},"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":{"title":"Credentials","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"Credentials","kind":"identifier"}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(passkey:challenge:connection:audience:scope:organization:)-59b3j":{"role":"symbol","title":"login(passkey:challenge:connection:audience:scope:organization:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"kind":"externalParam","text":"passkey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"SignupPasskey","preciseIdentifier":"s:5Auth013SignupPasskeyP"},{"kind":"text","text":", "},{"kind":"externalParam","text":"challenge"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth022PasskeySignupChallengeV","kind":"typeIdentifier","text":"PasskeySignupChallenge"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"organization"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?) -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"abstract":[{"type":"text","text":"Logs a new user in using a signup passkey credential and the signup challenge. This is the last part of the passkey signup flow."}],"kind":"symbol","url":"\/documentation\/auth0\/authentication\/login(passkey:challenge:connection:audience:scope:organization:)-59b3j","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(passkey:challenge:connection:audience:scope:organization:)-59b3j","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","abstract":[{"type":"text","text":"Client for the "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","isActive":true},{"type":"text","text":"."}],"type":"topic","title":"Authentication","url":"\/documentation\/auth0\/authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"https://developer.apple.com/documentation/authenticationservices/asauthorizationcontrollerdelegate":{"title":"ASAuthorizationControllerDelegate","url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","type":"link","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","titleInlineContent":[{"code":"ASAuthorizationControllerDelegate","type":"codeVoice"}]},"doc://com.auth0.Auth0/documentation/Auth0/SignupPasskey":{"title":"SignupPasskey","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SignupPasskey","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"SignupPasskey"}],"abstract":[{"text":"The signup passkey credential obtained from the ","type":"text"},{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","isActive":true,"type":"reference"},{"text":" delegate.","type":"text"},{"text":" ","type":"text"},{"text":"Contains the subset of relevant properties from ","type":"text"},{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialregistration","isActive":true,"type":"reference"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/signuppasskey","navigatorTitle":[{"kind":"identifier","text":"SignupPasskey"}]},"https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access":{"title":"Early Access","url":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","type":"link","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","titleInlineContent":[{"type":"text","text":"Early Access"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"title":"Request","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"abstract":[{"text":"Auth0 API request.","type":"text"}],"url":"\/documentation\/auth0\/request","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"https://auth0.com/docs/native-passkeys-for-mobile-applications":{"title":"Native Passkeys for Mobile Applications","url":"https:\/\/auth0.com\/docs\/native-passkeys-for-mobile-applications","type":"link","identifier":"https:\/\/auth0.com\/docs\/native-passkeys-for-mobile-applications","titleInlineContent":[{"type":"text","text":"Native Passkeys for Mobile Applications"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authentication/login(passkey:challenge:connection:audience:scope:organization:)-4e7pl.json b/docs/data/documentation/auth0/authentication/login(passkey:challenge:connection:audience:scope:organization:)-4e7pl.json index af80b5605..18848aa93 100644 --- a/docs/data/documentation/auth0/authentication/login(passkey:challenge:connection:audience:scope:organization:)-4e7pl.json +++ b/docs/data/documentation/auth0/authentication/login(passkey:challenge:connection:audience:scope:organization:)-4e7pl.json @@ -1 +1 @@ -{"variants":[{"paths":["\/documentation\/auth0\/authentication\/login(passkey:challenge:connection:audience:scope:organization:)-4e7pl"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(passkey:challenge:connection:audience:scope:organization:)-4e7pl","interfaceLanguage":"swift"},"schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"text":"Logs a user in using an existing passkey credential and the login challenge. This is the last part of the passkey login flow.","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/native-passkeys-api#authenticate-existing-user","https:\/\/auth0.com\/docs\/native-passkeys-for-mobile-applications","https:\/\/developer.apple.com\/documentation\/authenticationservices\/supporting-passkeys#Connect-to-a-service-with-an-existing-account"],"title":"Related Documentation","anchor":"Related-Documentation"}],"metadata":{"title":"login(passkey:challenge:connection:audience:scope:organization:)","role":"symbol","platforms":[{"deprecated":false,"unavailable":false,"beta":false,"introducedAt":"16.6","name":"iOS"},{"deprecated":false,"unavailable":false,"beta":false,"introducedAt":"16.6","name":"iPadOS"},{"deprecated":false,"unavailable":false,"beta":false,"introducedAt":"16.6","name":"Mac Catalyst"},{"deprecated":false,"unavailable":false,"beta":false,"introducedAt":"13.5","name":"macOS"},{"deprecated":false,"unavailable":false,"beta":false,"introducedAt":"1.0","name":"visionOS"}],"extendedModule":"Auth0","symbolKind":"method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"kind":"externalParam","text":"passkey"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth012LoginPasskeyP","kind":"typeIdentifier","text":"LoginPasskey"},{"kind":"text","text":", "},{"kind":"externalParam","text":"challenge"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth021PasskeyLoginChallengeV","kind":"typeIdentifier","text":"PasskeyLoginChallenge"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"organization"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","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","kind":"typeIdentifier","text":"AuthenticationError"},{"kind":"text","text":">"}],"externalID":"s:5Auth014AuthenticationPAAE5login7passkey9challenge10connection8audience5scope12organizationAA7RequestVyAA11CredentialsCAA0B5ErrorVGAA12LoginPasskey_p_AA0nM9ChallengeVSSSgAUSSAUtF","modules":[{"name":"Auth0"}],"roleHeading":"Instance Method"},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"kind":"externalParam","text":"passkey"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth012LoginPasskeyP","kind":"typeIdentifier","text":"LoginPasskey","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey"},{"kind":"text","text":", "},{"kind":"externalParam","text":"challenge"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth021PasskeyLoginChallengeV","kind":"typeIdentifier","text":"PasskeyLoginChallenge","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"? = nil, "},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"? = nil, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" = defaultScope, "},{"kind":"externalParam","text":"organization"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"? = nil) -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"},{"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":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","text":"AuthenticationError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"},{"kind":"text","text":">"}],"platforms":["iOS"]}]},{"kind":"parameters","parameters":[{"name":"passkey","content":[{"type":"paragraph","inlineContent":[{"text":"The existing passkey credential obtained from the ","type":"text"},{"isActive":true,"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","type":"reference"},{"text":" delegate.","type":"text"}]}]},{"name":"challenge","content":[{"inlineContent":[{"type":"text","text":"The passkey challenge obtained from "},{"type":"codeVoice","code":"passkeyLoginChallenge(connection:)"},{"type":"text","text":"."}],"type":"paragraph"}]},{"name":"connection","content":[{"type":"paragraph","inlineContent":[{"text":"Name of the database connection. If a connection name is not specified, your tenant’s default directory will be used.","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":[{"type":"text","text":"Space-separated list of requested scope values. Defaults to "},{"code":"openid profile email","type":"codeVoice"},{"type":"text","text":"."}]}]},{"name":"organization","content":[{"inlineContent":[{"text":"Identifier of an organization the user is a member of.","type":"text"}],"type":"paragraph"}]}]},{"content":[{"type":"heading","level":2,"text":"Return Value","anchor":"return-value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A request that will yield Auth0 user’s credentials."}]}],"kind":"content"},{"content":[{"text":"Availability","anchor":"Availability","type":"heading","level":2},{"type":"paragraph","inlineContent":[{"type":"text","text":"This feature is currently available in"},{"type":"text","text":" "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","isActive":true},{"type":"text","text":"."},{"type":"text","text":" "},{"type":"text","text":"Please reach out to Auth0 support to get it enabled for your tenant."}]},{"text":"Usage","anchor":"Usage","type":"heading","level":2},{"syntax":"swift","code":["Auth0"," .authentication()"," .login(passkey: loginPasskey,"," challenge: loginChallenge,"," connection: \"Username-Password-Authentication\")"," .start { result in"," switch result {"," case .success(let credentials):"," print(\"Obtained credentials: \\(credentials)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"],"type":"codeListing"},{"type":"paragraph","inlineContent":[{"type":"text","text":"You can also specify audience (the Auth0 API identifier) and scope values:"}]},{"syntax":"swift","code":["Auth0"," .authentication()"," .login(passkey: loginPasskey,"," challenge: loginChallenge,"," connection: \"Username-Password-Authentication\","," audience: \"https:\/\/example.com\/api\","," scope: \"openid profile email offline_access\","," organization: \"org_aaAA1aa11aAAAA1a\")"," .start { print($0) }"],"type":"codeListing"}],"kind":"content"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Request":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/request","kind":"symbol","abstract":[{"type":"text","text":"Auth0 API request."}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"type":"topic","role":"symbol","title":"Authentication","abstract":[{"text":"Client for the ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"text":".","type":"text"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"https://auth0.com/docs/native-passkeys-for-mobile-applications":{"title":"Native Passkeys for Mobile Applications","identifier":"https:\/\/auth0.com\/docs\/native-passkeys-for-mobile-applications","url":"https:\/\/auth0.com\/docs\/native-passkeys-for-mobile-applications","type":"link","titleInlineContent":[{"type":"text","text":"Native Passkeys for Mobile Applications"}]},"https://developer.apple.com/documentation/authenticationservices/supporting-passkeys#Connect-to-a-service-with-an-existing-account":{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/supporting-passkeys#Connect-to-a-service-with-an-existing-account","url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/supporting-passkeys#Connect-to-a-service-with-an-existing-account","type":"link","titleInlineContent":[{"type":"text","text":"Supporting passkeys"}],"title":"Supporting passkeys"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(passkey:challenge:connection:audience:scope:organization:)-4e7pl":{"abstract":[{"type":"text","text":"Logs a user in using an existing passkey credential and the login challenge. This is the last part of the passkey login flow."}],"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"kind":"externalParam","text":"passkey"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth012LoginPasskeyP","kind":"typeIdentifier","text":"LoginPasskey"},{"kind":"text","text":", "},{"kind":"externalParam","text":"challenge"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth021PasskeyLoginChallengeV","kind":"typeIdentifier","text":"PasskeyLoginChallenge"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"organization"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","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","kind":"typeIdentifier","text":"AuthenticationError"},{"kind":"text","text":">"}],"url":"\/documentation\/auth0\/authentication\/login(passkey:challenge:connection:audience:scope:organization:)-4e7pl","title":"login(passkey:challenge:connection:audience:scope:organization:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(passkey:challenge:connection:audience:scope:organization:)-4e7pl","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyLoginChallenge":{"title":"PasskeyLoginChallenge","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasskeyLoginChallenge"}],"navigatorTitle":[{"kind":"identifier","text":"PasskeyLoginChallenge"}],"abstract":[{"text":"A passkey login challenge.","type":"text"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge","url":"\/documentation\/auth0\/passkeyloginchallenge","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"url":"\/documentation\/auth0\/credentials","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"role":"symbol","type":"topic","abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"https://auth0.com/docs/native-passkeys-api#authenticate-existing-user":{"identifier":"https:\/\/auth0.com\/docs\/native-passkeys-api#authenticate-existing-user","url":"https:\/\/auth0.com\/docs\/native-passkeys-api#authenticate-existing-user","type":"link","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"title":"Authentication API Endpoint"},"https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access":{"title":"Early Access","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","url":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","type":"link","titleInlineContent":[{"type":"text","text":"Early Access"}]},"https://developer.apple.com/documentation/authenticationservices/asauthorizationcontrollerdelegate":{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","type":"link","titleInlineContent":[{"type":"codeVoice","code":"ASAuthorizationControllerDelegate"}],"title":"ASAuthorizationControllerDelegate"},"https://developer.apple.com/documentation/authenticationservices/asauthorizationplatformpublickeycredentialassertion":{"title":"ASAuthorizationPlatformPublicKeyCredentialAssertion","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialassertion","url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialassertion","type":"link","titleInlineContent":[{"type":"codeVoice","code":"ASAuthorizationPlatformPublicKeyCredentialAssertion"}]},"doc://com.auth0.Auth0/documentation/Auth0/LoginPasskey":{"role":"symbol","url":"\/documentation\/auth0\/loginpasskey","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"LoginPasskey"}],"navigatorTitle":[{"kind":"identifier","text":"LoginPasskey"}],"title":"LoginPasskey","abstract":[{"type":"text","text":"The login passkey credential obtained from the "},{"isActive":true,"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate"},{"type":"text","text":" delegate."},{"type":"text","text":" "},{"type":"text","text":"Contains the subset of relevant properties from "},{"isActive":true,"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialassertion"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"https://auth0.com/docs/api/authentication":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","url":"https:\/\/auth0.com\/docs\/api\/authentication","type":"link","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"title":"Auth0 Authentication API"}}} \ No newline at end of file +{"sections":[],"metadata":{"modules":[{"name":"Auth0"}],"externalID":"s:5Auth014AuthenticationPAAE5login7passkey9challenge10connection8audience5scope12organizationAA7RequestVyAA11CredentialsCAA0B5ErrorVGAA12LoginPasskey_p_AA0nM9ChallengeVSSSgAUSSAUtF","title":"login(passkey:challenge:connection:audience:scope:organization:)","extendedModule":"Auth0","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"kind":"externalParam","text":"passkey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012LoginPasskeyP","text":"LoginPasskey"},{"kind":"text","text":", "},{"kind":"externalParam","text":"challenge"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth021PasskeyLoginChallengeV","text":"PasskeyLoginChallenge"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"kind":"text","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":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"organization"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","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":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"role":"symbol","symbolKind":"method","platforms":[{"deprecated":false,"unavailable":false,"beta":false,"name":"iOS","introducedAt":"16.6"},{"deprecated":false,"unavailable":false,"beta":false,"name":"iPadOS","introducedAt":"16.6"},{"deprecated":false,"unavailable":false,"beta":false,"name":"Mac Catalyst","introducedAt":"16.6"},{"deprecated":false,"unavailable":false,"beta":false,"name":"macOS","introducedAt":"13.5"},{"deprecated":false,"unavailable":false,"beta":false,"name":"visionOS","introducedAt":"1.0"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(passkey:challenge:connection:audience:scope:organization:)-4e7pl","interfaceLanguage":"swift"},"kind":"symbol","seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/native-passkeys-api#authenticate-existing-user","https:\/\/auth0.com\/docs\/native-passkeys-for-mobile-applications","https:\/\/developer.apple.com\/documentation\/authenticationservices\/supporting-passkeys#Connect-to-a-service-with-an-existing-account"],"anchor":"Related-Documentation"}],"variants":[{"paths":["\/documentation\/auth0\/authentication\/login(passkey:challenge:connection:audience:scope:organization:)-4e7pl"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"passkey","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth012LoginPasskeyP","text":"LoginPasskey","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey"},{"text":", ","kind":"text"},{"text":"challenge","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth021PasskeyLoginChallengeV","text":"PasskeyLoginChallenge","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"? = nil, ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"? = nil, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" = defaultScope, ","kind":"text"},{"text":"organization","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"? = nil) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"},{"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":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The existing passkey credential obtained from the "},{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","type":"reference","isActive":true},{"type":"text","text":" delegate."}]}],"name":"passkey"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The passkey challenge obtained from "},{"code":"passkeyLoginChallenge(connection:)","type":"codeVoice"},{"type":"text","text":"."}]}],"name":"challenge"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Name of the database connection. If a connection name is not specified, your tenant’s default directory will be used."}]}],"name":"connection"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"API Identifier that your application is requesting access to. Defaults to "},{"code":"nil","type":"codeVoice"},{"type":"text","text":"."}]}],"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"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Identifier of an organization the user is a member of."}]}],"name":"organization"}]},{"content":[{"level":2,"type":"heading","anchor":"return-value","text":"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":"Availability","text":"Availability"},{"type":"paragraph","inlineContent":[{"type":"text","text":"This feature is currently available in"},{"type":"text","text":" "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","isActive":true},{"type":"text","text":"."},{"type":"text","text":" "},{"type":"text","text":"Please reach out to Auth0 support to get it enabled for your tenant."}]},{"level":2,"type":"heading","anchor":"Usage","text":"Usage"},{"type":"codeListing","syntax":"swift","code":["Auth0"," .authentication()"," .login(passkey: loginPasskey,"," challenge: loginChallenge,"," connection: \"Username-Password-Authentication\")"," .start { result in"," switch result {"," case .success(let credentials):"," print(\"Obtained credentials: \\(credentials)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"]},{"type":"paragraph","inlineContent":[{"type":"text","text":"You can also specify audience (the Auth0 API identifier) and scope values:"}]},{"type":"codeListing","syntax":"swift","code":["Auth0"," .authentication()"," .login(passkey: loginPasskey,"," challenge: loginChallenge,"," connection: \"Username-Password-Authentication\","," audience: \"https:\/\/example.com\/api\","," scope: \"openid profile email offline_access\","," organization: \"org_aaAA1aa11aAAAA1a\")"," .start { print($0) }"]}],"kind":"content"}],"abstract":[{"type":"text","text":"Logs a user in using an existing passkey credential and the login challenge. This is the last part of the passkey login flow."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"Credentials","kind":"identifier"}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}]},"https://developer.apple.com/documentation/authenticationservices/asauthorizationplatformpublickeycredentialassertion":{"title":"ASAuthorizationPlatformPublicKeyCredentialAssertion","type":"link","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialassertion","titleInlineContent":[{"type":"codeVoice","code":"ASAuthorizationPlatformPublicKeyCredentialAssertion"}],"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialassertion"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/LoginPasskey":{"title":"LoginPasskey","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"LoginPasskey"}],"abstract":[{"text":"The login passkey credential obtained from the ","type":"text"},{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","isActive":true,"type":"reference"},{"text":" delegate.","type":"text"},{"text":" ","type":"text"},{"text":"Contains the subset of relevant properties from ","type":"text"},{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialassertion","isActive":true,"type":"reference"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/loginpasskey","navigatorTitle":[{"kind":"identifier","text":"LoginPasskey"}]},"https://auth0.com/docs/api/authentication":{"title":"Auth0 Authentication API","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication"},"https://developer.apple.com/documentation/authenticationservices/asauthorizationcontrollerdelegate":{"title":"ASAuthorizationControllerDelegate","type":"link","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","titleInlineContent":[{"type":"codeVoice","code":"ASAuthorizationControllerDelegate"}],"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate"},"https://developer.apple.com/documentation/authenticationservices/supporting-passkeys#Connect-to-a-service-with-an-existing-account":{"title":"Supporting passkeys","type":"link","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/supporting-passkeys#Connect-to-a-service-with-an-existing-account","titleInlineContent":[{"type":"text","text":"Supporting passkeys"}],"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/supporting-passkeys#Connect-to-a-service-with-an-existing-account"},"https://auth0.com/docs/native-passkeys-api#authenticate-existing-user":{"title":"Authentication API Endpoint","type":"link","identifier":"https:\/\/auth0.com\/docs\/native-passkeys-api#authenticate-existing-user","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"url":"https:\/\/auth0.com\/docs\/native-passkeys-api#authenticate-existing-user"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyLoginChallenge":{"title":"PasskeyLoginChallenge","role":"symbol","navigatorTitle":[{"text":"PasskeyLoginChallenge","kind":"identifier"}],"kind":"symbol","abstract":[{"text":"A passkey login challenge.","type":"text"}],"url":"\/documentation\/auth0\/passkeyloginchallenge","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"PasskeyLoginChallenge"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(passkey:challenge:connection:audience:scope:organization:)-4e7pl":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(passkey:challenge:connection:audience:scope:organization:)-4e7pl","kind":"symbol","title":"login(passkey:challenge:connection:audience:scope:organization:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"passkey","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"LoginPasskey","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012LoginPasskeyP"},{"text":", ","kind":"text"},{"text":"challenge","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"PasskeyLoginChallenge","kind":"typeIdentifier","preciseIdentifier":"s:5Auth021PasskeyLoginChallengeV"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"organization","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?) -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"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"}],"role":"symbol","url":"\/documentation\/auth0\/authentication\/login(passkey:challenge:connection:audience:scope:organization:)-4e7pl","abstract":[{"type":"text","text":"Logs a user in using an existing passkey credential and the login challenge. This is the last part of the passkey login flow."}],"type":"topic"},"https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access":{"title":"Early Access","type":"link","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","titleInlineContent":[{"type":"text","text":"Early Access"}],"url":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","abstract":[{"type":"text","text":"Client for the "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","isActive":true},{"type":"text","text":"."}],"type":"topic","title":"Authentication","url":"\/documentation\/auth0\/authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"title":"Request","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"abstract":[{"text":"Auth0 API request.","type":"text"}],"url":"\/documentation\/auth0\/request","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"https://auth0.com/docs/native-passkeys-for-mobile-applications":{"title":"Native Passkeys for Mobile Applications","type":"link","identifier":"https:\/\/auth0.com\/docs\/native-passkeys-for-mobile-applications","titleInlineContent":[{"type":"text","text":"Native Passkeys for Mobile Applications"}],"url":"https:\/\/auth0.com\/docs\/native-passkeys-for-mobile-applications"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authentication/login(passkey:challenge:connection:audience:scope:organization:)-59b3j.json b/docs/data/documentation/auth0/authentication/login(passkey:challenge:connection:audience:scope:organization:)-59b3j.json index 26aa29eb5..2e1cc7969 100644 --- a/docs/data/documentation/auth0/authentication/login(passkey:challenge:connection:audience:scope:organization:)-59b3j.json +++ b/docs/data/documentation/auth0/authentication/login(passkey:challenge:connection:audience:scope:organization:)-59b3j.json @@ -1 +1 @@ -{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/login(passkey:challenge:connection:audience:scope:organization:)-59b3j"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(passkey:challenge:connection:audience:scope:organization:)-59b3j"},"sections":[],"kind":"symbol","metadata":{"extendedModule":"Auth0","roleHeading":"Instance Method","platforms":[{"name":"iOS","introducedAt":"16.6","unavailable":false,"beta":false,"deprecated":false},{"name":"iPadOS","introducedAt":"16.6","unavailable":false,"beta":false,"deprecated":false},{"name":"Mac Catalyst","introducedAt":"16.6","unavailable":false,"beta":false,"deprecated":false},{"name":"macOS","introducedAt":"13.5","unavailable":false,"beta":false,"deprecated":false},{"name":"visionOS","introducedAt":"1.0","unavailable":false,"beta":false,"deprecated":false}],"role":"symbol","externalID":"s:5Auth014AuthenticationPAAE5login7passkey9challenge10connection8audience5scope12organizationAA7RequestVyAA11CredentialsCAA0B5ErrorVGAA13SignupPasskey_p_AA0nM9ChallengeVSSSgAUSSAUtF","symbolKind":"method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"kind":"externalParam","text":"passkey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth013SignupPasskeyP","text":"SignupPasskey"},{"kind":"text","text":", "},{"kind":"externalParam","text":"challenge"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth022PasskeySignupChallengeV","text":"PasskeySignupChallenge"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"kind":"text","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":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"organization"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","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":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"modules":[{"name":"Auth0"}],"title":"login(passkey:challenge:connection:audience:scope:organization:)"},"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"kind":"externalParam","text":"passkey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SignupPasskey","preciseIdentifier":"s:5Auth013SignupPasskeyP","text":"SignupPasskey"},{"kind":"text","text":", "},{"kind":"externalParam","text":"challenge"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge","preciseIdentifier":"s:5Auth022PasskeySignupChallengeV","text":"PasskeySignupChallenge"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"? = nil, "},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"? = nil, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" = defaultScope, "},{"kind":"externalParam","text":"organization"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"? = nil) -> "},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"},{"kind":"text","text":", "},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"platforms":["iOS"]}],"kind":"declarations"},{"parameters":[{"name":"passkey","content":[{"inlineContent":[{"type":"text","text":"The signup passkey credential obtained from the "},{"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","isActive":true},{"type":"text","text":" delegate."}],"type":"paragraph"}]},{"name":"challenge","content":[{"inlineContent":[{"text":"The passkey signup challenge obtained from ","type":"text"},{"code":"passkeySignupChallenge(email:phoneNumber:username:name:connection:)","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"}]},{"name":"connection","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Name of the database connection where the user will be created. If a connection name is not specified, your tenant’s default directory will be used."}]}]},{"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"},{"code":"openid profile email","type":"codeVoice"},{"text":".","type":"text"}]}]},{"name":"organization","content":[{"inlineContent":[{"type":"text","text":"Identifier of an organization the user is a member of."}],"type":"paragraph"}]}],"kind":"parameters"},{"content":[{"text":"Return Value","anchor":"return-value","level":2,"type":"heading"},{"inlineContent":[{"type":"text","text":"A request that will yield Auth0 user’s credentials."}],"type":"paragraph"}],"kind":"content"},{"content":[{"level":2,"type":"heading","anchor":"Availability","text":"Availability"},{"type":"paragraph","inlineContent":[{"type":"text","text":"This feature is currently available in"},{"type":"text","text":" "},{"type":"reference","isActive":true,"identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access"},{"type":"text","text":"."},{"type":"text","text":" "},{"type":"text","text":"Please reach out to Auth0 support to get it enabled for your tenant."}]},{"level":2,"type":"heading","anchor":"Usage","text":"Usage"},{"code":["Auth0"," .authentication()"," .login(passkey: signupPasskey,"," challenge: signupChallenge,"," connection: \"Username-Password-Authentication\")"," .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"}]},{"code":["Auth0"," .authentication()"," .login(passkey: signupPasskey,"," challenge: signupChallenge,"," connection: \"Username-Password-Authentication\","," audience: \"https:\/\/example.com\/api\","," scope: \"openid profile email offline_access\","," organization: \"org_aaAA1aa11aAAAA1a\")"," .start { print($0) }"],"syntax":"swift","type":"codeListing"}],"kind":"content"}],"schemaVersion":{"minor":3,"patch":0,"major":0},"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/native-passkeys-api#authenticate-new-user","https:\/\/auth0.com\/docs\/native-passkeys-for-mobile-applications","https:\/\/developer.apple.com\/documentation\/authenticationservices\/supporting-passkeys#Register-a-new-account-on-a-service"],"title":"Related Documentation","anchor":"Related-Documentation"}],"abstract":[{"type":"text","text":"Logs a new user in using a signup passkey credential and the signup challenge. This is the last part of the passkey signup flow."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/SignupPasskey":{"type":"topic","kind":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"SignupPasskey","kind":"identifier"}],"url":"\/documentation\/auth0\/signuppasskey","abstract":[{"type":"text","text":"The signup passkey credential obtained from the "},{"isActive":true,"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","type":"reference"},{"type":"text","text":" delegate."},{"type":"text","text":" "},{"type":"text","text":"Contains the subset of relevant properties from "},{"isActive":true,"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialregistration","type":"reference"},{"type":"text","text":"."}],"role":"symbol","navigatorTitle":[{"text":"SignupPasskey","kind":"identifier"}],"title":"SignupPasskey","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SignupPasskey"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"type":"topic","role":"symbol","title":"Authentication","abstract":[{"text":"Client for the ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"text":".","type":"text"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"https://developer.apple.com/documentation/authenticationservices/asauthorizationcontrollerdelegate":{"titleInlineContent":[{"type":"codeVoice","code":"ASAuthorizationControllerDelegate"}],"type":"link","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","title":"ASAuthorizationControllerDelegate","url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate"},"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/Credentials":{"title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"url":"\/documentation\/auth0\/credentials","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"role":"symbol","type":"topic","abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}]},"https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access":{"titleInlineContent":[{"type":"text","text":"Early Access"}],"type":"link","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","title":"Early Access","url":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(passkey:challenge:connection:audience:scope:organization:)-59b3j":{"role":"symbol","title":"login(passkey:challenge:connection:audience:scope:organization:)","url":"\/documentation\/auth0\/authentication\/login(passkey:challenge:connection:audience:scope:organization:)-59b3j","type":"topic","abstract":[{"type":"text","text":"Logs a new user in using a signup passkey credential and the signup challenge. This is the last part of the passkey signup flow."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(passkey:challenge:connection:audience:scope:organization:)-59b3j","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"passkey","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth013SignupPasskeyP","text":"SignupPasskey","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"challenge","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth022PasskeySignupChallengeV","text":"PasskeySignupChallenge","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"organization","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}]},"https://developer.apple.com/documentation/authenticationservices/supporting-passkeys#Register-a-new-account-on-a-service":{"titleInlineContent":[{"type":"text","text":"Supporting passkeys"}],"type":"link","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/supporting-passkeys#Register-a-new-account-on-a-service","title":"Supporting passkeys","url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/supporting-passkeys#Register-a-new-account-on-a-service"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"https://developer.apple.com/documentation/authenticationservices/asauthorizationplatformpublickeycredentialregistration":{"titleInlineContent":[{"type":"codeVoice","code":"ASAuthorizationPlatformPublicKeyCredentialRegistration"}],"type":"link","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialregistration","title":"ASAuthorizationPlatformPublicKeyCredentialRegistration","url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialregistration"},"https://auth0.com/docs/native-passkeys-for-mobile-applications":{"titleInlineContent":[{"type":"text","text":"Native Passkeys for Mobile Applications"}],"type":"link","identifier":"https:\/\/auth0.com\/docs\/native-passkeys-for-mobile-applications","title":"Native Passkeys for Mobile Applications","url":"https:\/\/auth0.com\/docs\/native-passkeys-for-mobile-applications"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeySignupChallenge":{"type":"topic","abstract":[{"type":"text","text":"A passkey signup challenge."}],"kind":"symbol","title":"PasskeySignupChallenge","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge","role":"symbol","url":"\/documentation\/auth0\/passkeysignupchallenge","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasskeySignupChallenge"}],"navigatorTitle":[{"kind":"identifier","text":"PasskeySignupChallenge"}]},"https://auth0.com/docs/native-passkeys-api#authenticate-new-user":{"titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"type":"link","identifier":"https:\/\/auth0.com\/docs\/native-passkeys-api#authenticate-new-user","title":"Authentication API Endpoint","url":"https:\/\/auth0.com\/docs\/native-passkeys-api#authenticate-new-user"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/request","kind":"symbol","abstract":[{"type":"text","text":"Auth0 API request."}]}}} \ No newline at end of file +{"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(passkey:challenge:connection:audience:scope:organization:)-59b3j","interfaceLanguage":"swift"},"kind":"symbol","metadata":{"roleHeading":"Instance Method","extendedModule":"Auth0","role":"symbol","title":"login(passkey:challenge:connection:audience:scope:organization:)","symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"passkey","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth013SignupPasskeyP","text":"SignupPasskey","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"challenge","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth022PasskeySignupChallengeV","text":"PasskeySignupChallenge","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"organization","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"externalID":"s:5Auth014AuthenticationPAAE5login7passkey9challenge10connection8audience5scope12organizationAA7RequestVyAA11CredentialsCAA0B5ErrorVGAA13SignupPasskey_p_AA0nM9ChallengeVSSSgAUSSAUtF","modules":[{"name":"Auth0"}],"platforms":[{"introducedAt":"16.6","unavailable":false,"name":"iOS","beta":false,"deprecated":false},{"introducedAt":"16.6","unavailable":false,"name":"iPadOS","beta":false,"deprecated":false},{"introducedAt":"16.6","unavailable":false,"name":"Mac Catalyst","beta":false,"deprecated":false},{"introducedAt":"13.5","unavailable":false,"name":"macOS","beta":false,"deprecated":false},{"introducedAt":"1.0","unavailable":false,"name":"visionOS","beta":false,"deprecated":false}]},"seeAlsoSections":[{"anchor":"Related-Documentation","title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/native-passkeys-api#authenticate-new-user","https:\/\/auth0.com\/docs\/native-passkeys-for-mobile-applications","https:\/\/developer.apple.com\/documentation\/authenticationservices\/supporting-passkeys#Register-a-new-account-on-a-service"]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/login(passkey:challenge:connection:audience:scope:organization:)-59b3j"]}],"schemaVersion":{"minor":3,"major":0,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"kind":"externalParam","text":"passkey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"SignupPasskey","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SignupPasskey","preciseIdentifier":"s:5Auth013SignupPasskeyP"},{"kind":"text","text":", "},{"kind":"externalParam","text":"challenge"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"PasskeySignupChallenge","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge","preciseIdentifier":"s:5Auth022PasskeySignupChallengeV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"? = nil, "},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"? = nil, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" = defaultScope, "},{"kind":"externalParam","text":"organization"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","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","text":"Credentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"AuthenticationError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"},{"parameters":[{"name":"passkey","content":[{"inlineContent":[{"type":"text","text":"The signup passkey credential obtained from the "},{"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","isActive":true},{"type":"text","text":" delegate."}],"type":"paragraph"}]},{"name":"challenge","content":[{"inlineContent":[{"type":"text","text":"The passkey signup challenge obtained from "},{"type":"codeVoice","code":"passkeySignupChallenge(email:phoneNumber:username:name:connection:)"},{"type":"text","text":"."}],"type":"paragraph"}]},{"name":"connection","content":[{"inlineContent":[{"type":"text","text":"Name of the database connection where the user will be created. If a connection name is not specified, your tenant’s default directory will be used."}],"type":"paragraph"}]},{"name":"audience","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"API Identifier that your application is requesting access to. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}]}]},{"name":"scope","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Space-separated list of requested scope values. Defaults to "},{"type":"codeVoice","code":"openid profile email"},{"type":"text","text":"."}]}]},{"name":"organization","content":[{"type":"paragraph","inlineContent":[{"text":"Identifier of an organization the user is a member of.","type":"text"}]}]}],"kind":"parameters"},{"content":[{"anchor":"return-value","type":"heading","level":2,"text":"Return Value"},{"inlineContent":[{"text":"A request that will yield Auth0 user’s credentials.","type":"text"}],"type":"paragraph"}],"kind":"content"},{"kind":"content","content":[{"anchor":"Availability","type":"heading","level":2,"text":"Availability"},{"inlineContent":[{"type":"text","text":"This feature is currently available in"},{"type":"text","text":" "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","isActive":true},{"type":"text","text":"."},{"type":"text","text":" "},{"type":"text","text":"Please reach out to Auth0 support to get it enabled for your tenant."}],"type":"paragraph"},{"anchor":"Usage","type":"heading","level":2,"text":"Usage"},{"type":"codeListing","code":["Auth0"," .authentication()"," .login(passkey: signupPasskey,"," challenge: signupChallenge,"," connection: \"Username-Password-Authentication\")"," .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"},{"type":"codeListing","code":["Auth0"," .authentication()"," .login(passkey: signupPasskey,"," challenge: signupChallenge,"," connection: \"Username-Password-Authentication\","," audience: \"https:\/\/example.com\/api\","," scope: \"openid profile email offline_access\","," organization: \"org_aaAA1aa11aAAAA1a\")"," .start { print($0) }"],"syntax":"swift"}]}],"abstract":[{"text":"Logs a new user in using a signup passkey credential and the signup challenge. This is the last part of the passkey signup flow.","type":"text"}],"references":{"https://developer.apple.com/documentation/authenticationservices/asauthorizationplatformpublickeycredentialregistration":{"title":"ASAuthorizationPlatformPublicKeyCredentialRegistration","titleInlineContent":[{"type":"codeVoice","code":"ASAuthorizationPlatformPublicKeyCredentialRegistration"}],"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialregistration","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialregistration","type":"link"},"https://developer.apple.com/documentation/authenticationservices/supporting-passkeys#Register-a-new-account-on-a-service":{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/supporting-passkeys#Register-a-new-account-on-a-service","type":"link","title":"Supporting passkeys","titleInlineContent":[{"text":"Supporting passkeys","type":"text"}],"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/supporting-passkeys#Register-a-new-account-on-a-service"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"},"https://auth0.com/docs/native-passkeys-api#authenticate-new-user":{"title":"Authentication API Endpoint","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"type":"link","identifier":"https:\/\/auth0.com\/docs\/native-passkeys-api#authenticate-new-user","url":"https:\/\/auth0.com\/docs\/native-passkeys-api#authenticate-new-user"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeySignupChallenge":{"title":"PasskeySignupChallenge","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge","role":"symbol","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"PasskeySignupChallenge","kind":"identifier"}],"abstract":[{"text":"A passkey signup challenge.","type":"text"}],"url":"\/documentation\/auth0\/passkeysignupchallenge","navigatorTitle":[{"text":"PasskeySignupChallenge","kind":"identifier"}]},"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"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"Credentials","kind":"identifier"}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(passkey:challenge:connection:audience:scope:organization:)-59b3j":{"role":"symbol","title":"login(passkey:challenge:connection:audience:scope:organization:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"kind":"externalParam","text":"passkey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"SignupPasskey","preciseIdentifier":"s:5Auth013SignupPasskeyP"},{"kind":"text","text":", "},{"kind":"externalParam","text":"challenge"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth022PasskeySignupChallengeV","kind":"typeIdentifier","text":"PasskeySignupChallenge"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"organization"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?) -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"abstract":[{"type":"text","text":"Logs a new user in using a signup passkey credential and the signup challenge. This is the last part of the passkey signup flow."}],"kind":"symbol","url":"\/documentation\/auth0\/authentication\/login(passkey:challenge:connection:audience:scope:organization:)-59b3j","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(passkey:challenge:connection:audience:scope:organization:)-59b3j","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","abstract":[{"type":"text","text":"Client for the "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","isActive":true},{"type":"text","text":"."}],"type":"topic","title":"Authentication","url":"\/documentation\/auth0\/authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"https://developer.apple.com/documentation/authenticationservices/asauthorizationcontrollerdelegate":{"title":"ASAuthorizationControllerDelegate","titleInlineContent":[{"type":"codeVoice","code":"ASAuthorizationControllerDelegate"}],"type":"link","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate"},"doc://com.auth0.Auth0/documentation/Auth0/SignupPasskey":{"title":"SignupPasskey","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SignupPasskey","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"SignupPasskey"}],"abstract":[{"text":"The signup passkey credential obtained from the ","type":"text"},{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","isActive":true,"type":"reference"},{"text":" delegate.","type":"text"},{"text":" ","type":"text"},{"text":"Contains the subset of relevant properties from ","type":"text"},{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialregistration","isActive":true,"type":"reference"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/signuppasskey","navigatorTitle":[{"kind":"identifier","text":"SignupPasskey"}]},"https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access":{"title":"Early Access","titleInlineContent":[{"type":"text","text":"Early Access"}],"type":"link","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","url":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"title":"Request","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"abstract":[{"text":"Auth0 API request.","type":"text"}],"url":"\/documentation\/auth0\/request","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"https://auth0.com/docs/native-passkeys-for-mobile-applications":{"identifier":"https:\/\/auth0.com\/docs\/native-passkeys-for-mobile-applications","type":"link","title":"Native Passkeys for Mobile Applications","titleInlineContent":[{"text":"Native Passkeys for Mobile Applications","type":"text"}],"url":"https:\/\/auth0.com\/docs\/native-passkeys-for-mobile-applications"}}} \ 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 30ae9fe6e..832376bba 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 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"variants":[{"paths":["\/documentation\/auth0\/authentication\/login(phonenumber:code:audience:scope:)-8kbii"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","metadata":{"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"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"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"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"}],"roleHeading":"Instance Method","title":"login(phoneNumber:code:audience:scope:)","symbolKind":"method","externalID":"s:5Auth014AuthenticationPAAE5login11phoneNumber4code8audience5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_S2SSgSStF","extendedModule":"Auth0","modules":[{"name":"Auth0"}]},"schemaVersion":{"minor":3,"major":0,"patch":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(phoneNumber:code:audience:scope:)-8kbii","interfaceLanguage":"swift"},"abstract":[{"text":"Logs a user in using a phone number and an OTP code received via SMS. This is the last part of the passwordless login flow.","type":"text"}],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication\/passwordless\/authenticate-user"],"anchor":"Related-Documentation"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"phoneNumber","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"code","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"? = nil, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" = defaultScope) -> "},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"},{"kind":"text","text":">"}]}]},{"kind":"parameters","parameters":[{"name":"phoneNumber","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Phone number the user used to start the passwordless login flow."}]}]},{"name":"code","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"One-time password (OTP) code the user received via SMS."}]}]},{"name":"audience","content":[{"inlineContent":[{"text":"API Identifier that your application is requesting access to. Defaults to ","type":"text"},{"code":"nil","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"}]},{"name":"scope","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Space-separated list of requested scope values. Defaults to "},{"code":"openid profile email","type":"codeVoice"},{"type":"text","text":"."}]}]}]},{"content":[{"level":2,"text":"Return Value","anchor":"return-value","type":"heading"},{"inlineContent":[{"type":"text","text":"Request that will yield Auth0 user’s credentials."}],"type":"paragraph"}],"kind":"content"},{"content":[{"text":"Usage","type":"heading","anchor":"Usage","level":2},{"type":"codeListing","syntax":"swift","code":["Auth0"," .authentication()"," .login(phoneNumber: \"+12025550135\", code: \"123456\")"," .start { result in"," switch result {"," case .success(let credentials):"," print(\"Obtained credentials: \\(credentials)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"]},{"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(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":[{"inlineContent":[{"type":"text","text":"Passwordless OTP Grant "},{"type":"codeVoice","code":"http:\/\/auth0.com\/oauth\/grant-type\/passwordless\/otp"},{"type":"text","text":". Check"},{"type":"text","text":" "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","isActive":true},{"type":"text","text":" for more information."}],"type":"paragraph"}]}],"kind":"content"}],"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"https://auth0.com/docs/api/authentication/passwordless/authenticate-user":{"type":"link","title":"Authentication API Endpoint","identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/passwordless\/authenticate-user","url":"https:\/\/auth0.com\/docs\/api\/authentication\/passwordless\/authenticate-user","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}]},"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","url":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types"},"https://auth0.com/docs/api/authentication":{"type":"link","title":"Auth0 Authentication API","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","url":"https:\/\/auth0.com\/docs\/api\/authentication","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(phoneNumber:code:audience:scope:)-8kbii":{"abstract":[{"text":"Logs a user in using a phone number and an OTP code received via SMS. This is the last part of the passwordless login flow.","type":"text"}],"url":"\/documentation\/auth0\/authentication\/login(phonenumber:code:audience:scope:)-8kbii","type":"topic","role":"symbol","kind":"symbol","title":"login(phoneNumber:code:audience:scope:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"phoneNumber","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"code","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"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"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(phoneNumber:code:audience:scope:)-8kbii"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"url":"\/documentation\/auth0\/credentials","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"role":"symbol","type":"topic","abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"type":"topic","role":"symbol","title":"Authentication","abstract":[{"text":"Client for the ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"text":".","type":"text"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/request","kind":"symbol","abstract":[{"type":"text","text":"Auth0 API request."}]}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"metadata":{"extendedModule":"Auth0","symbolKind":"method","modules":[{"name":"Auth0"}],"title":"login(phoneNumber:code:audience:scope:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"kind":"externalParam","text":"phoneNumber"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"code"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","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":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"externalID":"s:5Auth014AuthenticationPAAE5login11phoneNumber4code8audience5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_S2SSgSStF","role":"symbol","roleHeading":"Instance Method"},"sections":[],"abstract":[{"type":"text","text":"Logs a user in using a phone number and an OTP code received via SMS. This is the last part of the passwordless login flow."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/login(phonenumber:code:audience:scope:)-8kbii"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(phoneNumber:code:audience:scope:)-8kbii","interfaceLanguage":"swift"},"seeAlsoSections":[{"anchor":"Related-Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication\/passwordless\/authenticate-user"],"title":"Related Documentation"}],"kind":"symbol","schemaVersion":{"patch":0,"minor":3,"major":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"kind":"externalParam","text":"phoneNumber"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"code"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"? = nil, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" = defaultScope) -> "},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","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"},{"kind":"text","text":", "},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}]}]},{"kind":"parameters","parameters":[{"name":"phoneNumber","content":[{"inlineContent":[{"type":"text","text":"Phone number the user used to start the passwordless login flow."}],"type":"paragraph"}]},{"name":"code","content":[{"inlineContent":[{"type":"text","text":"One-time password (OTP) code the user received via SMS."}],"type":"paragraph"}]},{"name":"audience","content":[{"inlineContent":[{"type":"text","text":"API Identifier that your application is requesting access to. Defaults to "},{"code":"nil","type":"codeVoice"},{"type":"text","text":"."}],"type":"paragraph"}]},{"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"}],"name":"scope"}]},{"content":[{"level":2,"anchor":"return-value","text":"Return Value","type":"heading"},{"type":"paragraph","inlineContent":[{"text":"Request that will yield Auth0 user’s credentials.","type":"text"}]}],"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)\")"," }"," }"]},{"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(phoneNumber: \"+12025550135\","," code: \"123456\","," audience: \"https:\/\/example.com\/api\","," scope: \"openid profile email offline_access\")"," .start { print($0) }"]},{"style":"note","content":[{"inlineContent":[{"type":"text","text":"Passwordless OTP Grant "},{"type":"codeVoice","code":"http:\/\/auth0.com\/oauth\/grant-type\/passwordless\/otp"},{"type":"text","text":". Check"},{"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"}],"type":"aside","name":"Requires"}],"kind":"content"}],"references":{"https://auth0.com/docs/api/authentication":{"type":"link","titleInlineContent":[{"text":"Auth0 Authentication API","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication","title":"Auth0 Authentication API","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"title":"Request","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"abstract":[{"text":"Auth0 API request.","type":"text"}],"url":"\/documentation\/auth0\/request","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"Credentials","kind":"identifier"}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(phoneNumber:code:audience:scope:)-8kbii":{"title":"login(phoneNumber:code:audience:scope:)","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(phoneNumber:code:audience:scope:)-8kbii","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"kind":"externalParam","text":"phoneNumber"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"code"},{"kind":"text","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":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","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":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"abstract":[{"type":"text","text":"Logs a user in 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:)-8kbii"},"https://auth0.com/docs/get-started/applications/application-grant-types":{"type":"link","titleInlineContent":[{"text":"our documentation","type":"text"}],"url":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","title":"our documentation","identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","abstract":[{"type":"text","text":"Client for the "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","isActive":true},{"type":"text","text":"."}],"type":"topic","title":"Authentication","url":"\/documentation\/auth0\/authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"https://auth0.com/docs/api/authentication/passwordless/authenticate-user":{"type":"link","titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication\/passwordless\/authenticate-user","title":"Authentication API Endpoint","identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/passwordless\/authenticate-user"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authentication/login(phonenumber:code:audience:scope:).json b/docs/data/documentation/auth0/authentication/login(phonenumber:code:audience:scope:).json index febcfc2ce..8d0236eec 100644 --- a/docs/data/documentation/auth0/authentication/login(phonenumber:code:audience:scope:).json +++ b/docs/data/documentation/auth0/authentication/login(phonenumber:code:audience:scope:).json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"defaultImplementationsSections":[{"anchor":"Authentication-Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(phoneNumber:code:audience:scope:)-8kbii"],"title":"Authentication Implementations"}],"seeAlsoSections":[{"anchor":"Related-Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication\/passwordless\/authenticate-user"],"title":"Related Documentation"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"kind":"externalParam","text":"phoneNumber"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"code"},{"kind":"text","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":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"},{"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":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"},{"kind":"text","text":">"}],"platforms":["iOS"]}]},{"parameters":[{"content":[{"type":"paragraph","inlineContent":[{"text":"Phone number the user used to start the passwordless login flow.","type":"text"}]}],"name":"phoneNumber"},{"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"},{"type":"text","text":"."}],"type":"paragraph"}],"name":"audience"},{"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"}]}],"name":"scope"}],"kind":"parameters"},{"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":[{"anchor":"Usage","type":"heading","level":2,"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)\")"," }"," }"]},{"type":"paragraph","inlineContent":[{"type":"text","text":"You can also specify audience (the Auth0 API identifier) and scope values:"}]},{"type":"codeListing","syntax":"swift","code":["Auth0"," .authentication()"," .login(phoneNumber: \"+12025550135\","," code: \"123456\","," audience: \"https:\/\/example.com\/api\","," scope: \"openid profile email offline_access\")"," .start { print($0) }"]},{"style":"note","name":"Requires","type":"aside","content":[{"type":"paragraph","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"},{"isActive":true,"identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","type":"reference"},{"text":" for more information.","type":"text"}]}]}]}],"metadata":{"externalID":"s:5Auth014AuthenticationP5login11phoneNumber4code8audience5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_S2SSgSStF","roleHeading":"Instance Method","symbolKind":"method","modules":[{"name":"Auth0"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"phoneNumber","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"code","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"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"}],"role":"symbol","title":"login(phoneNumber:code:audience:scope:)","required":true},"kind":"symbol","sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(phoneNumber:code:audience:scope:)"},"abstract":[{"text":"Logs a user in using a phone number and an OTP code received via SMS. This is the last part of the passwordless login flow.","type":"text"}],"variants":[{"paths":["\/documentation\/auth0\/authentication\/login(phonenumber:code:audience:scope:)"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"references":{"https://auth0.com/docs/api/authentication":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","title":"Auth0 Authentication API","type":"link","titleInlineContent":[{"text":"Auth0 Authentication API","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"url":"\/documentation\/auth0\/credentials","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"role":"symbol","type":"topic","abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(phoneNumber:code:audience:scope:)":{"abstract":[{"text":"Logs a user in using a phone number and an OTP code received via SMS. This is the last part of the passwordless login flow.","type":"text"}],"url":"\/documentation\/auth0\/authentication\/login(phonenumber:code:audience:scope:)","required":true,"type":"topic","role":"symbol","kind":"symbol","defaultImplementations":1,"title":"login(phoneNumber:code:audience:scope:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"phoneNumber","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"code","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"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"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(phoneNumber:code:audience:scope:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"https://auth0.com/docs/get-started/applications/application-grant-types":{"identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","title":"our documentation","type":"link","titleInlineContent":[{"text":"our documentation","type":"text"}],"url":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(phoneNumber:code:audience:scope:)-8kbii":{"abstract":[{"text":"Logs a user in using a phone number and an OTP code received via SMS. This is the last part of the passwordless login flow.","type":"text"}],"url":"\/documentation\/auth0\/authentication\/login(phonenumber:code:audience:scope:)-8kbii","type":"topic","role":"symbol","kind":"symbol","title":"login(phoneNumber:code:audience:scope:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"phoneNumber","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"code","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"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"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(phoneNumber:code:audience:scope:)-8kbii"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"type":"topic","role":"symbol","title":"Authentication","abstract":[{"text":"Client for the ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"text":".","type":"text"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"https://auth0.com/docs/api/authentication/passwordless/authenticate-user":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/passwordless\/authenticate-user","title":"Authentication API Endpoint","type":"link","titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication\/passwordless\/authenticate-user"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/request","kind":"symbol","abstract":[{"type":"text","text":"Auth0 API request."}]}}} \ No newline at end of file +{"sections":[],"defaultImplementationsSections":[{"title":"Authentication Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(phoneNumber:code:audience:scope:)-8kbii"],"anchor":"Authentication-Implementations"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(phoneNumber:code:audience:scope:)"},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"phoneNumber","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"code","kind":"externalParam"},{"text":": ","kind":"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"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"},{"text":">","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}]},{"parameters":[{"content":[{"type":"paragraph","inlineContent":[{"text":"Phone number the user used to start the passwordless login flow.","type":"text"}]}],"name":"phoneNumber"},{"content":[{"type":"paragraph","inlineContent":[{"text":"One-time password (OTP) code the user received via SMS.","type":"text"}]}],"name":"code"},{"content":[{"type":"paragraph","inlineContent":[{"text":"API Identifier that your application is requesting access to. Defaults to ","type":"text"},{"code":"nil","type":"codeVoice"},{"text":".","type":"text"}]}],"name":"audience"},{"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"}]}],"name":"scope"}],"kind":"parameters"},{"content":[{"type":"heading","level":2,"anchor":"return-value","text":"Return Value"},{"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"},{"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"},{"inlineContent":[{"type":"text","text":"You can also specify audience (the Auth0 API identifier) and scope values:"}],"type":"paragraph"},{"code":["Auth0"," .authentication()"," .login(phoneNumber: \"+12025550135\","," code: \"123456\","," audience: \"https:\/\/example.com\/api\","," scope: \"openid profile email offline_access\")"," .start { print($0) }"],"type":"codeListing","syntax":"swift"},{"style":"note","content":[{"type":"paragraph","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","isActive":true,"type":"reference"},{"text":" for more information.","type":"text"}]}],"type":"aside","name":"Requires"}],"kind":"content"}],"variants":[{"paths":["\/documentation\/auth0\/authentication\/login(phonenumber:code:audience:scope:)"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","metadata":{"symbolKind":"method","roleHeading":"Instance Method","title":"login(phoneNumber:code:audience:scope:)","externalID":"s:5Auth014AuthenticationP5login11phoneNumber4code8audience5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_S2SSgSStF","modules":[{"name":"Auth0"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"phoneNumber","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"code","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"audience"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","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"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"text":">","kind":"text"}],"role":"symbol","required":true},"schemaVersion":{"minor":3,"patch":0,"major":0},"abstract":[{"type":"text","text":"Logs a user in using a phone number and an OTP code received via SMS. This is the last part of the passwordless login flow."}],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication\/passwordless\/authenticate-user"],"anchor":"Related-Documentation"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"references":{"https://auth0.com/docs/api/authentication":{"title":"Auth0 Authentication API","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"type":"link","url":"https:\/\/auth0.com\/docs\/api\/authentication"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"title":"Request","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"abstract":[{"text":"Auth0 API request.","type":"text"}],"url":"\/documentation\/auth0\/request","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","abstract":[{"type":"text","text":"Client for the "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","isActive":true},{"type":"text","text":"."}],"type":"topic","title":"Authentication","url":"\/documentation\/auth0\/authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"Credentials","kind":"identifier"}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}]},"https://auth0.com/docs/get-started/applications/application-grant-types":{"type":"link","titleInlineContent":[{"text":"our documentation","type":"text"}],"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"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(phoneNumber:code:audience:scope:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(phoneNumber:code:audience:scope:)","type":"topic","title":"login(phoneNumber:code:audience:scope:)","role":"symbol","kind":"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"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"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","text":"Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"abstract":[{"type":"text","text":"Logs a user in using a phone number and an OTP code received via SMS. This is the last part of the passwordless login flow."}],"defaultImplementations":1,"url":"\/documentation\/auth0\/authentication\/login(phonenumber:code:audience:scope:)","required":true},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(phoneNumber:code:audience:scope:)-8kbii":{"title":"login(phoneNumber:code:audience:scope:)","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(phoneNumber:code:audience:scope:)-8kbii","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"kind":"externalParam","text":"phoneNumber"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"code"},{"kind":"text","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":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","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":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"abstract":[{"type":"text","text":"Logs a user in 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:)-8kbii"},"https://auth0.com/docs/api/authentication/passwordless/authenticate-user":{"type":"link","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication\/passwordless\/authenticate-user","title":"Authentication API Endpoint","identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/passwordless\/authenticate-user"}}} \ 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 0daa2ef3f..c5cacf85e 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","metadata":{"symbolKind":"method","roleHeading":"Instance Method","title":"login(usernameOrEmail:password:realmOrConnection:audience:scope:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"kind":"externalParam","text":"usernameOrEmail"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"password"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"realmOrConnection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"extendedModule":"Auth0","modules":[{"name":"Auth0"}],"role":"symbol","externalID":"s:5Auth014AuthenticationPAAE5login15usernameOrEmail8password05realmE10Connection8audience5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_S3SSgSStF"},"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(usernameOrEmail:password:realmOrConnection:audience:scope:)-8kdlq"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication\/resource-owner-password-flow\/get-token"],"anchor":"Related-Documentation"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"kind":"externalParam","text":"usernameOrEmail"},{"kind":"text","text":" "},{"kind":"internalParam","text":"username"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"password"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"realmOrConnection"},{"kind":"text","text":" "},{"kind":"internalParam","text":"realm"},{"kind":"text","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":"? = nil, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" = defaultScope) -> "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"},{"kind":"text","text":", "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"platforms":["iOS"],"languages":["swift"]}]},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Username or email of the user."}]}],"name":"username"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Password of the user."}]}],"name":"password"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Domain of the realm or connection name."}]}],"name":"realm"},{"content":[{"inlineContent":[{"text":"API Identifier that your application is requesting access to.","type":"text"}],"type":"paragraph"}],"name":"audience"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Space-separated list of requested scope values."}]}],"name":"scope"}]},{"kind":"content","content":[{"type":"heading","text":"Return Value","level":2,"anchor":"return-value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Request that will yield Auth0 user’s credentials."}]}]},{"kind":"content","content":[{"anchor":"Usage","type":"heading","level":2,"text":"Usage"},{"syntax":"swift","type":"codeListing","code":["Auth0"," .authentication()"," .login(usernameOrEmail: \"support@auth0.com\","," password: \"secret-password\","," realmOrConnection: \"MyDatabase\")"," .start { result in"," switch result {"," case .success(let credentials):"," print(\"Obtained credentials: \\(credentials)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"]},{"inlineContent":[{"text":"You can also specify audience (the Auth0 API identifier) and scope values:","type":"text"}],"type":"paragraph"},{"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) }"]},{"name":"Requires","content":[{"type":"paragraph","inlineContent":[{"text":"The ","type":"text"},{"code":"http:\/\/auth0.com\/oauth\/grant-type\/password-realm","type":"codeVoice"},{"text":" grant. Check","type":"text"},{"text":" ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types"},{"text":" for more information.","type":"text"}]}],"style":"note","type":"aside"}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/login(usernameoremail:password:realmorconnection:audience:scope:)-8kdlq"]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"abstract":[{"type":"text","text":"Logs a user in using a username and password with a realm or connection."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Request":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/request","kind":"symbol","abstract":[{"type":"text","text":"Auth0 API request."}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"url":"\/documentation\/auth0\/credentials","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"role":"symbol","type":"topic","abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"https://auth0.com/docs/api/authentication/resource-owner-password-flow/get-token":{"url":"https:\/\/auth0.com\/docs\/api\/authentication\/resource-owner-password-flow\/get-token","type":"link","title":"Authentication API Endpoint","identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/resource-owner-password-flow\/get-token","titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}]},"doc://com.auth0.Auth0/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","abstract":[{"text":"Logs a user in using a username and password with a realm or connection.","type":"text"}],"role":"symbol","url":"\/documentation\/auth0\/authentication\/login(usernameoremail:password:realmorconnection:audience:scope:)-8kdlq","kind":"symbol","title":"login(usernameOrEmail:password:realmOrConnection:audience:scope:)","type":"topic","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"kind":"externalParam","text":"usernameOrEmail"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"password"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"realmOrConnection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","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":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}]},"https://auth0.com/docs/api/authentication":{"url":"https:\/\/auth0.com\/docs\/api\/authentication","type":"link","title":"Auth0 Authentication API","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","titleInlineContent":[{"text":"Auth0 Authentication API","type":"text"}]},"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","identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","titleInlineContent":[{"text":"our documentation","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"type":"topic","role":"symbol","title":"Authentication","abstract":[{"text":"Client for the ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"text":".","type":"text"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"variants":[{"paths":["\/documentation\/auth0\/authentication\/login(usernameoremail:password:realmorconnection:audience:scope:)-8kdlq"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"abstract":[{"text":"Logs a user in using a username and password with a realm or connection.","type":"text"}],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"kind":"externalParam","text":"usernameOrEmail"},{"kind":"text","text":" "},{"kind":"internalParam","text":"username"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"password"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"realmOrConnection"},{"kind":"text","text":" "},{"kind":"internalParam","text":"realm"},{"kind":"text","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":"? = nil, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" = defaultScope) -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","text":"Request"},{"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":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"},{"kind":"text","text":">"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Username or email of the user."}]}],"name":"username"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Password of the user."}]}],"name":"password"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Domain of the realm or connection name."}]}],"name":"realm"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"API Identifier that your application is requesting access to."}]}],"name":"audience"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Space-separated list of requested scope values."}]}],"name":"scope"}]},{"kind":"content","content":[{"type":"heading","text":"Return Value","anchor":"return-value","level":2},{"type":"paragraph","inlineContent":[{"type":"text","text":"Request that will yield Auth0 user’s credentials."}]}]},{"kind":"content","content":[{"type":"heading","text":"Usage","anchor":"Usage","level":2},{"type":"codeListing","code":["Auth0"," .authentication()"," .login(usernameOrEmail: \"support@auth0.com\","," password: \"secret-password\","," realmOrConnection: \"MyDatabase\")"," .start { result in"," switch result {"," case .success(let credentials):"," print(\"Obtained credentials: \\(credentials)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"],"syntax":"swift"},{"type":"paragraph","inlineContent":[{"type":"text","text":"You can also specify audience (the Auth0 API identifier) and scope values:"}]},{"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) }"],"syntax":"swift"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"code":"http:\/\/auth0.com\/oauth\/grant-type\/password-realm","type":"codeVoice"},{"type":"text","text":" grant. Check"},{"type":"text","text":" "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types"},{"type":"text","text":" for more information."}]}],"type":"aside","name":"Requires","style":"note"}]}],"schemaVersion":{"patch":0,"minor":3,"major":0},"kind":"symbol","sections":[],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication\/resource-owner-password-flow\/get-token"],"anchor":"Related-Documentation"}],"metadata":{"modules":[{"name":"Auth0"}],"externalID":"s:5Auth014AuthenticationPAAE5login15usernameOrEmail8password05realmE10Connection8audience5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_S3SSgSStF","title":"login(usernameOrEmail:password:realmOrConnection:audience:scope:)","extendedModule":"Auth0","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"kind":"externalParam","text":"usernameOrEmail"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"password"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"realmOrConnection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","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":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"role":"symbol","symbolKind":"method"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(usernameOrEmail:password:realmOrConnection:audience:scope:)-8kdlq","interfaceLanguage":"swift"},"references":{"https://auth0.com/docs/api/authentication":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","url":"https:\/\/auth0.com\/docs\/api\/authentication","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"type":"link","title":"Auth0 Authentication API"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"title":"Request","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"abstract":[{"text":"Auth0 API request.","type":"text"}],"url":"\/documentation\/auth0\/request","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"Credentials","kind":"identifier"}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(usernameOrEmail:password:realmOrConnection:audience:scope:)-8kdlq":{"type":"topic","title":"login(usernameOrEmail:password:realmOrConnection:audience:scope:)","url":"\/documentation\/auth0\/authentication\/login(usernameoremail:password:realmorconnection:audience:scope:)-8kdlq","kind":"symbol","abstract":[{"text":"Logs a user in using a username and password with a realm or connection.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(usernameOrEmail:password:realmOrConnection:audience:scope:)-8kdlq","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"usernameOrEmail","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"password","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"realmOrConnection","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}]},"https://auth0.com/docs/get-started/applications/application-grant-types":{"identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","url":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","titleInlineContent":[{"type":"text","text":"our documentation"}],"type":"link","title":"our documentation"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","abstract":[{"type":"text","text":"Client for the "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","isActive":true},{"type":"text","text":"."}],"type":"topic","title":"Authentication","url":"\/documentation\/auth0\/authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"https://auth0.com/docs/api/authentication/resource-owner-password-flow/get-token":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/resource-owner-password-flow\/get-token","url":"https:\/\/auth0.com\/docs\/api\/authentication\/resource-owner-password-flow\/get-token","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"type":"link","title":"Authentication API Endpoint"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authentication/login(usernameoremail:password:realmorconnection:audience:scope:).json b/docs/data/documentation/auth0/authentication/login(usernameoremail:password:realmorconnection:audience:scope:).json index c00605927..d16196174 100644 --- a/docs/data/documentation/auth0/authentication/login(usernameoremail:password:realmorconnection:audience:scope:).json +++ b/docs/data/documentation/auth0/authentication/login(usernameoremail:password:realmorconnection:audience:scope:).json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"kind":"externalParam","text":"usernameOrEmail"},{"kind":"text","text":" "},{"text":"username","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"password","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"realmOrConnection","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"realm","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"Credentials","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"text":", ","kind":"text"},{"text":"AuthenticationError","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}]}]},{"parameters":[{"content":[{"inlineContent":[{"type":"text","text":"Username or email of the user."}],"type":"paragraph"}],"name":"username"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Password of the user."}]}],"name":"password"},{"content":[{"inlineContent":[{"text":"Domain of the realm or connection name.","type":"text"}],"type":"paragraph"}],"name":"realm"},{"content":[{"inlineContent":[{"type":"text","text":"API Identifier that your application is requesting access to."}],"type":"paragraph"}],"name":"audience"},{"content":[{"inlineContent":[{"type":"text","text":"Space-separated list of requested scope values."}],"type":"paragraph"}],"name":"scope"}],"kind":"parameters"},{"content":[{"type":"heading","level":2,"anchor":"return-value","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Request that will yield Auth0 user’s credentials."}]}],"kind":"content"},{"content":[{"anchor":"Usage","type":"heading","level":2,"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"},{"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","type":"aside","style":"note","content":[{"type":"paragraph","inlineContent":[{"text":"The ","type":"text"},{"type":"codeVoice","code":"http:\/\/auth0.com\/oauth\/grant-type\/password-realm"},{"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"}]}]}],"kind":"content"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(usernameOrEmail:password:realmOrConnection:audience:scope:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Logs a user in using a username and password with a realm or connection."}],"metadata":{"title":"login(usernameOrEmail:password:realmOrConnection:audience:scope:)","required":true,"externalID":"s:5Auth014AuthenticationP5login15usernameOrEmail8password05realmE10Connection8audience5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_S3SSgSStF","symbolKind":"method","roleHeading":"Instance Method","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"usernameOrEmail","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"password","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","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"},{"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"},{"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"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"modules":[{"name":"Auth0"}]},"defaultImplementationsSections":[{"title":"Authentication Implementations","anchor":"Authentication-Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(usernameOrEmail:password:realmOrConnection:audience:scope:)-8kdlq"]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/login(usernameoremail:password:realmorconnection:audience:scope:)"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"sections":[],"schemaVersion":{"major":0,"patch":0,"minor":3},"seeAlsoSections":[{"title":"Related Documentation","anchor":"Related-Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication\/resource-owner-password-flow\/get-token"]}],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"type":"topic","role":"symbol","title":"Authentication","abstract":[{"text":"Client for the ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"text":".","type":"text"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"https://auth0.com/docs/api/authentication":{"type":"link","url":"https:\/\/auth0.com\/docs\/api\/authentication","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","title":"Auth0 Authentication API"},"https://auth0.com/docs/api/authentication/resource-owner-password-flow/get-token":{"url":"https:\/\/auth0.com\/docs\/api\/authentication\/resource-owner-password-flow\/get-token","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/resource-owner-password-flow\/get-token","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"title":"Authentication API Endpoint"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"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","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/Credentials":{"title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"url":"\/documentation\/auth0\/credentials","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"role":"symbol","type":"topic","abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/request","kind":"symbol","abstract":[{"type":"text","text":"Auth0 API request."}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(usernameOrEmail:password:realmOrConnection:audience:scope:)":{"abstract":[{"type":"text","text":"Logs a user in using a username and password with a realm or connection."}],"kind":"symbol","required":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(usernameOrEmail:password:realmOrConnection:audience:scope:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"usernameOrEmail","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"password","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"realmOrConnection"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","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","kind":"typeIdentifier","text":"AuthenticationError"},{"kind":"text","text":">"}],"type":"topic","defaultImplementations":1,"title":"login(usernameOrEmail:password:realmOrConnection:audience:scope:)","url":"\/documentation\/auth0\/authentication\/login(usernameoremail:password:realmorconnection:audience:scope:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/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","abstract":[{"text":"Logs a user in using a username and password with a realm or connection.","type":"text"}],"role":"symbol","url":"\/documentation\/auth0\/authentication\/login(usernameoremail:password:realmorconnection:audience:scope:)-8kdlq","kind":"symbol","title":"login(usernameOrEmail:password:realmOrConnection:audience:scope:)","type":"topic","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"kind":"externalParam","text":"usernameOrEmail"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"password"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"realmOrConnection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","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":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}]}}} \ No newline at end of file +{"metadata":{"symbolKind":"method","title":"login(usernameOrEmail:password:realmOrConnection:audience:scope:)","externalID":"s:5Auth014AuthenticationP5login15usernameOrEmail8password05realmE10Connection8audience5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_S3SSgSStF","roleHeading":"Instance Method","modules":[{"name":"Auth0"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"usernameOrEmail","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"password","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","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"},{"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"},{"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"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"role":"symbol","required":true},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/login(usernameoremail:password:realmorconnection:audience:scope:)"]}],"defaultImplementationsSections":[{"title":"Authentication Implementations","anchor":"Authentication-Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(usernameOrEmail:password:realmOrConnection:audience:scope:)-8kdlq"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(usernameOrEmail:password:realmOrConnection:audience:scope:)"},"kind":"symbol","abstract":[{"text":"Logs a user in using a username and password with a realm or connection.","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"seeAlsoSections":[{"title":"Related Documentation","anchor":"Related-Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication\/resource-owner-password-flow\/get-token"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"usernameOrEmail","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"username","kind":"internalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"password","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"realmOrConnection","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"realm","kind":"internalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"},{"text":">","kind":"text"}],"platforms":["iOS"]}]},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Username or email of the user."}]}],"name":"username"},{"content":[{"type":"paragraph","inlineContent":[{"text":"Password of the user.","type":"text"}]}],"name":"password"},{"name":"realm","content":[{"inlineContent":[{"type":"text","text":"Domain of the realm or connection name."}],"type":"paragraph"}]},{"name":"audience","content":[{"inlineContent":[{"type":"text","text":"API Identifier that your application is requesting access to."}],"type":"paragraph"}]},{"name":"scope","content":[{"inlineContent":[{"text":"Space-separated list of requested scope values.","type":"text"}],"type":"paragraph"}]}]},{"content":[{"anchor":"return-value","text":"Return Value","type":"heading","level":2},{"inlineContent":[{"text":"Request that will yield Auth0 user’s credentials.","type":"text"}],"type":"paragraph"}],"kind":"content"},{"content":[{"anchor":"Usage","text":"Usage","type":"heading","level":2},{"syntax":"swift","code":["Auth0"," .authentication()"," .login(usernameOrEmail: \"support@auth0.com\","," password: \"secret-password\","," realmOrConnection: \"MyDatabase\")"," .start { result in"," switch result {"," case .success(let credentials):"," print(\"Obtained credentials: \\(credentials)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"],"type":"codeListing"},{"inlineContent":[{"text":"You can also specify audience (the Auth0 API identifier) and scope values:","type":"text"}],"type":"paragraph"},{"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) }"]},{"name":"Requires","type":"aside","style":"note","content":[{"type":"paragraph","inlineContent":[{"text":"The ","type":"text"},{"code":"http:\/\/auth0.com\/oauth\/grant-type\/password-realm","type":"codeVoice"},{"text":" grant. Check","type":"text"},{"text":" ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","isActive":true,"type":"reference"},{"text":" for more information.","type":"text"}]}]}],"kind":"content"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(usernameOrEmail:password:realmOrConnection:audience:scope:)-8kdlq":{"type":"topic","title":"login(usernameOrEmail:password:realmOrConnection:audience:scope:)","url":"\/documentation\/auth0\/authentication\/login(usernameoremail:password:realmorconnection:audience:scope:)-8kdlq","kind":"symbol","abstract":[{"text":"Logs a user in using a username and password with a realm or connection.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(usernameOrEmail:password:realmOrConnection:audience:scope:)-8kdlq","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"usernameOrEmail","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"password","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"realmOrConnection","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(usernameOrEmail:password:realmOrConnection:audience:scope:)":{"defaultImplementations":1,"type":"topic","title":"login(usernameOrEmail:password:realmOrConnection:audience:scope:)","url":"\/documentation\/auth0\/authentication\/login(usernameoremail:password:realmorconnection:audience:scope:)","kind":"symbol","abstract":[{"text":"Logs a user in using a username and password with a realm or connection.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(usernameOrEmail:password:realmOrConnection:audience:scope:)","required":true,"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"usernameOrEmail","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"password","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"realmOrConnection","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","abstract":[{"type":"text","text":"Client for the "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","isActive":true},{"type":"text","text":"."}],"type":"topic","title":"Authentication","url":"\/documentation\/auth0\/authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"Credentials","kind":"identifier"}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"title":"Request","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"abstract":[{"text":"Auth0 API request.","type":"text"}],"url":"\/documentation\/auth0\/request","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"https://auth0.com/docs/api/authentication":{"url":"https:\/\/auth0.com\/docs\/api\/authentication","type":"link","title":"Auth0 Authentication API","titleInlineContent":[{"text":"Auth0 Authentication API","type":"text"}],"identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},"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"},"https://auth0.com/docs/api/authentication/resource-owner-password-flow/get-token":{"url":"https:\/\/auth0.com\/docs\/api\/authentication\/resource-owner-password-flow\/get-token","type":"link","title":"Authentication API Endpoint","titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}],"identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/resource-owner-password-flow\/get-token"}}} \ 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 6a0f6bef4..8ae6fe94f 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":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withOOBCode:mfaToken:bindingCode:)-3ykhg","interfaceLanguage":"swift"},"seeAlsoSections":[{"title":"Related Documentation","anchor":"Related-Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication\/muti-factor-authentication\/verify-with-out-of-band"]}],"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/authentication\/login(withoobcode:mfatoken:bindingcode:)-3ykhg"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"metadata":{"symbolKind":"method","role":"symbol","modules":[{"name":"Auth0"}],"externalID":"s:5Auth014AuthenticationPAAE5login11withOOBCode8mfaToken11bindingCodeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_S2SSgtF","roleHeading":"Instance Method","title":"login(withOOBCode:mfaToken:bindingCode:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withOOBCode","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"mfaToken","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"bindingCode","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?) -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"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"}],"extendedModule":"Auth0"},"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withOOBCode"},{"kind":"text","text":" "},{"kind":"internalParam","text":"oobCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"mfaToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"bindingCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"? = nil) -> "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","kind":"typeIdentifier","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":", "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"platforms":["iOS"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"oobCode","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The OOB code received from the challenge request."}]}]},{"name":"mfaToken","content":[{"inlineContent":[{"type":"text","text":"Token returned when authentication fails with an "},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired"},{"type":"text","text":" error due to MFA requirement."}],"type":"paragraph"}]},{"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"}]}]}]},{"content":[{"level":2,"text":"Return Value","anchor":"return-value","type":"heading"},{"inlineContent":[{"type":"text","text":"A request that will yield Auth0 user’s credentials."}],"type":"paragraph"}],"kind":"content"},{"content":[{"anchor":"Usage","type":"heading","level":2,"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"},{"type":"aside","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"},{"identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","isActive":true,"type":"reference"},{"text":" for more information.","type":"text"}]}],"style":"note","name":"Requires"}],"kind":"content"}],"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"}],"sections":[],"schemaVersion":{"major":0,"patch":0,"minor":3},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Request":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/request","kind":"symbol","abstract":[{"type":"text","text":"Auth0 API request."}]},"https://auth0.com/docs/api/authentication/muti-factor-authentication/verify-with-out-of-band":{"type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/muti-factor-authentication\/verify-with-out-of-band","title":"Authentication API Endpoint","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication\/muti-factor-authentication\/verify-with-out-of-band"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(withOOBCode:mfaToken:bindingCode:)-3ykhg":{"url":"\/documentation\/auth0\/authentication\/login(withoobcode:mfatoken:bindingcode:)-3ykhg","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withOOBCode","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"mfaToken","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"bindingCode","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?) -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"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"}],"type":"topic","title":"login(withOOBCode:mfaToken:bindingCode:)","role":"symbol","abstract":[{"type":"text","text":"Verifies multi-factor authentication (MFA) using an out-of-band (OOB) challenge (either push notification, SMS"},{"type":"text","text":" "},{"type":"text","text":"or voice)."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withOOBCode:mfaToken:bindingCode:)-3ykhg"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"url":"\/documentation\/auth0\/credentials","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"role":"symbol","type":"topic","abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"type":"topic","role":"symbol","title":"Authentication","abstract":[{"text":"Client for the ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"text":".","type":"text"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorRequired":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired","type":"topic","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isMultifactorRequired","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror\/ismultifactorrequired","abstract":[{"text":"When MFA is required to authenticate.","type":"text"}],"title":"isMultifactorRequired"},"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"},"https://auth0.com/docs/get-started/applications/application-grant-types":{"identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","titleInlineContent":[{"type":"text","text":"our documentation"}],"type":"link","title":"our documentation","url":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"metadata":{"extendedModule":"Auth0","symbolKind":"method","modules":[{"name":"Auth0"}],"title":"login(withOOBCode:mfaToken:bindingCode:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withOOBCode","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"mfaToken","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"bindingCode","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"externalID":"s:5Auth014AuthenticationPAAE5login11withOOBCode8mfaToken11bindingCodeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_S2SSgtF","role":"symbol","roleHeading":"Instance Method"},"sections":[],"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"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/login(withoobcode:mfatoken:bindingcode:)-3ykhg"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withOOBCode:mfaToken:bindingCode:)-3ykhg"},"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication\/muti-factor-authentication\/verify-with-out-of-band"],"anchor":"Related-Documentation"}],"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"text":"(","kind":"text"},{"text":"withOOBCode","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"oobCode","kind":"internalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"mfaToken"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"bindingCode","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"? = nil) -> "},{"preciseIdentifier":"s:5Auth07RequestV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier","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":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","kind":"typeIdentifier","text":"AuthenticationError"},{"kind":"text","text":">"}],"platforms":["iOS"]}],"kind":"declarations"},{"parameters":[{"content":[{"inlineContent":[{"text":"The OOB code received from the challenge request.","type":"text"}],"type":"paragraph"}],"name":"oobCode"},{"content":[{"inlineContent":[{"text":"Token returned when authentication fails with an ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired","isActive":true,"type":"reference"},{"text":" error due to MFA requirement.","type":"text"}],"type":"paragraph"}],"name":"mfaToken"},{"content":[{"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"}],"type":"paragraph"}],"name":"bindingCode"}],"kind":"parameters"},{"content":[{"level":2,"type":"heading","anchor":"return-value","text":"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"},{"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)\")"," }"," }"]},{"type":"aside","content":[{"inlineContent":[{"text":"The ","type":"text"},{"code":"http:\/\/auth0.com\/oauth\/grant-type\/mfa-oob","type":"codeVoice"},{"text":" grant. Check","type":"text"},{"text":" ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","isActive":true,"type":"reference"},{"text":" for more information.","type":"text"}],"type":"paragraph"}],"name":"Requires","style":"note"}],"kind":"content"}],"references":{"https://auth0.com/docs/api/authentication":{"title":"Auth0 Authentication API","url":"https:\/\/auth0.com\/docs\/api\/authentication","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(withOOBCode:mfaToken:bindingCode:)-3ykhg":{"type":"topic","title":"login(withOOBCode:mfaToken:bindingCode:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withOOBCode:mfaToken:bindingCode:)-3ykhg","url":"\/documentation\/auth0\/authentication\/login(withoobcode:mfatoken:bindingcode:)-3ykhg","kind":"symbol","abstract":[{"type":"text","text":"Verifies multi-factor authentication (MFA) using an out-of-band (OOB) challenge (either push notification, SMS"},{"type":"text","text":" "},{"type":"text","text":"or voice)."}],"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withOOBCode","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"mfaToken","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"bindingCode","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"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"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"},"https://auth0.com/docs/api/authentication/muti-factor-authentication/verify-with-out-of-band":{"title":"Authentication API Endpoint","url":"https:\/\/auth0.com\/docs\/api\/authentication\/muti-factor-authentication\/verify-with-out-of-band","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/muti-factor-authentication\/verify-with-out-of-band","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"title":"Request","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"abstract":[{"text":"Auth0 API request.","type":"text"}],"url":"\/documentation\/auth0\/request","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","abstract":[{"type":"text","text":"Client for the "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","isActive":true},{"type":"text","text":"."}],"type":"topic","title":"Authentication","url":"\/documentation\/auth0\/authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"Credentials","kind":"identifier"}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorRequired":{"type":"topic","title":"isMultifactorRequired","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired","kind":"symbol","url":"\/documentation\/auth0\/authenticationerror\/ismultifactorrequired","abstract":[{"type":"text","text":"When MFA is required to authenticate."}],"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isMultifactorRequired"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}]},"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","identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","titleInlineContent":[{"type":"text","text":"our documentation"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authentication/login(withoobcode:mfatoken:bindingcode:).json b/docs/data/documentation/auth0/authentication/login(withoobcode:mfatoken:bindingcode:).json index f5bf7f410..efd1a4bce 100644 --- a/docs/data/documentation/auth0/authentication/login(withoobcode:mfatoken:bindingcode:).json +++ b/docs/data/documentation/auth0/authentication/login(withoobcode:mfatoken:bindingcode:).json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"seeAlsoSections":[{"anchor":"Related-Documentation","title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication\/muti-factor-authentication\/verify-with-out-of-band"]}],"metadata":{"roleHeading":"Instance Method","symbolKind":"method","externalID":"s:5Auth014AuthenticationP5login11withOOBCode8mfaToken11bindingCodeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_S2SSgtF","title":"login(withOOBCode:mfaToken:bindingCode:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withOOBCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"mfaToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"bindingCode","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?) -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"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"}],"modules":[{"name":"Auth0"}],"role":"symbol","required":true},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withOOBCode:mfaToken:bindingCode:)"},"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withOOBCode"},{"kind":"text","text":" "},{"kind":"internalParam","text":"oobCode"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","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":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?) -> "},{"preciseIdentifier":"s:5Auth07RequestV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier","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":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","kind":"typeIdentifier","text":"AuthenticationError"},{"kind":"text","text":">"}]}]},{"parameters":[{"name":"oobCode","content":[{"inlineContent":[{"type":"text","text":"The OOB code received from the challenge request."}],"type":"paragraph"}]},{"name":"mfaToken","content":[{"inlineContent":[{"type":"text","text":"Token returned when authentication fails with an "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired"},{"type":"text","text":" error due to MFA requirement."}],"type":"paragraph"}]},{"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"},{"kind":"content","content":[{"level":2,"text":"Return Value","anchor":"return-value","type":"heading"},{"inlineContent":[{"type":"text","text":"A request that will yield Auth0 user’s credentials."}],"type":"paragraph"}]},{"kind":"content","content":[{"type":"heading","level":2,"text":"Usage","anchor":"Usage"},{"type":"codeListing","code":["Auth0"," .authentication()"," .login(withOOBCode: \"123456\", mfaToken: \"mfa-token\")"," .start { result in"," switch result {"," case .success(let credentials):"," print(\"Obtained credentials: \\(credentials)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"],"syntax":"swift"},{"type":"aside","style":"note","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"type":"codeVoice","code":"http:\/\/auth0.com\/oauth\/grant-type\/mfa-oob"},{"type":"text","text":" grant. Check"},{"type":"text","text":" "},{"type":"reference","isActive":true,"identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types"},{"type":"text","text":" for more information."}]}],"name":"Requires"}]}],"variants":[{"paths":["\/documentation\/auth0\/authentication\/login(withoobcode:mfatoken:bindingcode:)"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","abstract":[{"type":"text","text":"Verifies multi-factor authentication (MFA) using an out-of-band (OOB) challenge (either push notification, SMS"},{"type":"text","text":" "},{"type":"text","text":"or voice)."}],"schemaVersion":{"major":0,"minor":3,"patch":0},"defaultImplementationsSections":[{"anchor":"Authentication-Implementations","title":"Authentication Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withOOBCode:mfaToken:bindingCode:)-3ykhg"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorRequired":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired","type":"topic","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isMultifactorRequired","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror\/ismultifactorrequired","abstract":[{"text":"When MFA is required to authenticate.","type":"text"}],"title":"isMultifactorRequired"},"https://auth0.com/docs/api/authentication/muti-factor-authentication/verify-with-out-of-band":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/muti-factor-authentication\/verify-with-out-of-band","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"title":"Authentication API Endpoint","type":"link","url":"https:\/\/auth0.com\/docs\/api\/authentication\/muti-factor-authentication\/verify-with-out-of-band"},"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"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"type":"topic","role":"symbol","title":"Authentication","abstract":[{"text":"Client for the ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"text":".","type":"text"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"url":"\/documentation\/auth0\/credentials","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"role":"symbol","type":"topic","abstract":[{"text":"User’s credentials obtained from Auth0.","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/login(withOOBCode:mfaToken:bindingCode:)":{"url":"\/documentation\/auth0\/authentication\/login(withoobcode:mfatoken:bindingcode:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withOOBCode:mfaToken:bindingCode:)","type":"topic","required":true,"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withOOBCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"mfaToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"bindingCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","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":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"title":"login(withOOBCode:mfaToken:bindingCode:)","defaultImplementations":1,"abstract":[{"type":"text","text":"Verifies multi-factor authentication (MFA) using an out-of-band (OOB) challenge (either push notification, SMS"},{"type":"text","text":" "},{"type":"text","text":"or voice)."}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(withOOBCode:mfaToken:bindingCode:)-3ykhg":{"url":"\/documentation\/auth0\/authentication\/login(withoobcode:mfatoken:bindingcode:)-3ykhg","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withOOBCode","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"mfaToken","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"bindingCode","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?) -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"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"}],"type":"topic","title":"login(withOOBCode:mfaToken:bindingCode:)","role":"symbol","abstract":[{"type":"text","text":"Verifies multi-factor authentication (MFA) using an out-of-band (OOB) challenge (either push notification, SMS"},{"type":"text","text":" "},{"type":"text","text":"or voice)."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withOOBCode:mfaToken:bindingCode:)-3ykhg"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/request","kind":"symbol","abstract":[{"type":"text","text":"Auth0 API request."}]}}} \ No newline at end of file +{"metadata":{"symbolKind":"method","title":"login(withOOBCode:mfaToken:bindingCode:)","externalID":"s:5Auth014AuthenticationP5login11withOOBCode8mfaToken11bindingCodeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_S2SSgtF","roleHeading":"Instance Method","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withOOBCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"mfaToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"bindingCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?) -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"kind":"text","text":"<"},{"text":"Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","text":"AuthenticationError"},{"kind":"text","text":">"}],"role":"symbol","required":true},"sections":[],"variants":[{"paths":["\/documentation\/auth0\/authentication\/login(withoobcode:mfatoken:bindingcode:)"],"traits":[{"interfaceLanguage":"swift"}]}],"defaultImplementationsSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withOOBCode:mfaToken:bindingCode:)-3ykhg"],"title":"Authentication Implementations","anchor":"Authentication-Implementations"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withOOBCode:mfaToken:bindingCode:)","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"type":"text","text":"Verifies multi-factor authentication (MFA) using an out-of-band (OOB) challenge (either push notification, SMS"},{"type":"text","text":" "},{"type":"text","text":"or voice)."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/api\/authentication\/muti-factor-authentication\/verify-with-out-of-band"],"title":"Related Documentation","anchor":"Related-Documentation"}],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withOOBCode"},{"kind":"text","text":" "},{"kind":"internalParam","text":"oobCode"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","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":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?) -> "},{"preciseIdentifier":"s:5Auth07RequestV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier","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":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","kind":"typeIdentifier","text":"AuthenticationError"},{"kind":"text","text":">"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"type":"text","text":"The OOB code received from the challenge request."}],"type":"paragraph"}],"name":"oobCode"},{"content":[{"inlineContent":[{"type":"text","text":"Token returned when authentication fails with an "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired","isActive":true},{"type":"text","text":" error due to MFA requirement."}],"type":"paragraph"}],"name":"mfaToken"},{"content":[{"inlineContent":[{"type":"text","text":"A code used to bind the side channel (used to deliver the challenge) with the main channel you are using to authenticate. This is usually an OTP-like code delivered as part of the challenge message."}],"type":"paragraph"}],"name":"bindingCode"}]},{"kind":"content","content":[{"type":"heading","text":"Return Value","anchor":"return-value","level":2},{"type":"paragraph","inlineContent":[{"type":"text","text":"A request that will yield Auth0 user’s credentials."}]}]},{"kind":"content","content":[{"type":"heading","text":"Usage","anchor":"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"},{"content":[{"inlineContent":[{"type":"text","text":"The "},{"type":"codeVoice","code":"http:\/\/auth0.com\/oauth\/grant-type\/mfa-oob"},{"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."}],"type":"paragraph"}],"type":"aside","name":"Requires","style":"note"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"https://auth0.com/docs/api/authentication/muti-factor-authentication/verify-with-out-of-band":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/muti-factor-authentication\/verify-with-out-of-band","url":"https:\/\/auth0.com\/docs\/api\/authentication\/muti-factor-authentication\/verify-with-out-of-band","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"type":"link","title":"Authentication API Endpoint"},"https://auth0.com/docs/api/authentication":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","url":"https:\/\/auth0.com\/docs\/api\/authentication","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"type":"link","title":"Auth0 Authentication API"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(withOOBCode:mfaToken:bindingCode:)-3ykhg":{"type":"topic","title":"login(withOOBCode:mfaToken:bindingCode:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withOOBCode:mfaToken:bindingCode:)-3ykhg","url":"\/documentation\/auth0\/authentication\/login(withoobcode:mfatoken:bindingcode:)-3ykhg","kind":"symbol","abstract":[{"type":"text","text":"Verifies multi-factor authentication (MFA) using an out-of-band (OOB) challenge (either push notification, SMS"},{"type":"text","text":" "},{"type":"text","text":"or voice)."}],"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withOOBCode","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"mfaToken","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"bindingCode","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"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"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"Credentials","kind":"identifier"}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(withOOBCode:mfaToken:bindingCode:)":{"defaultImplementations":1,"type":"topic","title":"login(withOOBCode:mfaToken:bindingCode:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withOOBCode:mfaToken:bindingCode:)","url":"\/documentation\/auth0\/authentication\/login(withoobcode:mfatoken:bindingcode:)","kind":"symbol","abstract":[{"type":"text","text":"Verifies multi-factor authentication (MFA) using an out-of-band (OOB) challenge (either push notification, SMS"},{"type":"text","text":" "},{"type":"text","text":"or voice)."}],"required":true,"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withOOBCode","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"mfaToken","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"bindingCode","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"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"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","abstract":[{"type":"text","text":"Client for the "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","isActive":true},{"type":"text","text":"."}],"type":"topic","title":"Authentication","url":"\/documentation\/auth0\/authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorRequired":{"type":"topic","title":"isMultifactorRequired","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired","kind":"symbol","url":"\/documentation\/auth0\/authenticationerror\/ismultifactorrequired","abstract":[{"type":"text","text":"When MFA is required to authenticate."}],"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isMultifactorRequired"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"title":"Request","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"abstract":[{"text":"Auth0 API request.","type":"text"}],"url":"\/documentation\/auth0\/request","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"https://auth0.com/docs/get-started/applications/application-grant-types":{"identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","url":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","titleInlineContent":[{"type":"text","text":"our documentation"}],"type":"link","title":"our documentation"}}} \ 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 b667125be..7da9ba03d 100644 --- a/docs/data/documentation/auth0/authentication/login(withotp:mfatoken:).json +++ b/docs/data/documentation/auth0/authentication/login(withotp:mfatoken:).json @@ -1 +1 @@ -{"abstract":[{"text":"Verifies multi-factor authentication (MFA) using a one-time password (OTP).","type":"text"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withOTP:mfaToken:)"},"variants":[{"paths":["\/documentation\/auth0\/authentication\/login(withotp:mfatoken:)"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withOTP","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"otp","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"mfaToken","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","preciseIdentifier":"s:5Auth07RequestV","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"},{"text":"AuthenticationError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"},{"parameters":[{"name":"otp","content":[{"inlineContent":[{"text":"One-time password supplied by a MFA authenticator.","type":"text"}],"type":"paragraph"}]},{"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"},{"type":"text","text":" error due to MFA requirement."}]}]}],"kind":"parameters"},{"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":[{"type":"heading","anchor":"Usage","level":2,"text":"Usage"},{"type":"codeListing","code":["Auth0"," .authentication()"," .login(withOTP: \"123456\", mfaToken: \"mfa-token\")"," .start { result in"," switch result {"," case .success(let credentials):"," print(\"Obtained credentials: \\(credentials)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"],"syntax":"swift"},{"type":"aside","name":"Requires","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"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"}],"metadata":{"title":"login(withOTP:mfaToken:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withOTP","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"mfaToken","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"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"}],"required":true,"roleHeading":"Instance Method","symbolKind":"method","role":"symbol","externalID":"s:5Auth014AuthenticationP5login7withOTP8mfaTokenAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_SStF","modules":[{"name":"Auth0"}]},"schemaVersion":{"minor":3,"patch":0,"major":0},"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\/muti-factor-authentication\/verify-mfa-with-otp"],"title":"Related Documentation","anchor":"Related-Documentation"}],"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Request":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/request","kind":"symbol","abstract":[{"type":"text","text":"Auth0 API request."}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"type":"topic","role":"symbol","title":"Authentication","abstract":[{"text":"Client for the ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"text":".","type":"text"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"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/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(withOTP:mfaToken:)":{"role":"symbol","abstract":[{"type":"text","text":"Verifies multi-factor authentication (MFA) using a one-time password (OTP)."}],"kind":"symbol","title":"login(withOTP:mfaToken:)","url":"\/documentation\/auth0\/authentication\/login(withotp:mfatoken:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withOTP:mfaToken:)","required":true,"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withOTP","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"mfaToken","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"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"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"url":"\/documentation\/auth0\/credentials","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"role":"symbol","type":"topic","abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}]},"https://auth0.com/docs/api/authentication/muti-factor-authentication/verify-mfa-with-otp":{"titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"title":"Authentication API Endpoint","url":"https:\/\/auth0.com\/docs\/api\/authentication\/muti-factor-authentication\/verify-mfa-with-otp","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/muti-factor-authentication\/verify-mfa-with-otp"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorRequired":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired","type":"topic","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isMultifactorRequired","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror\/ismultifactorrequired","abstract":[{"text":"When MFA is required to authenticate.","type":"text"}],"title":"isMultifactorRequired"},"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","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/login(withotp:mfatoken:)"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"abstract":[{"type":"text","text":"Verifies multi-factor authentication (MFA) using a one-time password (OTP)."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withOTP"},{"kind":"text","text":" "},{"kind":"internalParam","text":"otp"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"mfaToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","text":"Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}]}]},{"kind":"parameters","parameters":[{"name":"otp","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"One-time password supplied by a MFA authenticator."}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Token returned when authentication fails with an "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired"},{"type":"text","text":" error due to MFA requirement."}]}],"name":"mfaToken"}]},{"kind":"content","content":[{"type":"heading","anchor":"return-value","level":2,"text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A request that will yield Auth0 user’s credentials."}]}]},{"kind":"content","content":[{"text":"Usage","level":2,"type":"heading","anchor":"Usage"},{"syntax":"swift","code":["Auth0"," .authentication()"," .login(withOTP: \"123456\", mfaToken: \"mfa-token\")"," .start { result in"," switch result {"," case .success(let credentials):"," print(\"Obtained credentials: \\(credentials)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"],"type":"codeListing"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"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"},{"text":" for more information.","type":"text"}]}],"style":"note","name":"Requires","type":"aside"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","sections":[],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication\/muti-factor-authentication\/verify-mfa-with-otp"],"anchor":"Related-Documentation"}],"metadata":{"externalID":"s:5Auth014AuthenticationP5login7withOTP8mfaTokenAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_SStF","symbolKind":"method","title":"login(withOTP:mfaToken:)","role":"symbol","roleHeading":"Instance Method","required":true,"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","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"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","text":"Credentials"},{"text":", ","kind":"text"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"modules":[{"name":"Auth0"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withOTP:mfaToken:)","interfaceLanguage":"swift"},"references":{"https://auth0.com/docs/api/authentication":{"title":"Auth0 Authentication API","titleInlineContent":[{"text":"Auth0 Authentication API","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(withOTP:mfaToken:)":{"type":"topic","abstract":[{"type":"text","text":"Verifies multi-factor authentication (MFA) using a one-time password (OTP)."}],"title":"login(withOTP:mfaToken:)","url":"\/documentation\/auth0\/authentication\/login(withotp:mfatoken:)","kind":"symbol","required":true,"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withOTP"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"mfaToken"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","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","kind":"typeIdentifier","text":"AuthenticationError"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withOTP:mfaToken:)"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"title":"Request","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"abstract":[{"text":"Auth0 API request.","type":"text"}],"url":"\/documentation\/auth0\/request","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","abstract":[{"type":"text","text":"Client for the "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","isActive":true},{"type":"text","text":"."}],"type":"topic","title":"Authentication","url":"\/documentation\/auth0\/authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"Credentials","kind":"identifier"}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorRequired":{"type":"topic","title":"isMultifactorRequired","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired","kind":"symbol","url":"\/documentation\/auth0\/authenticationerror\/ismultifactorrequired","abstract":[{"type":"text","text":"When MFA is required to authenticate."}],"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isMultifactorRequired"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}]},"https://auth0.com/docs/api/authentication/muti-factor-authentication/verify-mfa-with-otp":{"title":"Authentication API Endpoint","type":"link","titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}],"identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/muti-factor-authentication\/verify-mfa-with-otp","url":"https:\/\/auth0.com\/docs\/api\/authentication\/muti-factor-authentication\/verify-mfa-with-otp"},"https://auth0.com/docs/get-started/applications/application-grant-types":{"title":"our documentation","type":"link","titleInlineContent":[{"type":"text","text":"our documentation"}],"identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","url":"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 9db8ef23a..12294ff42 100644 --- a/docs/data/documentation/auth0/authentication/login(withrecoverycode:mfatoken:).json +++ b/docs/data/documentation/auth0/authentication/login(withrecoverycode:mfatoken:).json @@ -1 +1 @@ -{"sections":[],"schemaVersion":{"major":0,"patch":0,"minor":3},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"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":" "},{"type":"text","text":"Some multi-factor authentication (MFA) providers support using a recovery code to login. Use this method to"},{"type":"text","text":" "},{"type":"text","text":"authenticate when the user’s enrolled device is unavailable, or the user cannot receive the challenge or accept"},{"type":"text","text":" "},{"type":"text","text":"it due to connectivity issues."}],"primaryContentSections":[{"declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withRecoveryCode","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"recoveryCode","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"mfaToken","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","preciseIdentifier":"s:5Auth07RequestV","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"},{"text":"AuthenticationError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"},{"parameters":[{"name":"recoveryCode","content":[{"inlineContent":[{"type":"text","text":"Recovery code provided by the user."}],"type":"paragraph"}]},{"name":"mfaToken","content":[{"inlineContent":[{"text":"Token returned when authentication fails with an ","type":"text"},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired","isActive":true},{"text":" error due to MFA requirement.","type":"text"}],"type":"paragraph"}]}],"kind":"parameters"},{"content":[{"type":"heading","level":2,"text":"Return Value","anchor":"return-value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A request that will yield Auth0 user’s credentials. Might include a "},{"type":"strong","inlineContent":[{"text":"recovery code","type":"text"}]},{"type":"text","text":", which the"},{"type":"text","text":" "},{"type":"text","text":"application must display to the user to be stored securely for future use."}]}],"kind":"content"},{"content":[{"anchor":"Usage","type":"heading","text":"Usage","level":2},{"type":"codeListing","syntax":"swift","code":["Auth0"," .authentication()"," .login(withRecoveryCode: \"recovery-code\", mfaToken: \"mfa-token\")"," .start { result in"," switch result {"," case .success(let credentials):"," print(\"Obtained credentials: \\(credentials)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"]},{"style":"note","type":"aside","name":"Requires","content":[{"inlineContent":[{"type":"text","text":"The "},{"type":"codeVoice","code":"http:\/\/auth0.com\/oauth\/grant-type\/mfa-recovery-code"},{"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."}],"type":"paragraph"}]}],"kind":"content"}],"seeAlsoSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/recoveryCode","https:\/\/auth0.com\/docs\/api\/authentication\/muti-factor-authentication\/verify-with-recovery-code"],"anchor":"Related-Documentation","title":"Related Documentation"}],"variants":[{"paths":["\/documentation\/auth0\/authentication\/login(withrecoverycode:mfatoken:)"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"title":"login(withRecoveryCode:mfaToken:)","roleHeading":"Instance Method","required":true,"symbolKind":"method","externalID":"s:5Auth014AuthenticationP5login16withRecoveryCode8mfaTokenAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_SStF","role":"symbol","modules":[{"name":"Auth0"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withRecoveryCode","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"mfaToken","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"type":"topic","role":"symbol","title":"Authentication","abstract":[{"text":"Client for the ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"text":".","type":"text"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(withRecoveryCode:mfaToken:)":{"kind":"symbol","url":"\/documentation\/auth0\/authentication\/login(withrecoverycode:mfatoken:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withRecoveryCode:mfaToken:)","title":"login(withRecoveryCode:mfaToken:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withRecoveryCode","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"mfaToken","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"type":"topic","abstract":[{"text":"Verifies multi-factor authentication (MFA) using a recovery code.","type":"text"},{"text":" ","type":"text"},{"text":"Some multi-factor authentication (MFA) providers support using a recovery code to login. Use this method to","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"},{"text":" ","type":"text"},{"text":"it due to connectivity issues.","type":"text"}],"required":true,"role":"symbol"},"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","identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","title":"our documentation"},"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/Request":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/request","kind":"symbol","abstract":[{"type":"text","text":"Auth0 API request."}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorRequired":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired","type":"topic","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isMultifactorRequired","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror\/ismultifactorrequired","abstract":[{"text":"When MFA is required to authenticate.","type":"text"}],"title":"isMultifactorRequired"},"https://auth0.com/docs/api/authentication/muti-factor-authentication/verify-with-recovery-code":{"titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication\/muti-factor-authentication\/verify-with-recovery-code","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/muti-factor-authentication\/verify-with-recovery-code","title":"Authentication API Endpoint"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"url":"\/documentation\/auth0\/credentials","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"role":"symbol","type":"topic","abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/recoveryCode":{"title":"recoveryCode","url":"\/documentation\/auth0\/credentials\/recoverycode","type":"topic","abstract":[{"text":"MFA recovery code that the application must display to the user, to be stored securely for future use.","type":"text"}],"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"recoveryCode","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"kind":"symbol","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/recoveryCode"}}} \ No newline at end of file +{"sections":[],"metadata":{"externalID":"s:5Auth014AuthenticationP5login16withRecoveryCode8mfaTokenAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_SStF","modules":[{"name":"Auth0"}],"title":"login(withRecoveryCode:mfaToken:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withRecoveryCode","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"mfaToken","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"roleHeading":"Instance Method","role":"symbol","required":true,"symbolKind":"method"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withRecoveryCode:mfaToken:)"},"kind":"symbol","seeAlsoSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/recoveryCode","https:\/\/auth0.com\/docs\/api\/authentication\/muti-factor-authentication\/verify-with-recovery-code"],"title":"Related Documentation","anchor":"Related-Documentation"}],"variants":[{"paths":["\/documentation\/auth0\/authentication\/login(withrecoverycode:mfatoken:)"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"login"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withRecoveryCode"},{"kind":"text","text":" "},{"kind":"internalParam","text":"recoveryCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"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","kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","kind":"typeIdentifier","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":", "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"languages":["swift"],"platforms":["iOS"]}]},{"parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Recovery code provided by the user."}]}],"name":"recoveryCode"},{"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"},{"type":"text","text":" error due to MFA requirement."}]}],"name":"mfaToken"}],"kind":"parameters"},{"kind":"content","content":[{"type":"heading","text":"Return Value","anchor":"return-value","level":2},{"type":"paragraph","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"},{"type":"text","text":" "},{"type":"text","text":"application must display to the user to be stored securely for future use."}]}]},{"kind":"content","content":[{"level":2,"anchor":"Usage","type":"heading","text":"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"},{"name":"Requires","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"type":"codeVoice","code":"http:\/\/auth0.com\/oauth\/grant-type\/mfa-recovery-code"},{"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."}]}],"type":"aside","style":"note"}]}],"abstract":[{"type":"text","text":"Verifies multi-factor authentication (MFA) using a recovery code."},{"type":"text","text":" "},{"type":"text","text":"Some multi-factor authentication (MFA) providers support using a recovery code to login. Use this method to"},{"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","text":" "},{"type":"text","text":"it due to connectivity issues."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","abstract":[{"type":"text","text":"Client for the "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","isActive":true},{"type":"text","text":"."}],"type":"topic","title":"Authentication","url":"\/documentation\/auth0\/authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/login(withRecoveryCode:mfaToken:)":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/login(withRecoveryCode:mfaToken:)","title":"login(withRecoveryCode:mfaToken:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"login","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withRecoveryCode","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"mfaToken","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"role":"symbol","required":true,"url":"\/documentation\/auth0\/authentication\/login(withrecoverycode:mfatoken:)","abstract":[{"type":"text","text":"Verifies multi-factor authentication (MFA) using a recovery code."},{"type":"text","text":" "},{"type":"text","text":"Some multi-factor authentication (MFA) providers support using a recovery code to login. Use this method to"},{"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","text":" "},{"type":"text","text":"it due to connectivity issues."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/recoveryCode":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/recoveryCode","title":"recoveryCode","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"recoveryCode","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"role":"symbol","url":"\/documentation\/auth0\/credentials\/recoverycode","abstract":[{"type":"text","text":"MFA recovery code that the application must display to the user, to be stored securely for future use."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"title":"Request","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"abstract":[{"text":"Auth0 API request.","type":"text"}],"url":"\/documentation\/auth0\/request","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"Credentials","kind":"identifier"}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"},"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","url":"https:\/\/auth0.com\/docs\/api\/authentication"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorRequired":{"type":"topic","title":"isMultifactorRequired","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired","kind":"symbol","url":"\/documentation\/auth0\/authenticationerror\/ismultifactorrequired","abstract":[{"type":"text","text":"When MFA is required to authenticate."}],"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isMultifactorRequired"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}]},"https://auth0.com/docs/api/authentication/muti-factor-authentication/verify-with-recovery-code":{"type":"link","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/muti-factor-authentication\/verify-with-recovery-code","title":"Authentication API Endpoint","url":"https:\/\/auth0.com\/docs\/api\/authentication\/muti-factor-authentication\/verify-with-recovery-code"},"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","url":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types"}}} \ 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 c9cce01bf..7061aa1ee 100644 --- a/docs/data/documentation/auth0/authentication/logindefaultdirectory(withusername:password:audience:scope:)-4gru8.json +++ b/docs/data/documentation/auth0/authentication/logindefaultdirectory(withusername:password:audience:scope:)-4gru8.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"abstract":[{"type":"text","text":"Logs a user in using a username and password in the default directory."}],"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/api\/authentication\/resource-owner-password-flow\/get-token"],"anchor":"Related-Documentation","title":"Related Documentation"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/logindefaultdirectory(withusername:password:audience:scope:)-4gru8"]}],"metadata":{"externalID":"s:5Auth014AuthenticationPAAE21loginDefaultDirectory12withUsername8password8audience5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_S2SSgSStF","symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"loginDefaultDirectory","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withUsername","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"password","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"modules":[{"name":"Auth0"}],"roleHeading":"Instance Method","title":"loginDefaultDirectory(withUsername:password:audience:scope:)","extendedModule":"Auth0","role":"symbol"},"schemaVersion":{"minor":3,"patch":0,"major":0},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"loginDefaultDirectory"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withUsername"},{"kind":"text","text":" "},{"kind":"internalParam","text":"username"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"password"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"? = nil, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" = defaultScope) -> "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","kind":"typeIdentifier","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":", "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"},{"parameters":[{"name":"username","content":[{"inlineContent":[{"text":"Username or email of the user.","type":"text"}],"type":"paragraph"}]},{"name":"password","content":[{"type":"paragraph","inlineContent":[{"text":"Password of the user.","type":"text"}]}]},{"name":"audience","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"API Identifier that your application is requesting access to."}]}]},{"name":"scope","content":[{"inlineContent":[{"text":"Space-separated list of requested scope values. Defaults to ","type":"text"},{"type":"codeVoice","code":"openid profile email"},{"text":".","type":"text"}],"type":"paragraph"}]}],"kind":"parameters"},{"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":[{"type":"heading","text":"Usage","level":2,"anchor":"Usage"},{"type":"codeListing","syntax":"swift","code":["Auth0"," .authentication()"," .loginDefaultDirectory(withUsername: \"support@auth0.com\","," password: \"secret-password\")"," .start { result in"," switch result {"," case .success(let credentials):"," print(\"Obtained credentials: \\(credentials)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"]},{"type":"paragraph","inlineContent":[{"text":"You can also specify audience (the Auth0 API identifier) and scope values:","type":"text"}]},{"type":"codeListing","syntax":"swift","code":["Auth0"," .authentication()"," .loginDefaultDirectory(withUsername: \"support@auth0.com\","," password: \"secret-password\","," audience: \"https:\/\/example.com\/api\","," scope: \"openid profile email offline_access\")"," .start { print($0) }"]}],"kind":"content"}],"sections":[],"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/loginDefaultDirectory(withUsername:password:audience:scope:)-4gru8","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Authentication/loginDefaultDirectory(withUsername:password:audience:scope:)-4gru8":{"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"loginDefaultDirectory","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withUsername","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"password","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"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"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/loginDefaultDirectory(withUsername:password:audience:scope:)-4gru8","url":"\/documentation\/auth0\/authentication\/logindefaultdirectory(withusername:password:audience:scope:)-4gru8","type":"topic","title":"loginDefaultDirectory(withUsername:password:audience:scope:)","abstract":[{"type":"text","text":"Logs a user in using a username and password in the default directory."}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"https://auth0.com/docs/api/authentication":{"type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","title":"Auth0 Authentication API","titleInlineContent":[{"text":"Auth0 Authentication API","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication"},"https://auth0.com/docs/api/authentication/resource-owner-password-flow/get-token":{"type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/resource-owner-password-flow\/get-token","title":"Authentication API Endpoint","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication\/resource-owner-password-flow\/get-token"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"type":"topic","role":"symbol","title":"Authentication","abstract":[{"text":"Client for the ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"text":".","type":"text"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/request","kind":"symbol","abstract":[{"type":"text","text":"Auth0 API request."}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"url":"\/documentation\/auth0\/credentials","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"role":"symbol","type":"topic","abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}]}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/logindefaultdirectory(withusername:password:audience:scope:)-4gru8"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"abstract":[{"type":"text","text":"Logs a user in using a username and password in the default directory."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"loginDefaultDirectory","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withUsername","kind":"externalParam"},{"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"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"? = nil, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" = defaultScope) -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"},{"text":"<","kind":"text"},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"},{"text":", ","kind":"text"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"},{"text":">","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]},{"parameters":[{"name":"username","content":[{"inlineContent":[{"text":"Username or email of the user.","type":"text"}],"type":"paragraph"}]},{"name":"password","content":[{"inlineContent":[{"text":"Password of the user.","type":"text"}],"type":"paragraph"}]},{"name":"audience","content":[{"inlineContent":[{"text":"API Identifier that your application is requesting access to.","type":"text"}],"type":"paragraph"}]},{"name":"scope","content":[{"inlineContent":[{"text":"Space-separated list of requested scope values. Defaults to ","type":"text"},{"code":"openid profile email","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"}]}],"kind":"parameters"},{"kind":"content","content":[{"type":"heading","text":"Return Value","anchor":"return-value","level":2},{"type":"paragraph","inlineContent":[{"text":"A request that will yield Auth0 user’s credentials.","type":"text"}]}]},{"kind":"content","content":[{"type":"heading","text":"Usage","anchor":"Usage","level":2},{"type":"codeListing","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)\")"," }"," }"],"syntax":"swift"},{"type":"paragraph","inlineContent":[{"text":"You can also specify audience (the Auth0 API identifier) and scope values:","type":"text"}]},{"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":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication\/resource-owner-password-flow\/get-token"],"anchor":"Related-Documentation"}],"metadata":{"externalID":"s:5Auth014AuthenticationPAAE21loginDefaultDirectory12withUsername8password8audience5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_S2SSgSStF","extendedModule":"Auth0","symbolKind":"method","title":"loginDefaultDirectory(withUsername:password:audience:scope:)","roleHeading":"Instance Method","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"loginDefaultDirectory","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withUsername","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"password","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"modules":[{"name":"Auth0"}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/loginDefaultDirectory(withUsername:password:audience:scope:)-4gru8"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Authentication/loginDefaultDirectory(withUsername:password:audience:scope:)-4gru8":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/loginDefaultDirectory(withUsername:password:audience:scope:)-4gru8","kind":"symbol","title":"loginDefaultDirectory(withUsername:password:audience:scope:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"loginDefaultDirectory"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withUsername"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"password"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"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","kind":"typeIdentifier","text":"String"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"kind":"text","text":"<"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","text":"Credentials"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"role":"symbol","url":"\/documentation\/auth0\/authentication\/logindefaultdirectory(withusername:password:audience:scope:)-4gru8","abstract":[{"type":"text","text":"Logs a user in using a username and password in the default directory."}],"type":"topic"},"https://auth0.com/docs/api/authentication":{"title":"Auth0 Authentication API","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"title":"Request","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"abstract":[{"text":"Auth0 API request.","type":"text"}],"url":"\/documentation\/auth0\/request","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"Credentials","kind":"identifier"}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","abstract":[{"type":"text","text":"Client for the "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","isActive":true},{"type":"text","text":"."}],"type":"topic","title":"Authentication","url":"\/documentation\/auth0\/authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"https://auth0.com/docs/api/authentication/resource-owner-password-flow/get-token":{"title":"Authentication API Endpoint","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/resource-owner-password-flow\/get-token","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication\/resource-owner-password-flow\/get-token"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authentication/logindefaultdirectory(withusername:password:audience:scope:).json b/docs/data/documentation/auth0/authentication/logindefaultdirectory(withusername:password:audience:scope:).json index 44ce60b2b..86436409b 100644 --- a/docs/data/documentation/auth0/authentication/logindefaultdirectory(withusername:password:audience:scope:).json +++ b/docs/data/documentation/auth0/authentication/logindefaultdirectory(withusername:password:audience:scope:).json @@ -1 +1 @@ -{"sections":[],"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/api\/authentication\/resource-owner-password-flow\/get-token"],"anchor":"Related-Documentation","title":"Related Documentation"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/loginDefaultDirectory(withUsername:password:audience:scope:)"},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"loginDefaultDirectory"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withUsername"},{"kind":"text","text":" "},{"kind":"internalParam","text":"username"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"password"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"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":", "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"},{"parameters":[{"name":"username","content":[{"inlineContent":[{"text":"Username or email of the user.","type":"text"}],"type":"paragraph"}]},{"name":"password","content":[{"type":"paragraph","inlineContent":[{"text":"Password of the user.","type":"text"}]}]},{"name":"audience","content":[{"type":"paragraph","inlineContent":[{"text":"API Identifier that your application is requesting access to.","type":"text"}]}]},{"name":"scope","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Space-separated list of requested scope values. Defaults to "},{"type":"codeVoice","code":"openid profile email"},{"type":"text","text":"."}]}]}],"kind":"parameters"},{"content":[{"level":2,"type":"heading","anchor":"return-value","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A request that will yield Auth0 user’s credentials."}]}],"kind":"content"},{"content":[{"text":"Usage","type":"heading","anchor":"Usage","level":2},{"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":[{"text":"You can also specify audience (the Auth0 API identifier) and scope values:","type":"text"}],"type":"paragraph"},{"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"}],"kind":"content"}],"variants":[{"paths":["\/documentation\/auth0\/authentication\/logindefaultdirectory(withusername:password:audience:scope:)"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"modules":[{"name":"Auth0"}],"title":"loginDefaultDirectory(withUsername:password:audience:scope:)","role":"symbol","externalID":"s:5Auth014AuthenticationP21loginDefaultDirectory12withUsername8password8audience5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_S2SSgSStF","required":true,"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"loginDefaultDirectory","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withUsername","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"password","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"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"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"symbolKind":"method","roleHeading":"Instance Method"},"abstract":[{"text":"Logs a user in using a username and password in the default directory.","type":"text"}],"defaultImplementationsSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/loginDefaultDirectory(withUsername:password:audience:scope:)-4gru8"],"anchor":"Authentication-Implementations","title":"Authentication Implementations"}],"kind":"symbol","schemaVersion":{"minor":3,"patch":0,"major":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Request":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/request","kind":"symbol","abstract":[{"type":"text","text":"Auth0 API request."}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"url":"\/documentation\/auth0\/credentials","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"role":"symbol","type":"topic","abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/loginDefaultDirectory(withUsername:password:audience:scope:)":{"role":"symbol","required":true,"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"loginDefaultDirectory","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withUsername","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"password","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"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"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"defaultImplementations":1,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/loginDefaultDirectory(withUsername:password:audience:scope:)","url":"\/documentation\/auth0\/authentication\/logindefaultdirectory(withusername:password:audience:scope:)","title":"loginDefaultDirectory(withUsername:password:audience:scope:)","type":"topic","abstract":[{"type":"text","text":"Logs a user in using a username and password in the default directory."}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/loginDefaultDirectory(withUsername:password:audience:scope:)-4gru8":{"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"loginDefaultDirectory","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withUsername","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"password","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"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"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/loginDefaultDirectory(withUsername:password:audience:scope:)-4gru8","url":"\/documentation\/auth0\/authentication\/logindefaultdirectory(withusername:password:audience:scope:)-4gru8","type":"topic","title":"loginDefaultDirectory(withUsername:password:audience:scope:)","abstract":[{"type":"text","text":"Logs a user in using a username and password in the default directory."}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"type":"topic","role":"symbol","title":"Authentication","abstract":[{"text":"Client for the ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"text":".","type":"text"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"https://auth0.com/docs/api/authentication/resource-owner-password-flow/get-token":{"type":"link","url":"https:\/\/auth0.com\/docs\/api\/authentication\/resource-owner-password-flow\/get-token","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/resource-owner-password-flow\/get-token","title":"Authentication API Endpoint"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"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":[{"type":"text","text":"Auth0 Authentication API"}]}}} \ No newline at end of file +{"abstract":[{"type":"text","text":"Logs a user in using a username and password in the default directory."}],"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/api\/authentication\/resource-owner-password-flow\/get-token"],"title":"Related Documentation","anchor":"Related-Documentation"}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"loginDefaultDirectory"},{"kind":"text","text":"("},{"text":"withUsername","kind":"externalParam"},{"kind":"text","text":" "},{"text":"username","kind":"internalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"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"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"},{"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":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"},{"kind":"text","text":">"}]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"type":"text","text":"Username or email of the user."}],"type":"paragraph"}],"name":"username"},{"content":[{"inlineContent":[{"type":"text","text":"Password of the user."}],"type":"paragraph"}],"name":"password"},{"content":[{"inlineContent":[{"type":"text","text":"API Identifier that your application is requesting access to."}],"type":"paragraph"}],"name":"audience"},{"name":"scope","content":[{"inlineContent":[{"type":"text","text":"Space-separated list of requested scope values. Defaults to "},{"type":"codeVoice","code":"openid profile email"},{"type":"text","text":"."}],"type":"paragraph"}]}]},{"content":[{"level":2,"text":"Return Value","type":"heading","anchor":"return-value"},{"type":"paragraph","inlineContent":[{"text":"A request that will yield Auth0 user’s credentials.","type":"text"}]}],"kind":"content"},{"content":[{"level":2,"type":"heading","anchor":"Usage","text":"Usage"},{"type":"codeListing","syntax":"swift","code":["Auth0"," .authentication()"," .loginDefaultDirectory(withUsername: \"support@auth0.com\","," password: \"secret-password\")"," .start { result in"," switch result {"," case .success(let credentials):"," print(\"Obtained credentials: \\(credentials)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"]},{"type":"paragraph","inlineContent":[{"text":"You can also specify audience (the Auth0 API identifier) and scope values:","type":"text"}]},{"type":"codeListing","syntax":"swift","code":["Auth0"," .authentication()"," .loginDefaultDirectory(withUsername: \"support@auth0.com\","," password: \"secret-password\","," audience: \"https:\/\/example.com\/api\","," scope: \"openid profile email offline_access\")"," .start { print($0) }"]}],"kind":"content"}],"variants":[{"paths":["\/documentation\/auth0\/authentication\/logindefaultdirectory(withusername:password:audience:scope:)"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"sections":[],"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\/loginDefaultDirectory(withUsername:password:audience:scope:)-4gru8"],"anchor":"Authentication-Implementations"}],"metadata":{"modules":[{"name":"Auth0"}],"title":"loginDefaultDirectory(withUsername:password:audience:scope:)","roleHeading":"Instance Method","symbolKind":"method","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"loginDefaultDirectory","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withUsername","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"password","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","text":"Credentials"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","text":"AuthenticationError"},{"text":">","kind":"text"}],"externalID":"s:5Auth014AuthenticationP21loginDefaultDirectory12withUsername8password8audience5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_S2SSgSStF","required":true},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/loginDefaultDirectory(withUsername:password:audience:scope:)","interfaceLanguage":"swift"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"},"https://auth0.com/docs/api/authentication":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","url":"https:\/\/auth0.com\/docs\/api\/authentication","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"type":"link","title":"Auth0 Authentication API"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"Credentials","kind":"identifier"}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","abstract":[{"type":"text","text":"Client for the "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","isActive":true},{"type":"text","text":"."}],"type":"topic","title":"Authentication","url":"\/documentation\/auth0\/authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/loginDefaultDirectory(withUsername:password:audience:scope:)-4gru8":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/loginDefaultDirectory(withUsername:password:audience:scope:)-4gru8","kind":"symbol","title":"loginDefaultDirectory(withUsername:password:audience:scope:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"loginDefaultDirectory"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withUsername"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"password"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"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","kind":"typeIdentifier","text":"String"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"kind":"text","text":"<"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","text":"Credentials"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"role":"symbol","url":"\/documentation\/auth0\/authentication\/logindefaultdirectory(withusername:password:audience:scope:)-4gru8","abstract":[{"type":"text","text":"Logs a user in using a username and password in the default directory."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"title":"Request","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"abstract":[{"text":"Auth0 API request.","type":"text"}],"url":"\/documentation\/auth0\/request","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/loginDefaultDirectory(withUsername:password:audience:scope:)":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/loginDefaultDirectory(withUsername:password:audience:scope:)","title":"loginDefaultDirectory(withUsername:password:audience:scope:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"loginDefaultDirectory","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withUsername","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"password","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"audience"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"defaultImplementations":1,"role":"symbol","required":true,"url":"\/documentation\/auth0\/authentication\/logindefaultdirectory(withusername:password:audience:scope:)","abstract":[{"text":"Logs a user in using a username and password in the default directory.","type":"text"}],"type":"topic"},"https://auth0.com/docs/api/authentication/resource-owner-password-flow/get-token":{"title":"Authentication API Endpoint","identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/resource-owner-password-flow\/get-token","titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}],"type":"link","url":"https:\/\/auth0.com\/docs\/api\/authentication\/resource-owner-password-flow\/get-token"}}} \ 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 3e3a481e2..e15fb2a30 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 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"modules":[{"name":"Auth0"}],"role":"symbol","externalID":"s:5Auth014AuthenticationPAAE20multifactorChallenge8mfaToken5types15authenticatorIdAA7RequestVyAA0D0VAA0B5ErrorVGSS_SaySSGSgSSSgtF","roleHeading":"Instance Method","extendedModule":"Auth0","symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"multifactorChallenge","kind":"identifier"},{"text":"(","kind":"text"},{"text":"mfaToken","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"types","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"]?, ","kind":"text"},{"text":"authenticatorId","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?) -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"Challenge","kind":"typeIdentifier","preciseIdentifier":"s:5Auth09ChallengeV"},{"text":", ","kind":"text"},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"title":"multifactorChallenge(mfaToken:types:authenticatorId:)"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/multifactorChallenge(mfaToken:types:authenticatorId:)-7xrct","interfaceLanguage":"swift"},"kind":"symbol","seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/api\/authentication\/muti-factor-authentication\/request-mfa-challenge"],"anchor":"Related-Documentation","title":"Related Documentation"}],"variants":[{"paths":["\/documentation\/auth0\/authentication\/multifactorchallenge(mfatoken:types:authenticatorid:)-7xrct"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"multifactorChallenge","kind":"identifier"},{"text":"(","kind":"text"},{"text":"mfaToken","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"types","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"]? = nil, ","kind":"text"},{"text":"authenticatorId","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"? = nil) -> ","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\/Challenge","text":"Challenge","kind":"typeIdentifier","preciseIdentifier":"s:5Auth09ChallengeV"},{"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"},{"parameters":[{"name":"mfaToken","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Token returned when authentication fails with an "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired"},{"type":"text","text":" error due to MFA requirement."}]}]},{"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"},{"text":" or ","type":"text"},{"code":"otp","type":"codeVoice"},{"text":". Excluding this parameter means that your application accepts all supported challenge types.","type":"text"}],"type":"paragraph"}]},{"name":"authenticatorId","content":[{"inlineContent":[{"text":"The ID of the authenticator to challenge. You can get the ID by querying the list of available authenticators for the user.","type":"text"}],"type":"paragraph"}]}],"kind":"parameters"},{"kind":"content","content":[{"type":"heading","text":"Return Value","anchor":"return-value","level":2},{"type":"paragraph","inlineContent":[{"type":"text","text":"A request that will yield a multi-factor challenge."}]}]},{"kind":"content","content":[{"text":"Usage","level":2,"type":"heading","anchor":"Usage"},{"syntax":"swift","type":"codeListing","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)\")"," }"," }"]},{"inlineContent":[{"text":"The challenge type is how the user will get the challenge and prove possession. Supported challenge types include:","type":"text"}],"type":"paragraph"},{"items":[{"content":[{"type":"paragraph","inlineContent":[{"code":"otp","type":"codeVoice"},{"text":": for one-time password (OTP)","type":"text"}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"codeVoice","code":"oob"},{"type":"text","text":": for SMS\/voice messages or out-of-band (OOB)"}]}]}],"type":"unorderedList"}]}],"sections":[],"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."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Request":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/request","kind":"symbol","abstract":[{"type":"text","text":"Auth0 API request."}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorRequired":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired","type":"topic","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isMultifactorRequired","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror\/ismultifactorrequired","abstract":[{"text":"When MFA is required to authenticate.","type":"text"}],"title":"isMultifactorRequired"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/multifactorChallenge(mfaToken:types:authenticatorId:)-7xrct":{"url":"\/documentation\/auth0\/authentication\/multifactorchallenge(mfatoken:types:authenticatorid:)-7xrct","kind":"symbol","title":"multifactorChallenge(mfaToken:types:authenticatorId:)","role":"symbol","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."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/multifactorChallenge(mfaToken:types:authenticatorId:)-7xrct","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"multifactorChallenge"},{"kind":"text","text":"("},{"kind":"externalParam","text":"mfaToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","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":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth09ChallengeV","text":"Challenge"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"type":"topic","role":"symbol","title":"Authentication","abstract":[{"text":"Client for the ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"text":".","type":"text"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"https://auth0.com/docs/api/authentication/muti-factor-authentication/request-mfa-challenge":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/muti-factor-authentication\/request-mfa-challenge","type":"link","titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication\/muti-factor-authentication\/request-mfa-challenge","title":"Authentication API Endpoint"},"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/Challenge":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Challenge","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge","title":"Challenge","url":"\/documentation\/auth0\/challenge","navigatorTitle":[{"text":"Challenge","kind":"identifier"}],"type":"topic","kind":"symbol","abstract":[{"type":"text","text":"A multi-factor challenge."}]}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"metadata":{"roleHeading":"Instance Method","symbolKind":"method","modules":[{"name":"Auth0"}],"title":"multifactorChallenge(mfaToken:types:authenticatorId:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"multifactorChallenge"},{"kind":"text","text":"("},{"kind":"externalParam","text":"mfaToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"types"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"]?, ","kind":"text"},{"kind":"externalParam","text":"authenticatorId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?) -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Challenge","preciseIdentifier":"s:5Auth09ChallengeV"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"externalID":"s:5Auth014AuthenticationPAAE20multifactorChallenge8mfaToken5types15authenticatorIdAA7RequestVyAA0D0VAA0B5ErrorVGSS_SaySSGSgSSSgtF","role":"symbol","extendedModule":"Auth0"},"sections":[],"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"}],"variants":[{"paths":["\/documentation\/auth0\/authentication\/multifactorchallenge(mfatoken:types:authenticatorid:)-7xrct"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/multifactorChallenge(mfaToken:types:authenticatorId:)-7xrct","interfaceLanguage":"swift"},"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/api\/authentication\/muti-factor-authentication\/request-mfa-challenge"],"title":"Related Documentation","anchor":"Related-Documentation"}],"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"multifactorChallenge"},{"kind":"text","text":"("},{"kind":"externalParam","text":"mfaToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"types"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"]? = nil, "},{"kind":"externalParam","text":"authenticatorId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"? = nil) -> "},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge","preciseIdentifier":"s:5Auth09ChallengeV","text":"Challenge"},{"kind":"text","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":[{"name":"mfaToken","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"},{"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"},{"code":"oob","type":"codeVoice"},{"text":" or ","type":"text"},{"code":"otp","type":"codeVoice"},{"text":". Excluding this parameter means that your application accepts all supported challenge types.","type":"text"}],"type":"paragraph"}]},{"name":"authenticatorId","content":[{"inlineContent":[{"text":"The ID of the authenticator to challenge. You can get the ID by querying the list of available authenticators for the user.","type":"text"}],"type":"paragraph"}]}]},{"content":[{"anchor":"return-value","text":"Return Value","type":"heading","level":2},{"inlineContent":[{"text":"A request that will yield a multi-factor challenge.","type":"text"}],"type":"paragraph"}],"kind":"content"},{"content":[{"anchor":"Usage","text":"Usage","type":"heading","level":2},{"syntax":"swift","type":"codeListing","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)\")"," }"," }"]},{"inlineContent":[{"text":"The challenge type is how the user will get the challenge and prove possession. Supported challenge types include:","type":"text"}],"type":"paragraph"},{"items":[{"content":[{"inlineContent":[{"type":"codeVoice","code":"otp"},{"text":": for one-time password (OTP)","type":"text"}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"type":"codeVoice","code":"oob"},{"text":": for SMS\/voice messages or out-of-band (OOB)","type":"text"}],"type":"paragraph"}]}],"type":"unorderedList"}],"kind":"content"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Authentication/multifactorChallenge(mfaToken:types:authenticatorId:)-7xrct":{"role":"symbol","title":"multifactorChallenge(mfaToken:types:authenticatorId:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"multifactorChallenge","kind":"identifier"},{"text":"(","kind":"text"},{"text":"mfaToken","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"types","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"]?, "},{"kind":"externalParam","text":"authenticatorId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"?) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth09ChallengeV","text":"Challenge","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"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."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/multifactorChallenge(mfaToken:types:authenticatorId:)-7xrct","url":"\/documentation\/auth0\/authentication\/multifactorchallenge(mfatoken:types:authenticatorid:)-7xrct","type":"topic"},"https://auth0.com/docs/api/authentication":{"url":"https:\/\/auth0.com\/docs\/api\/authentication","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","title":"Auth0 Authentication API","type":"link","titleInlineContent":[{"text":"Auth0 Authentication API","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"},"https://auth0.com/docs/api/authentication/muti-factor-authentication/request-mfa-challenge":{"url":"https:\/\/auth0.com\/docs\/api\/authentication\/muti-factor-authentication\/request-mfa-challenge","identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/muti-factor-authentication\/request-mfa-challenge","title":"Authentication API Endpoint","type":"link","titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"title":"Request","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"abstract":[{"text":"Auth0 API request.","type":"text"}],"url":"\/documentation\/auth0\/request","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","abstract":[{"type":"text","text":"Client for the "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","isActive":true},{"type":"text","text":"."}],"type":"topic","title":"Authentication","url":"\/documentation\/auth0\/authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorRequired":{"type":"topic","title":"isMultifactorRequired","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired","kind":"symbol","url":"\/documentation\/auth0\/authenticationerror\/ismultifactorrequired","abstract":[{"type":"text","text":"When MFA is required to authenticate."}],"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isMultifactorRequired"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}]},"doc://com.auth0.Auth0/documentation/Auth0/Challenge":{"title":"Challenge","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Challenge"}],"abstract":[{"text":"A multi-factor challenge.","type":"text"}],"url":"\/documentation\/auth0\/challenge","navigatorTitle":[{"kind":"identifier","text":"Challenge"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authentication/multifactorchallenge(mfatoken:types:authenticatorid:).json b/docs/data/documentation/auth0/authentication/multifactorchallenge(mfatoken:types:authenticatorid:).json index fe257affb..38d8c8c6a 100644 --- a/docs/data/documentation/auth0/authentication/multifactorchallenge(mfatoken:types:authenticatorid:).json +++ b/docs/data/documentation/auth0/authentication/multifactorchallenge(mfatoken:types:authenticatorid:).json @@ -1 +1 @@ -{"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"multifactorChallenge"},{"kind":"text","text":"("},{"kind":"externalParam","text":"mfaToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"types"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"]?, "},{"kind":"externalParam","text":"authenticatorId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?) -> "},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge","text":"Challenge","preciseIdentifier":"s:5Auth09ChallengeV"},{"kind":"text","text":", "},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"},{"parameters":[{"content":[{"inlineContent":[{"text":"Token returned when authentication fails with an ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired","type":"reference","isActive":true},{"text":" error due to MFA requirement.","type":"text"}],"type":"paragraph"}],"name":"mfaToken"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A list of the challenges types accepted by your application. Accepted challenge types are "},{"type":"codeVoice","code":"oob"},{"type":"text","text":" or "},{"type":"codeVoice","code":"otp"},{"type":"text","text":". Excluding this parameter means that your application accepts all supported challenge types."}]}],"name":"types"},{"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"}],"name":"authenticatorId"}],"kind":"parameters"},{"content":[{"level":2,"anchor":"return-value","text":"Return Value","type":"heading"},{"inlineContent":[{"type":"text","text":"A request that will yield a multi-factor challenge."}],"type":"paragraph"}],"kind":"content"},{"content":[{"type":"heading","anchor":"Usage","level":2,"text":"Usage"},{"type":"codeListing","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":"paragraph","inlineContent":[{"text":"The challenge type is how the user will get the challenge and prove possession. Supported challenge types include:","type":"text"}]},{"type":"unorderedList","items":[{"content":[{"type":"paragraph","inlineContent":[{"type":"codeVoice","code":"otp"},{"type":"text","text":": for one-time password (OTP)"}]}]},{"content":[{"inlineContent":[{"type":"codeVoice","code":"oob"},{"type":"text","text":": for SMS\/voice messages or out-of-band (OOB)"}],"type":"paragraph"}]}]}],"kind":"content"}],"variants":[{"paths":["\/documentation\/auth0\/authentication\/multifactorchallenge(mfatoken:types:authenticatorid:)"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"roleHeading":"Instance Method","title":"multifactorChallenge(mfaToken:types:authenticatorId:)","externalID":"s:5Auth014AuthenticationP20multifactorChallenge8mfaToken5types15authenticatorIdAA7RequestVyAA0D0VAA0B5ErrorVGSS_SaySSGSgSSSgtF","symbolKind":"method","required":true,"modules":[{"name":"Auth0"}],"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"multifactorChallenge","kind":"identifier"},{"text":"(","kind":"text"},{"text":"mfaToken","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"types","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"]?, ","kind":"text"},{"text":"authenticatorId","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?) -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"Challenge","preciseIdentifier":"s:5Auth09ChallengeV","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}]},"defaultImplementationsSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/multifactorChallenge(mfaToken:types:authenticatorId:)-7xrct"],"anchor":"Authentication-Implementations","title":"Authentication Implementations"}],"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\/multifactorChallenge(mfaToken:types:authenticatorId:)","interfaceLanguage":"swift"},"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."}],"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/api\/authentication\/muti-factor-authentication\/request-mfa-challenge"],"anchor":"Related-Documentation","title":"Related Documentation"}],"sections":[],"schemaVersion":{"minor":3,"major":0,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Authentication/multifactorChallenge(mfaToken:types:authenticatorId:)":{"kind":"symbol","title":"multifactorChallenge(mfaToken:types:authenticatorId:)","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."}],"required":true,"type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"multifactorChallenge"},{"kind":"text","text":"("},{"kind":"externalParam","text":"mfaToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"types"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"]?, "},{"kind":"externalParam","text":"authenticatorId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?) -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Challenge","preciseIdentifier":"s:5Auth09ChallengeV"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"defaultImplementations":1,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/multifactorChallenge(mfaToken:types:authenticatorId:)","url":"\/documentation\/auth0\/authentication\/multifactorchallenge(mfatoken:types:authenticatorid:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"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","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},"https://auth0.com/docs/api/authentication/muti-factor-authentication/request-mfa-challenge":{"title":"Authentication API Endpoint","type":"link","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication\/muti-factor-authentication\/request-mfa-challenge","identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/muti-factor-authentication\/request-mfa-challenge"},"doc://com.auth0.Auth0/documentation/Auth0/Challenge":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Challenge","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge","title":"Challenge","url":"\/documentation\/auth0\/challenge","navigatorTitle":[{"text":"Challenge","kind":"identifier"}],"type":"topic","kind":"symbol","abstract":[{"type":"text","text":"A multi-factor challenge."}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/multifactorChallenge(mfaToken:types:authenticatorId:)-7xrct":{"url":"\/documentation\/auth0\/authentication\/multifactorchallenge(mfatoken:types:authenticatorid:)-7xrct","kind":"symbol","title":"multifactorChallenge(mfaToken:types:authenticatorId:)","role":"symbol","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."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/multifactorChallenge(mfaToken:types:authenticatorId:)-7xrct","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"multifactorChallenge"},{"kind":"text","text":"("},{"kind":"externalParam","text":"mfaToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","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":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth09ChallengeV","text":"Challenge"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/request","kind":"symbol","abstract":[{"type":"text","text":"Auth0 API request."}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorRequired":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired","type":"topic","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isMultifactorRequired","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror\/ismultifactorrequired","abstract":[{"text":"When MFA is required to authenticate.","type":"text"}],"title":"isMultifactorRequired"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"type":"topic","role":"symbol","title":"Authentication","abstract":[{"text":"Client for the ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"text":".","type":"text"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"metadata":{"symbolKind":"method","modules":[{"name":"Auth0"}],"title":"multifactorChallenge(mfaToken:types:authenticatorId:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"multifactorChallenge"},{"kind":"text","text":"("},{"kind":"externalParam","text":"mfaToken"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"types"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"]?, "},{"kind":"externalParam","text":"authenticatorId"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?) -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:5Auth09ChallengeV","kind":"typeIdentifier","text":"Challenge"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","text":"AuthenticationError"},{"kind":"text","text":">"}],"externalID":"s:5Auth014AuthenticationP20multifactorChallenge8mfaToken5types15authenticatorIdAA7RequestVyAA0D0VAA0B5ErrorVGSS_SaySSGSgSSSgtF","required":true,"role":"symbol","roleHeading":"Instance Method"},"sections":[],"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":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/multifactorchallenge(mfatoken:types:authenticatorid:)"]}],"defaultImplementationsSections":[{"title":"Authentication Implementations","anchor":"Authentication-Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/multifactorChallenge(mfaToken:types:authenticatorId:)-7xrct"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/multifactorChallenge(mfaToken:types:authenticatorId:)","interfaceLanguage":"swift"},"seeAlsoSections":[{"title":"Related Documentation","anchor":"Related-Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication\/muti-factor-authentication\/request-mfa-challenge"]}],"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"multifactorChallenge","kind":"identifier"},{"text":"(","kind":"text"},{"text":"mfaToken","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"types","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"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","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth09ChallengeV","text":"Challenge","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"},{"text":">","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}]},{"parameters":[{"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","type":"reference","isActive":true},{"type":"text","text":" error due to MFA requirement."}]}]},{"name":"types","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A list of the challenges types accepted by your application. Accepted challenge types are "},{"code":"oob","type":"codeVoice"},{"type":"text","text":" or "},{"code":"otp","type":"codeVoice"},{"type":"text","text":". Excluding this parameter means that your application accepts all supported challenge types."}]}]},{"name":"authenticatorId","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The ID of the authenticator to challenge. You can get the ID by querying the list of available authenticators for the user."}]}]}],"kind":"parameters"},{"kind":"content","content":[{"type":"heading","level":2,"text":"Return Value","anchor":"return-value"},{"inlineContent":[{"type":"text","text":"A request that will yield a multi-factor challenge."}],"type":"paragraph"}]},{"kind":"content","content":[{"level":2,"anchor":"Usage","type":"heading","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"},{"items":[{"content":[{"inlineContent":[{"type":"codeVoice","code":"otp"},{"type":"text","text":": for one-time password (OTP)"}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"code":"oob","type":"codeVoice"},{"type":"text","text":": for SMS\/voice messages or out-of-band (OOB)"}],"type":"paragraph"}]}],"type":"unorderedList"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorRequired":{"type":"topic","title":"isMultifactorRequired","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired","kind":"symbol","url":"\/documentation\/auth0\/authenticationerror\/ismultifactorrequired","abstract":[{"type":"text","text":"When MFA is required to authenticate."}],"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isMultifactorRequired"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","abstract":[{"type":"text","text":"Client for the "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","isActive":true},{"type":"text","text":"."}],"type":"topic","title":"Authentication","url":"\/documentation\/auth0\/authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/multifactorChallenge(mfaToken:types:authenticatorId:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/multifactorChallenge(mfaToken:types:authenticatorId:)","kind":"symbol","title":"multifactorChallenge(mfaToken:types:authenticatorId:)","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"multifactorChallenge","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"mfaToken"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"types","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"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"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth09ChallengeV","text":"Challenge","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"defaultImplementations":1,"role":"symbol","required":true,"url":"\/documentation\/auth0\/authentication\/multifactorchallenge(mfatoken:types:authenticatorid:)","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."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Challenge":{"title":"Challenge","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Challenge"}],"abstract":[{"text":"A multi-factor challenge.","type":"text"}],"url":"\/documentation\/auth0\/challenge","navigatorTitle":[{"kind":"identifier","text":"Challenge"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"title":"Request","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"abstract":[{"text":"Auth0 API request.","type":"text"}],"url":"\/documentation\/auth0\/request","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/multifactorChallenge(mfaToken:types:authenticatorId:)-7xrct":{"role":"symbol","title":"multifactorChallenge(mfaToken:types:authenticatorId:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"multifactorChallenge","kind":"identifier"},{"text":"(","kind":"text"},{"text":"mfaToken","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"types","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"]?, "},{"kind":"externalParam","text":"authenticatorId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"?) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth09ChallengeV","text":"Challenge","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"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."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/multifactorChallenge(mfaToken:types:authenticatorId:)-7xrct","url":"\/documentation\/auth0\/authentication\/multifactorchallenge(mfatoken:types:authenticatorid:)-7xrct","type":"topic"},"https://auth0.com/docs/api/authentication/muti-factor-authentication/request-mfa-challenge":{"type":"link","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/muti-factor-authentication\/request-mfa-challenge","title":"Authentication API Endpoint","url":"https:\/\/auth0.com\/docs\/api\/authentication\/muti-factor-authentication\/request-mfa-challenge"},"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","url":"https:\/\/auth0.com\/docs\/api\/authentication"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authentication/passkeyloginchallenge(connection:organization:)-56e54.json b/docs/data/documentation/auth0/authentication/passkeyloginchallenge(connection:organization:)-56e54.json index a56a0562d..673c8db4c 100644 --- a/docs/data/documentation/auth0/authentication/passkeyloginchallenge(connection:organization:)-56e54.json +++ b/docs/data/documentation/auth0/authentication/passkeyloginchallenge(connection:organization:)-56e54.json @@ -1 +1 @@ -{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/passkeyLoginChallenge(connection:organization:)-56e54"},"kind":"symbol","metadata":{"role":"symbol","title":"passkeyLoginChallenge(connection:organization:)","modules":[{"name":"Auth0"}],"platforms":[{"deprecated":false,"beta":false,"unavailable":false,"name":"iOS","introducedAt":"16.6"},{"deprecated":false,"beta":false,"unavailable":false,"name":"iPadOS","introducedAt":"16.6"},{"deprecated":false,"beta":false,"unavailable":false,"name":"Mac Catalyst","introducedAt":"16.6"},{"name":"macOS","introducedAt":"13.5","beta":false,"deprecated":false,"unavailable":false},{"name":"visionOS","introducedAt":"1.0","beta":false,"deprecated":false,"unavailable":false}],"extendedModule":"Auth0","externalID":"s:5Auth014AuthenticationPAAE21passkeyLoginChallenge10connection12organizationAA7RequestVyAA07PasskeydE0VAA0B5ErrorVGSSSg_ANtF","symbolKind":"method","roleHeading":"Instance Method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"passkeyLoginChallenge","kind":"identifier"},{"text":"(","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"organization","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth021PasskeyLoginChallengeV","text":"PasskeyLoginChallenge","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}]},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"variants":[{"paths":["\/documentation\/auth0\/authentication\/passkeyloginchallenge(connection:organization:)-56e54"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"seeAlsoSections":[{"anchor":"Related-Documentation","identifiers":["https:\/\/auth0.com\/docs\/native-passkeys-api#request-login-challenge","https:\/\/auth0.com\/docs\/native-passkeys-for-mobile-applications","https:\/\/developer.apple.com\/documentation\/authenticationservices\/supporting-passkeys#Connect-to-a-service-with-an-existing-account"],"title":"Related Documentation"}],"schemaVersion":{"patch":0,"major":0,"minor":3},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"passkeyLoginChallenge"},{"kind":"text","text":"("},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"? = nil, "},{"kind":"externalParam","text":"organization"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"? = nil) -> "},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge","preciseIdentifier":"s:5Auth021PasskeyLoginChallengeV","text":"PasskeyLoginChallenge"},{"kind":"text","text":", "},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"languages":["swift"],"platforms":["iOS"]}]},{"kind":"parameters","parameters":[{"name":"connection","content":[{"type":"paragraph","inlineContent":[{"text":"Name of the database connection. If a connection name is not specified, your tenant’s default directory will be used.","type":"text"}]}]},{"name":"organization","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Identifier of an organization the user is a member of."}]}]}]},{"kind":"content","content":[{"text":"Return Value","anchor":"return-value","level":2,"type":"heading"},{"inlineContent":[{"type":"text","text":"A request that will yield a passkey login challenge."}],"type":"paragraph"}]},{"kind":"content","content":[{"text":"Availability","anchor":"Availability","type":"heading","level":2},{"inlineContent":[{"text":"This feature is currently available in","type":"text"},{"text":" ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","isActive":true,"type":"reference"},{"text":".","type":"text"},{"text":" ","type":"text"},{"text":"Please reach out to Auth0 support to get it enabled for your tenant.","type":"text"}],"type":"paragraph"},{"text":"Usage","anchor":"Usage","type":"heading","level":2},{"code":["Auth0"," .authentication()"," .passkeyLoginChallenge(connection: \"Username-Password-Authentication\")"," .start { result in"," switch result {"," case .success(let loginChallenge):"," print(\"Obtained login challenge: \\(loginChallenge)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"],"type":"codeListing","syntax":"swift"},{"inlineContent":[{"text":"Use the challenge with ","type":"text"},{"type":"reference","isActive":true,"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialprovider"},{"text":" ","type":"text"},{"text":"from the ","type":"text"},{"type":"codeVoice","code":"AuthenticationServices"},{"text":" framework to request an existing passkey credential. It will be delivered","type":"text"},{"text":" ","type":"text"},{"text":"through the ","type":"text"},{"type":"reference","isActive":true,"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate"},{"text":" ","type":"text"},{"text":"delegate. Check out ","type":"text"},{"type":"reference","isActive":true,"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/supporting-passkeys#Connect-to-a-service-with-an-existing-account"},{"text":" ","type":"text"},{"text":"to learn more.","type":"text"}],"type":"paragraph"},{"code":["let credentialProvider = ASAuthorizationPlatformPublicKeyCredentialProvider("," relyingPartyIdentifier: loginChallenge.relyingPartyId",")","","let request = credentialProvider.createCredentialAssertionRequest("," challenge: loginChallenge.challengeData",")","","let authController = ASAuthorizationController(authorizationRequests: [request])","authController.delegate = self \/\/ ASAuthorizationControllerDelegate","authController.presentationContextProvider = self","authController.performRequests()"],"type":"codeListing","syntax":"swift"},{"inlineContent":[{"text":"Then, call ","type":"text"},{"code":"login(passkey:challenge:connection:audience:scope:)-7s3cz","type":"codeVoice"},{"text":" with the resulting","type":"text"},{"text":" ","type":"text"},{"text":"passkey credential and the challenge to log the user in.","type":"text"}],"type":"paragraph"}]}],"abstract":[{"type":"text","text":"Requests a challenge for logging a user in with an existing passkey. This is the first part of the passkey login flow."}],"references":{"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://developer.apple.com/documentation/authenticationservices/asauthorizationplatformpublickeycredentialprovider":{"titleInlineContent":[{"type":"codeVoice","code":"ASAuthorizationPlatformPublicKeyCredentialProvider"}],"type":"link","url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialprovider","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialprovider","title":"ASAuthorizationPlatformPublicKeyCredentialProvider"},"https://auth0.com/docs/native-passkeys-api#request-login-challenge":{"type":"link","title":"Authentication API Endpoint","identifier":"https:\/\/auth0.com\/docs\/native-passkeys-api#request-login-challenge","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"url":"https:\/\/auth0.com\/docs\/native-passkeys-api#request-login-challenge"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access":{"titleInlineContent":[{"type":"text","text":"Early Access"}],"type":"link","url":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","title":"Early Access"},"https://auth0.com/docs/native-passkeys-for-mobile-applications":{"type":"link","title":"Native Passkeys for Mobile Applications","identifier":"https:\/\/auth0.com\/docs\/native-passkeys-for-mobile-applications","titleInlineContent":[{"type":"text","text":"Native Passkeys for Mobile Applications"}],"url":"https:\/\/auth0.com\/docs\/native-passkeys-for-mobile-applications"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyLoginChallenge":{"title":"PasskeyLoginChallenge","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasskeyLoginChallenge"}],"navigatorTitle":[{"kind":"identifier","text":"PasskeyLoginChallenge"}],"abstract":[{"text":"A passkey login challenge.","type":"text"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge","url":"\/documentation\/auth0\/passkeyloginchallenge","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/request","kind":"symbol","abstract":[{"type":"text","text":"Auth0 API request."}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/passkeyLoginChallenge(connection:organization:)-56e54":{"type":"topic","url":"\/documentation\/auth0\/authentication\/passkeyloginchallenge(connection:organization:)-56e54","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"passkeyLoginChallenge"},{"kind":"text","text":"("},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"organization"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?) -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"PasskeyLoginChallenge","preciseIdentifier":"s:5Auth021PasskeyLoginChallengeV"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"role":"symbol","kind":"symbol","abstract":[{"type":"text","text":"Requests a challenge for logging a user in with an existing passkey. This is the first part of the passkey login flow."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/passkeyLoginChallenge(connection:organization:)-56e54","title":"passkeyLoginChallenge(connection:organization:)"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"type":"topic","role":"symbol","title":"Authentication","abstract":[{"text":"Client for the ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"text":".","type":"text"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"https://developer.apple.com/documentation/authenticationservices/supporting-passkeys#Connect-to-a-service-with-an-existing-account":{"type":"link","title":"Supporting passkeys","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/supporting-passkeys#Connect-to-a-service-with-an-existing-account","titleInlineContent":[{"type":"text","text":"Supporting passkeys"}],"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/supporting-passkeys#Connect-to-a-service-with-an-existing-account"},"https://developer.apple.com/documentation/authenticationservices/asauthorizationcontrollerdelegate":{"titleInlineContent":[{"type":"codeVoice","code":"ASAuthorizationControllerDelegate"}],"type":"link","url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","title":"ASAuthorizationControllerDelegate"}}} \ No newline at end of file +{"abstract":[{"type":"text","text":"Requests a challenge for logging a user in with an existing passkey. This is the first part of the passkey login flow."}],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/native-passkeys-api#request-login-challenge","https:\/\/auth0.com\/docs\/native-passkeys-for-mobile-applications","https:\/\/developer.apple.com\/documentation\/authenticationservices\/supporting-passkeys#Connect-to-a-service-with-an-existing-account"],"anchor":"Related-Documentation"}],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"passkeyLoginChallenge"},{"kind":"text","text":"("},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"? = nil, "},{"kind":"externalParam","text":"organization"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"? = nil) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth021PasskeyLoginChallengeV","text":"PasskeyLoginChallenge","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"},{"kind":"text","text":">"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"text":"Name of the database connection. If a connection name is not specified, your tenant’s default directory will be used.","type":"text"}]}],"name":"connection"},{"content":[{"type":"paragraph","inlineContent":[{"text":"Identifier of an organization the user is a member of.","type":"text"}]}],"name":"organization"}]},{"content":[{"type":"heading","level":2,"anchor":"return-value","text":"Return Value"},{"inlineContent":[{"type":"text","text":"A request that will yield a passkey login challenge."}],"type":"paragraph"}],"kind":"content"},{"content":[{"type":"heading","level":2,"anchor":"Availability","text":"Availability"},{"inlineContent":[{"type":"text","text":"This feature is currently available in"},{"type":"text","text":" "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","isActive":true},{"type":"text","text":"."},{"type":"text","text":" "},{"type":"text","text":"Please reach out to Auth0 support to get it enabled for your tenant."}],"type":"paragraph"},{"type":"heading","level":2,"anchor":"Usage","text":"Usage"},{"code":["Auth0"," .authentication()"," .passkeyLoginChallenge(connection: \"Username-Password-Authentication\")"," .start { result in"," switch result {"," case .success(let loginChallenge):"," print(\"Obtained login challenge: \\(loginChallenge)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"],"type":"codeListing","syntax":"swift"},{"inlineContent":[{"type":"text","text":"Use the challenge with "},{"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialprovider","isActive":true},{"type":"text","text":" "},{"type":"text","text":"from the "},{"type":"codeVoice","code":"AuthenticationServices"},{"type":"text","text":" framework to request an existing passkey credential. It will be delivered"},{"type":"text","text":" "},{"type":"text","text":"through the "},{"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","isActive":true},{"type":"text","text":" "},{"type":"text","text":"delegate. Check out "},{"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/supporting-passkeys#Connect-to-a-service-with-an-existing-account","isActive":true},{"type":"text","text":" "},{"type":"text","text":"to learn more."}],"type":"paragraph"},{"code":["let credentialProvider = ASAuthorizationPlatformPublicKeyCredentialProvider("," relyingPartyIdentifier: loginChallenge.relyingPartyId",")","","let request = credentialProvider.createCredentialAssertionRequest("," challenge: loginChallenge.challengeData",")","","let authController = ASAuthorizationController(authorizationRequests: [request])","authController.delegate = self \/\/ ASAuthorizationControllerDelegate","authController.presentationContextProvider = self","authController.performRequests()"],"type":"codeListing","syntax":"swift"},{"inlineContent":[{"type":"text","text":"Then, call "},{"type":"codeVoice","code":"login(passkey:challenge:connection:audience:scope:)-7s3cz"},{"type":"text","text":" with the resulting"},{"type":"text","text":" "},{"type":"text","text":"passkey credential and the challenge to log the user in."}],"type":"paragraph"}],"kind":"content"}],"variants":[{"paths":["\/documentation\/auth0\/authentication\/passkeyloginchallenge(connection:organization:)-56e54"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"patch":0,"minor":3,"major":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"metadata":{"modules":[{"name":"Auth0"}],"title":"passkeyLoginChallenge(connection:organization:)","roleHeading":"Instance Method","symbolKind":"method","platforms":[{"deprecated":false,"introducedAt":"16.6","unavailable":false,"name":"iOS","beta":false},{"deprecated":false,"introducedAt":"16.6","unavailable":false,"name":"iPadOS","beta":false},{"deprecated":false,"introducedAt":"16.6","unavailable":false,"name":"Mac Catalyst","beta":false},{"deprecated":false,"introducedAt":"13.5","unavailable":false,"name":"macOS","beta":false},{"deprecated":false,"introducedAt":"1.0","unavailable":false,"name":"visionOS","beta":false}],"role":"symbol","extendedModule":"Auth0","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"passkeyLoginChallenge"},{"kind":"text","text":"("},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"organization"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth021PasskeyLoginChallengeV","text":"PasskeyLoginChallenge"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"externalID":"s:5Auth014AuthenticationPAAE21passkeyLoginChallenge10connection12organizationAA7RequestVyAA07PasskeydE0VAA0B5ErrorVGSSSg_ANtF"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/passkeyLoginChallenge(connection:organization:)-56e54","interfaceLanguage":"swift"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","abstract":[{"type":"text","text":"Client for the "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","isActive":true},{"type":"text","text":"."}],"type":"topic","title":"Authentication","url":"\/documentation\/auth0\/authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/passkeyLoginChallenge(connection:organization:)-56e54":{"type":"topic","abstract":[{"text":"Requests a challenge for logging a user in with an existing passkey. This is the first part of the passkey login flow.","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/authentication\/passkeyloginchallenge(connection:organization:)-56e54","title":"passkeyLoginChallenge(connection:organization:)","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"passkeyLoginChallenge"},{"kind":"text","text":"("},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"organization"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth021PasskeyLoginChallengeV","text":"PasskeyLoginChallenge"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/passkeyLoginChallenge(connection:organization:)-56e54"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"},"https://developer.apple.com/documentation/authenticationservices/asauthorizationplatformpublickeycredentialprovider":{"type":"link","titleInlineContent":[{"type":"codeVoice","code":"ASAuthorizationPlatformPublicKeyCredentialProvider"}],"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialprovider","title":"ASAuthorizationPlatformPublicKeyCredentialProvider","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialprovider"},"https://auth0.com/docs/api/authentication":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","url":"https:\/\/auth0.com\/docs\/api\/authentication","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"type":"link","title":"Auth0 Authentication API"},"https://developer.apple.com/documentation/authenticationservices/asauthorizationcontrollerdelegate":{"type":"link","titleInlineContent":[{"type":"codeVoice","code":"ASAuthorizationControllerDelegate"}],"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","title":"ASAuthorizationControllerDelegate","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate"},"https://developer.apple.com/documentation/authenticationservices/supporting-passkeys#Connect-to-a-service-with-an-existing-account":{"titleInlineContent":[{"type":"text","text":"Supporting passkeys"}],"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/supporting-passkeys#Connect-to-a-service-with-an-existing-account","type":"link","title":"Supporting passkeys","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/supporting-passkeys#Connect-to-a-service-with-an-existing-account"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyLoginChallenge":{"title":"PasskeyLoginChallenge","role":"symbol","navigatorTitle":[{"text":"PasskeyLoginChallenge","kind":"identifier"}],"kind":"symbol","abstract":[{"text":"A passkey login challenge.","type":"text"}],"url":"\/documentation\/auth0\/passkeyloginchallenge","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"PasskeyLoginChallenge"}],"type":"topic"},"https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access":{"type":"link","titleInlineContent":[{"type":"text","text":"Early Access"}],"url":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","title":"Early Access","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"https://auth0.com/docs/native-passkeys-for-mobile-applications":{"type":"link","titleInlineContent":[{"type":"text","text":"Native Passkeys for Mobile Applications"}],"url":"https:\/\/auth0.com\/docs\/native-passkeys-for-mobile-applications","title":"Native Passkeys for Mobile Applications","identifier":"https:\/\/auth0.com\/docs\/native-passkeys-for-mobile-applications"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"title":"Request","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"abstract":[{"text":"Auth0 API request.","type":"text"}],"url":"\/documentation\/auth0\/request","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"https://auth0.com/docs/native-passkeys-api#request-login-challenge":{"type":"link","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"url":"https:\/\/auth0.com\/docs\/native-passkeys-api#request-login-challenge","title":"Authentication API Endpoint","identifier":"https:\/\/auth0.com\/docs\/native-passkeys-api#request-login-challenge"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authentication/passkeyloginchallenge(connection:organization:).json b/docs/data/documentation/auth0/authentication/passkeyloginchallenge(connection:organization:).json index 03abd0020..04755aad9 100644 --- a/docs/data/documentation/auth0/authentication/passkeyloginchallenge(connection:organization:).json +++ b/docs/data/documentation/auth0/authentication/passkeyloginchallenge(connection:organization:).json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"passkeyLoginChallenge","kind":"identifier"},{"text":"(","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"organization","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth021PasskeyLoginChallengeV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge","text":"PasskeyLoginChallenge","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}]},{"kind":"parameters","parameters":[{"name":"connection","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Name of the database connection. If a connection name is not specified, your tenant’s default directory will be used."}]}]},{"name":"organization","content":[{"inlineContent":[{"text":"Identifier of an organization the user is a member of.","type":"text"}],"type":"paragraph"}]}]},{"kind":"content","content":[{"anchor":"return-value","type":"heading","level":2,"text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A request that will yield a passkey login challenge."}]}]},{"kind":"content","content":[{"level":2,"anchor":"Availability","text":"Availability","type":"heading"},{"inlineContent":[{"type":"text","text":"This feature is currently available in"},{"type":"text","text":" "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","isActive":true},{"type":"text","text":"."},{"type":"text","text":" "},{"type":"text","text":"Please reach out to Auth0 support to get it enabled for your tenant."}],"type":"paragraph"},{"level":2,"anchor":"Usage","text":"Usage","type":"heading"},{"syntax":"swift","code":["Auth0"," .authentication()"," .passkeyLoginChallenge(connection: \"Username-Password-Authentication\")"," .start { result in"," switch result {"," case .success(let loginChallenge):"," print(\"Obtained login challenge: \\(loginChallenge)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"],"type":"codeListing"},{"inlineContent":[{"text":"Use the challenge with ","type":"text"},{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialprovider","isActive":true,"type":"reference"},{"text":" ","type":"text"},{"text":"from the ","type":"text"},{"code":"AuthenticationServices","type":"codeVoice"},{"text":" framework to request an existing passkey credential. It will be delivered","type":"text"},{"text":" ","type":"text"},{"text":"through the ","type":"text"},{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","isActive":true,"type":"reference"},{"text":" ","type":"text"},{"text":"delegate. Check out ","type":"text"},{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/supporting-passkeys#Connect-to-a-service-with-an-existing-account","isActive":true,"type":"reference"},{"text":" ","type":"text"},{"text":"to learn more.","type":"text"}],"type":"paragraph"},{"syntax":"swift","code":["let credentialProvider = ASAuthorizationPlatformPublicKeyCredentialProvider("," relyingPartyIdentifier: loginChallenge.relyingPartyId",")","","let request = credentialProvider.createCredentialAssertionRequest("," challenge: loginChallenge.challengeData",")","","let authController = ASAuthorizationController(authorizationRequests: [request])","authController.delegate = self \/\/ ASAuthorizationControllerDelegate","authController.presentationContextProvider = self","authController.performRequests()"],"type":"codeListing"},{"inlineContent":[{"text":"Then, call ","type":"text"},{"code":"login(passkey:challenge:connection:audience:scope:)-7s3cz","type":"codeVoice"},{"text":" with the resulting","type":"text"},{"text":" ","type":"text"},{"text":"passkey credential and the challenge to log the user in.","type":"text"}],"type":"paragraph"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/passkeyLoginChallenge(connection:organization:)","interfaceLanguage":"swift"},"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/native-passkeys-api#request-login-challenge","https:\/\/auth0.com\/docs\/native-passkeys-for-mobile-applications","https:\/\/developer.apple.com\/documentation\/authenticationservices\/supporting-passkeys#Connect-to-a-service-with-an-existing-account"],"title":"Related Documentation","anchor":"Related-Documentation"}],"defaultImplementationsSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/passkeyLoginChallenge(connection:organization:)-56e54"],"title":"Authentication Implementations","anchor":"Authentication-Implementations"}],"abstract":[{"text":"Requests a challenge for logging a user in with an existing passkey. This is the first part of the passkey login flow.","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"variants":[{"paths":["\/documentation\/auth0\/authentication\/passkeyloginchallenge(connection:organization:)"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","metadata":{"required":true,"platforms":[{"beta":false,"unavailable":false,"name":"iOS","introducedAt":"16.6","deprecated":false},{"beta":false,"unavailable":false,"name":"iPadOS","introducedAt":"16.6","deprecated":false},{"beta":false,"unavailable":false,"name":"Mac Catalyst","introducedAt":"16.6","deprecated":false},{"beta":false,"unavailable":false,"name":"macOS","introducedAt":"13.5","deprecated":false},{"beta":false,"unavailable":false,"name":"visionOS","introducedAt":"1.0","deprecated":false}],"title":"passkeyLoginChallenge(connection:organization:)","roleHeading":"Instance Method","externalID":"s:5Auth014AuthenticationP21passkeyLoginChallenge10connection12organizationAA7RequestVyAA07PasskeydE0VAA0B5ErrorVGSSSg_ANtF","modules":[{"name":"Auth0"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"passkeyLoginChallenge","kind":"identifier"},{"text":"(","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"text":"organization","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?) -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"PasskeyLoginChallenge","kind":"typeIdentifier","preciseIdentifier":"s:5Auth021PasskeyLoginChallengeV"},{"text":", ","kind":"text"},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"role":"symbol","symbolKind":"method"},"schemaVersion":{"minor":3,"patch":0,"major":0},"sections":[],"references":{"https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access":{"identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","title":"Early Access","type":"link","titleInlineContent":[{"text":"Early Access","type":"text"}],"url":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access"},"https://auth0.com/docs/native-passkeys-for-mobile-applications":{"identifier":"https:\/\/auth0.com\/docs\/native-passkeys-for-mobile-applications","title":"Native Passkeys for Mobile Applications","type":"link","titleInlineContent":[{"text":"Native Passkeys for Mobile Applications","type":"text"}],"url":"https:\/\/auth0.com\/docs\/native-passkeys-for-mobile-applications"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"https://developer.apple.com/documentation/authenticationservices/supporting-passkeys#Connect-to-a-service-with-an-existing-account":{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/supporting-passkeys#Connect-to-a-service-with-an-existing-account","title":"Supporting passkeys","type":"link","titleInlineContent":[{"text":"Supporting passkeys","type":"text"}],"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/supporting-passkeys#Connect-to-a-service-with-an-existing-account"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/request","kind":"symbol","abstract":[{"type":"text","text":"Auth0 API request."}]},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyLoginChallenge":{"title":"PasskeyLoginChallenge","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasskeyLoginChallenge"}],"navigatorTitle":[{"kind":"identifier","text":"PasskeyLoginChallenge"}],"abstract":[{"text":"A passkey login challenge.","type":"text"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge","url":"\/documentation\/auth0\/passkeyloginchallenge","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/passkeyLoginChallenge(connection:organization:)":{"url":"\/documentation\/auth0\/authentication\/passkeyloginchallenge(connection:organization:)","abstract":[{"text":"Requests a challenge for logging a user in with an existing passkey. This is the first part of the passkey login flow.","type":"text"}],"title":"passkeyLoginChallenge(connection:organization:)","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"passkeyLoginChallenge","kind":"identifier"},{"text":"(","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"text":"organization","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?) -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"PasskeyLoginChallenge","kind":"typeIdentifier","preciseIdentifier":"s:5Auth021PasskeyLoginChallengeV"},{"text":", ","kind":"text"},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"defaultImplementations":1,"required":true,"role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/passkeyLoginChallenge(connection:organization:)"},"https://auth0.com/docs/api/authentication":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","title":"Auth0 Authentication API","type":"link","titleInlineContent":[{"text":"Auth0 Authentication API","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"type":"topic","role":"symbol","title":"Authentication","abstract":[{"text":"Client for the ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"text":".","type":"text"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"https://developer.apple.com/documentation/authenticationservices/asauthorizationplatformpublickeycredentialprovider":{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialprovider","title":"ASAuthorizationPlatformPublicKeyCredentialProvider","type":"link","titleInlineContent":[{"code":"ASAuthorizationPlatformPublicKeyCredentialProvider","type":"codeVoice"}],"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialprovider"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/passkeyLoginChallenge(connection:organization:)-56e54":{"type":"topic","url":"\/documentation\/auth0\/authentication\/passkeyloginchallenge(connection:organization:)-56e54","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"passkeyLoginChallenge"},{"kind":"text","text":"("},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"organization"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?) -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"PasskeyLoginChallenge","preciseIdentifier":"s:5Auth021PasskeyLoginChallengeV"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"role":"symbol","kind":"symbol","abstract":[{"type":"text","text":"Requests a challenge for logging a user in with an existing passkey. This is the first part of the passkey login flow."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/passkeyLoginChallenge(connection:organization:)-56e54","title":"passkeyLoginChallenge(connection:organization:)"},"https://auth0.com/docs/native-passkeys-api#request-login-challenge":{"identifier":"https:\/\/auth0.com\/docs\/native-passkeys-api#request-login-challenge","title":"Authentication API Endpoint","type":"link","titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}],"url":"https:\/\/auth0.com\/docs\/native-passkeys-api#request-login-challenge"},"https://developer.apple.com/documentation/authenticationservices/asauthorizationcontrollerdelegate":{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","title":"ASAuthorizationControllerDelegate","type":"link","titleInlineContent":[{"code":"ASAuthorizationControllerDelegate","type":"codeVoice"}],"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate"}}} \ No newline at end of file +{"metadata":{"platforms":[{"introducedAt":"16.6","deprecated":false,"unavailable":false,"beta":false,"name":"iOS"},{"introducedAt":"16.6","deprecated":false,"unavailable":false,"beta":false,"name":"iPadOS"},{"introducedAt":"16.6","deprecated":false,"unavailable":false,"beta":false,"name":"Mac Catalyst"},{"introducedAt":"13.5","deprecated":false,"unavailable":false,"beta":false,"name":"macOS"},{"introducedAt":"1.0","deprecated":false,"unavailable":false,"beta":false,"name":"visionOS"}],"symbolKind":"method","roleHeading":"Instance Method","title":"passkeyLoginChallenge(connection:organization:)","externalID":"s:5Auth014AuthenticationP21passkeyLoginChallenge10connection12organizationAA7RequestVyAA07PasskeydE0VAA0B5ErrorVGSSSg_ANtF","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"passkeyLoginChallenge"},{"kind":"text","text":"("},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"organization"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth021PasskeyLoginChallengeV","text":"PasskeyLoginChallenge"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"role":"symbol","required":true},"sections":[],"variants":[{"paths":["\/documentation\/auth0\/authentication\/passkeyloginchallenge(connection:organization:)"],"traits":[{"interfaceLanguage":"swift"}]}],"defaultImplementationsSections":[{"anchor":"Authentication-Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/passkeyLoginChallenge(connection:organization:)-56e54"],"title":"Authentication Implementations"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/passkeyLoginChallenge(connection:organization:)","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"type":"text","text":"Requests a challenge for logging a user in with an existing passkey. This is the first part of the passkey login flow."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"seeAlsoSections":[{"anchor":"Related-Documentation","identifiers":["https:\/\/auth0.com\/docs\/native-passkeys-api#request-login-challenge","https:\/\/auth0.com\/docs\/native-passkeys-for-mobile-applications","https:\/\/developer.apple.com\/documentation\/authenticationservices\/supporting-passkeys#Connect-to-a-service-with-an-existing-account"],"title":"Related Documentation"}],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"passkeyLoginChallenge"},{"kind":"text","text":"("},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"organization"},{"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"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth021PasskeyLoginChallengeV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge","text":"PasskeyLoginChallenge"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","text":"AuthenticationError"},{"kind":"text","text":">"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"},{"parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Name of the database connection. If a connection name is not specified, your tenant’s default directory will be used."}]}],"name":"connection"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Identifier of an organization the user is a member of."}]}],"name":"organization"}],"kind":"parameters"},{"content":[{"type":"heading","level":2,"anchor":"return-value","text":"Return Value"},{"inlineContent":[{"type":"text","text":"A request that will yield a passkey login challenge."}],"type":"paragraph"}],"kind":"content"},{"content":[{"type":"heading","level":2,"anchor":"Availability","text":"Availability"},{"inlineContent":[{"type":"text","text":"This feature is currently available in"},{"type":"text","text":" "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access"},{"type":"text","text":"."},{"type":"text","text":" "},{"type":"text","text":"Please reach out to Auth0 support to get it enabled for your tenant."}],"type":"paragraph"},{"type":"heading","level":2,"anchor":"Usage","text":"Usage"},{"code":["Auth0"," .authentication()"," .passkeyLoginChallenge(connection: \"Username-Password-Authentication\")"," .start { result in"," switch result {"," case .success(let loginChallenge):"," print(\"Obtained login challenge: \\(loginChallenge)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"],"type":"codeListing","syntax":"swift"},{"inlineContent":[{"type":"text","text":"Use the challenge with "},{"isActive":true,"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialprovider"},{"type":"text","text":" "},{"type":"text","text":"from the "},{"type":"codeVoice","code":"AuthenticationServices"},{"type":"text","text":" framework to request an existing passkey credential. It will be delivered"},{"type":"text","text":" "},{"type":"text","text":"through the "},{"isActive":true,"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate"},{"type":"text","text":" "},{"type":"text","text":"delegate. Check out "},{"isActive":true,"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/supporting-passkeys#Connect-to-a-service-with-an-existing-account"},{"type":"text","text":" "},{"type":"text","text":"to learn more."}],"type":"paragraph"},{"code":["let credentialProvider = ASAuthorizationPlatformPublicKeyCredentialProvider("," relyingPartyIdentifier: loginChallenge.relyingPartyId",")","","let request = credentialProvider.createCredentialAssertionRequest("," challenge: loginChallenge.challengeData",")","","let authController = ASAuthorizationController(authorizationRequests: [request])","authController.delegate = self \/\/ ASAuthorizationControllerDelegate","authController.presentationContextProvider = self","authController.performRequests()"],"type":"codeListing","syntax":"swift"},{"inlineContent":[{"type":"text","text":"Then, call "},{"type":"codeVoice","code":"login(passkey:challenge:connection:audience:scope:)-7s3cz"},{"type":"text","text":" with the resulting"},{"type":"text","text":" "},{"type":"text","text":"passkey credential and the challenge to log the user in."}],"type":"paragraph"}],"kind":"content"}],"schemaVersion":{"patch":0,"minor":3,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","abstract":[{"type":"text","text":"Client for the "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","isActive":true},{"type":"text","text":"."}],"type":"topic","title":"Authentication","url":"\/documentation\/auth0\/authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access":{"title":"Early Access","titleInlineContent":[{"type":"text","text":"Early Access"}],"url":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","type":"link"},"https://developer.apple.com/documentation/authenticationservices/asauthorizationplatformpublickeycredentialprovider":{"title":"ASAuthorizationPlatformPublicKeyCredentialProvider","titleInlineContent":[{"code":"ASAuthorizationPlatformPublicKeyCredentialProvider","type":"codeVoice"}],"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialprovider","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialprovider","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyLoginChallenge":{"title":"PasskeyLoginChallenge","role":"symbol","navigatorTitle":[{"text":"PasskeyLoginChallenge","kind":"identifier"}],"kind":"symbol","abstract":[{"text":"A passkey login challenge.","type":"text"}],"url":"\/documentation\/auth0\/passkeyloginchallenge","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"PasskeyLoginChallenge"}],"type":"topic"},"https://auth0.com/docs/api/authentication":{"title":"Auth0 Authentication API","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"title":"Request","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"abstract":[{"text":"Auth0 API request.","type":"text"}],"url":"\/documentation\/auth0\/request","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"https://auth0.com/docs/native-passkeys-for-mobile-applications":{"title":"Native Passkeys for Mobile Applications","titleInlineContent":[{"type":"text","text":"Native Passkeys for Mobile Applications"}],"url":"https:\/\/auth0.com\/docs\/native-passkeys-for-mobile-applications","identifier":"https:\/\/auth0.com\/docs\/native-passkeys-for-mobile-applications","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/passkeyLoginChallenge(connection:organization:)":{"defaultImplementations":1,"type":"topic","abstract":[{"type":"text","text":"Requests a challenge for logging a user in with an existing passkey. This is the first part of the passkey login flow."}],"title":"passkeyLoginChallenge(connection:organization:)","kind":"symbol","url":"\/documentation\/auth0\/authentication\/passkeyloginchallenge(connection:organization:)","required":true,"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"passkeyLoginChallenge","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"connection"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"organization"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"?) -> "},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:5Auth021PasskeyLoginChallengeV","text":"PasskeyLoginChallenge","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/passkeyLoginChallenge(connection:organization:)"},"https://auth0.com/docs/native-passkeys-api#request-login-challenge":{"title":"Authentication API Endpoint","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"url":"https:\/\/auth0.com\/docs\/native-passkeys-api#request-login-challenge","identifier":"https:\/\/auth0.com\/docs\/native-passkeys-api#request-login-challenge","type":"link"},"https://developer.apple.com/documentation/authenticationservices/asauthorizationcontrollerdelegate":{"title":"ASAuthorizationControllerDelegate","titleInlineContent":[{"code":"ASAuthorizationControllerDelegate","type":"codeVoice"}],"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","type":"link"},"https://developer.apple.com/documentation/authenticationservices/supporting-passkeys#Connect-to-a-service-with-an-existing-account":{"title":"Supporting passkeys","titleInlineContent":[{"type":"text","text":"Supporting passkeys"}],"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/supporting-passkeys#Connect-to-a-service-with-an-existing-account","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/supporting-passkeys#Connect-to-a-service-with-an-existing-account","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/passkeyLoginChallenge(connection:organization:)-56e54":{"type":"topic","abstract":[{"text":"Requests a challenge for logging a user in with an existing passkey. This is the first part of the passkey login flow.","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/authentication\/passkeyloginchallenge(connection:organization:)-56e54","title":"passkeyLoginChallenge(connection:organization:)","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"passkeyLoginChallenge"},{"kind":"text","text":"("},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"organization"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth021PasskeyLoginChallengeV","text":"PasskeyLoginChallenge"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/passkeyLoginChallenge(connection:organization:)-56e54"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authentication/passkeysignupchallenge(email:phonenumber:username:name:connection:organization:)-8jlyt.json b/docs/data/documentation/auth0/authentication/passkeysignupchallenge(email:phonenumber:username:name:connection:organization:)-8jlyt.json index 6c07cc6c4..309f4651b 100644 --- a/docs/data/documentation/auth0/authentication/passkeysignupchallenge(email:phonenumber:username:name:connection:organization:)-8jlyt.json +++ b/docs/data/documentation/auth0/authentication/passkeysignupchallenge(email:phonenumber:username:name:connection:organization:)-8jlyt.json @@ -1 +1 @@ -{"seeAlsoSections":[{"anchor":"Related-Documentation","title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/native-passkeys-api#request-signup-challenge","https:\/\/auth0.com\/docs\/native-passkeys-for-mobile-applications","https:\/\/developer.apple.com\/documentation\/authenticationservices\/supporting-passkeys#Register-a-new-account-on-a-service"]}],"sections":[],"variants":[{"paths":["\/documentation\/auth0\/authentication\/passkeysignupchallenge(email:phonenumber:username:name:connection:organization:)-8jlyt"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/passkeySignupChallenge(email:phoneNumber:username:name:connection:organization:)-8jlyt"},"metadata":{"title":"passkeySignupChallenge(email:phoneNumber:username:name:connection:organization:)","platforms":[{"beta":false,"name":"iOS","deprecated":false,"introducedAt":"16.6","unavailable":false},{"beta":false,"name":"iPadOS","deprecated":false,"introducedAt":"16.6","unavailable":false},{"beta":false,"name":"Mac Catalyst","deprecated":false,"introducedAt":"16.6","unavailable":false},{"beta":false,"name":"macOS","deprecated":false,"introducedAt":"13.5","unavailable":false},{"beta":false,"name":"visionOS","deprecated":false,"introducedAt":"1.0","unavailable":false}],"role":"symbol","extendedModule":"Auth0","externalID":"s:5Auth014AuthenticationPAAE22passkeySignupChallenge5email11phoneNumber8username4name10connection12organizationAA7RequestVyAA07PasskeydE0VAA0B5ErrorVGSSSg_A5RtF","modules":[{"name":"Auth0"}],"symbolKind":"method","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"passkeySignupChallenge"},{"kind":"text","text":"("},{"kind":"externalParam","text":"email"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"phoneNumber"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"username"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"name"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"organization"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?) -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"PasskeySignupChallenge","preciseIdentifier":"s:5Auth022PasskeySignupChallengeV"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}]},"abstract":[{"text":"Requests a challenge for registering a new user with a passkey. This is the first part of the passkey signup flow.","type":"text"}],"schemaVersion":{"major":0,"patch":0,"minor":3},"kind":"symbol","primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"passkeySignupChallenge"},{"kind":"text","text":"("},{"kind":"externalParam","text":"email"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"? = nil, "},{"kind":"externalParam","text":"phoneNumber"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"? = nil, "},{"kind":"externalParam","text":"username"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"? = nil, "},{"kind":"externalParam","text":"name"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"? = nil, "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"? = nil, "},{"kind":"externalParam","text":"organization"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"? = nil) -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"PasskeySignupChallenge","preciseIdentifier":"s:5Auth022PasskeySignupChallengeV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"},{"kind":"text","text":">"}],"languages":["swift"]}],"kind":"declarations"},{"parameters":[{"name":"email","content":[{"inlineContent":[{"type":"text","text":"Email address of the user. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"type":"paragraph"}]},{"name":"phoneNumber","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Phone number of the user. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}]}]},{"name":"username","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Username of the user. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}]}]},{"name":"name","content":[{"inlineContent":[{"type":"text","text":"Display name of the user. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"type":"paragraph"}]},{"name":"connection","content":[{"inlineContent":[{"type":"text","text":"Name of the database connection where the user will be created. If a connection name is not specified, your tenant’s default directory will be used."}],"type":"paragraph"}]},{"name":"organization","content":[{"inlineContent":[{"type":"text","text":"Identifier of an organization the user is a member of."}],"type":"paragraph"}]}],"kind":"parameters"},{"content":[{"anchor":"return-value","text":"Return Value","type":"heading","level":2},{"inlineContent":[{"text":"A request that will yield a passkey signup challenge.","type":"text"}],"type":"paragraph"}],"kind":"content"},{"content":[{"type":"heading","level":2,"text":"Discussion","anchor":"discussion"},{"type":"paragraph","inlineContent":[{"text":"You need to provide at least one user identifier when requesting the challenge, along with an optional user","type":"text"},{"text":" ","type":"text"},{"text":"display name, and an optional database connection name. If a connection name is not specified, your tenant’s","type":"text"},{"text":" ","type":"text"},{"text":"default directory will be used.","type":"text"}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"By default, database connections require a valid "},{"type":"codeVoice","code":"email"},{"type":"text","text":". If you have enabled "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/authenticate\/database-connections\/activate-and-configure-attributes-for-flexible-identifiers","isActive":true},{"type":"text","text":" "},{"type":"text","text":"for your database connection, you may use any combination of "},{"type":"codeVoice","code":"email"},{"type":"text","text":", "},{"type":"codeVoice","code":"phoneNumber"},{"type":"text","text":", or "},{"type":"codeVoice","code":"username"},{"type":"text","text":". These user"},{"type":"text","text":" "},{"type":"text","text":"identifiers can be required or optional and must match your Flexible Identifiers configuration."}]},{"type":"heading","level":2,"text":"Availability","anchor":"Availability"},{"type":"paragraph","inlineContent":[{"text":"This feature is currently available in","type":"text"},{"text":" ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","type":"reference","isActive":true},{"text":".","type":"text"},{"text":" ","type":"text"},{"text":"Please reach out to Auth0 support to get it enabled for your tenant.","type":"text"}]},{"type":"heading","level":2,"text":"Usage","anchor":"Usage"},{"type":"codeListing","syntax":"swift","code":["Auth0"," .authentication()"," .passkeySignupChallenge(email: \"support@auth0.com\","," name: \"John Appleseed\","," connection: \"Username-Password-Authentication\","," organization: \"org_aaAA1aa11aAAAA1a\")"," .start { result in"," switch result {"," case .success(let signupChallenge):"," print(\"Obtained signup challenge: \\(signupChallenge)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"]},{"type":"paragraph","inlineContent":[{"text":"Use the challenge with ","type":"text"},{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialprovider","isActive":true,"type":"reference"},{"text":" ","type":"text"},{"text":"from the ","type":"text"},{"code":"AuthenticationServices","type":"codeVoice"},{"text":" framework to generate a new passkey credential. It will be delivered through the ","type":"text"},{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","isActive":true,"type":"reference"},{"text":" ","type":"text"},{"text":"delegate. Check out ","type":"text"},{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/supporting-passkeys#Register-a-new-account-on-a-service","isActive":true,"type":"reference"},{"text":" ","type":"text"},{"text":"to learn more.","type":"text"}]},{"type":"codeListing","syntax":"swift","code":["let credentialProvider = ASAuthorizationPlatformPublicKeyCredentialProvider("," relyingPartyIdentifier: signupChallenge.relyingPartyId",")","","let request = credentialProvider.createCredentialRegistrationRequest("," challenge: signupChallenge.challengeData,"," name: signupChallenge.userName,"," userID: signupChallenge.userId",")","","let authController = ASAuthorizationController(authorizationRequests: [request])","authController.delegate = self \/\/ ASAuthorizationControllerDelegate","authController.presentationContextProvider = self","authController.performRequests()"]},{"type":"paragraph","inlineContent":[{"text":"Then, call ","type":"text"},{"type":"codeVoice","code":"login(passkey:challenge:connection:audience:scope:)-4q8i0"},{"text":" with the created","type":"text"},{"text":" ","type":"text"},{"text":"passkey credential and the challenge to log the new user in.","type":"text"}]}],"kind":"content"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"references":{"https://developer.apple.com/documentation/authenticationservices/asauthorizationplatformpublickeycredentialprovider":{"titleInlineContent":[{"code":"ASAuthorizationPlatformPublicKeyCredentialProvider","type":"codeVoice"}],"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialprovider","type":"link","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialprovider","title":"ASAuthorizationPlatformPublicKeyCredentialProvider"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/request","kind":"symbol","abstract":[{"type":"text","text":"Auth0 API request."}]},"https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access":{"titleInlineContent":[{"text":"Early Access","type":"text"}],"url":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","type":"link","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","title":"Early Access"},"https://developer.apple.com/documentation/authenticationservices/supporting-passkeys#Register-a-new-account-on-a-service":{"titleInlineContent":[{"type":"text","text":"Supporting passkeys"}],"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/supporting-passkeys#Register-a-new-account-on-a-service","type":"link","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/supporting-passkeys#Register-a-new-account-on-a-service","title":"Supporting passkeys"},"https://auth0.com/docs/native-passkeys-api#request-signup-challenge":{"titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}],"url":"https:\/\/auth0.com\/docs\/native-passkeys-api#request-signup-challenge","type":"link","identifier":"https:\/\/auth0.com\/docs\/native-passkeys-api#request-signup-challenge","title":"Authentication API Endpoint"},"https://auth0.com/docs/authenticate/database-connections/activate-and-configure-attributes-for-flexible-identifiers":{"titleInlineContent":[{"type":"text","text":"Flexible Identifiers"}],"url":"https:\/\/auth0.com\/docs\/authenticate\/database-connections\/activate-and-configure-attributes-for-flexible-identifiers","type":"link","identifier":"https:\/\/auth0.com\/docs\/authenticate\/database-connections\/activate-and-configure-attributes-for-flexible-identifiers","title":"Flexible Identifiers"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"https://auth0.com/docs/api/authentication":{"titleInlineContent":[{"text":"Auth0 Authentication API","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","title":"Auth0 Authentication API"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"https://auth0.com/docs/native-passkeys-for-mobile-applications":{"titleInlineContent":[{"type":"text","text":"Native Passkeys for Mobile Applications"}],"url":"https:\/\/auth0.com\/docs\/native-passkeys-for-mobile-applications","type":"link","identifier":"https:\/\/auth0.com\/docs\/native-passkeys-for-mobile-applications","title":"Native Passkeys for Mobile Applications"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeySignupChallenge":{"type":"topic","abstract":[{"type":"text","text":"A passkey signup challenge."}],"kind":"symbol","title":"PasskeySignupChallenge","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge","role":"symbol","url":"\/documentation\/auth0\/passkeysignupchallenge","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasskeySignupChallenge"}],"navigatorTitle":[{"kind":"identifier","text":"PasskeySignupChallenge"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"type":"topic","role":"symbol","title":"Authentication","abstract":[{"text":"Client for the ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"text":".","type":"text"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"https://developer.apple.com/documentation/authenticationservices/asauthorizationcontrollerdelegate":{"titleInlineContent":[{"code":"ASAuthorizationControllerDelegate","type":"codeVoice"}],"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","type":"link","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","title":"ASAuthorizationControllerDelegate"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/passkeySignupChallenge(email:phoneNumber:username:name:connection:organization:)-8jlyt":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/passkeySignupChallenge(email:phoneNumber:username:name:connection:organization:)-8jlyt","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"passkeySignupChallenge"},{"kind":"text","text":"("},{"kind":"externalParam","text":"email"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"phoneNumber"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"username"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"name"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"organization"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth022PasskeySignupChallengeV","text":"PasskeySignupChallenge"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/authentication\/passkeysignupchallenge(email:phonenumber:username:name:connection:organization:)-8jlyt","title":"passkeySignupChallenge(email:phoneNumber:username:name:connection:organization:)","abstract":[{"type":"text","text":"Requests a challenge for registering a new user with a passkey. This is the first part of the passkey signup flow."}]}}} \ No newline at end of file +{"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"passkeySignupChallenge","kind":"identifier"},{"text":"(","kind":"text"},{"text":"email","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"? = nil, ","kind":"text"},{"text":"phoneNumber","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"? = nil, ","kind":"text"},{"text":"username","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"? = nil, ","kind":"text"},{"text":"name","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"? = nil, ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"? = nil, ","kind":"text"},{"text":"organization","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"? = nil) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth022PasskeySignupChallengeV","text":"PasskeySignupChallenge","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"},{"text":">","kind":"text"}],"platforms":["iOS"]}]},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Email address of the user. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}]}],"name":"email"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Phone number of the user. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}]}],"name":"phoneNumber"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Username of the user. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}]}],"name":"username"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Display name of the user. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}]}],"name":"name"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Name of the database connection where the user will be created. If a connection name is not specified, your tenant’s default directory will be used."}]}],"name":"connection"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Identifier of an organization the user is a member of."}]}],"name":"organization"}]},{"content":[{"text":"Return Value","level":2,"anchor":"return-value","type":"heading"},{"inlineContent":[{"type":"text","text":"A request that will yield a passkey signup challenge."}],"type":"paragraph"}],"kind":"content"},{"content":[{"text":"Discussion","level":2,"anchor":"discussion","type":"heading"},{"inlineContent":[{"type":"text","text":"You need to provide at least one user identifier when requesting the challenge, along with an optional user"},{"type":"text","text":" "},{"type":"text","text":"display name, and an optional database connection name. If a connection name is not specified, your tenant’s"},{"type":"text","text":" "},{"type":"text","text":"default directory will be used."}],"type":"paragraph"},{"inlineContent":[{"type":"text","text":"By default, database connections require a valid "},{"type":"codeVoice","code":"email"},{"type":"text","text":". If you have enabled "},{"type":"reference","isActive":true,"identifier":"https:\/\/auth0.com\/docs\/authenticate\/database-connections\/activate-and-configure-attributes-for-flexible-identifiers"},{"type":"text","text":" "},{"type":"text","text":"for your database connection, you may use any combination of "},{"type":"codeVoice","code":"email"},{"type":"text","text":", "},{"type":"codeVoice","code":"phoneNumber"},{"type":"text","text":", or "},{"type":"codeVoice","code":"username"},{"type":"text","text":". These user"},{"type":"text","text":" "},{"type":"text","text":"identifiers can be required or optional and must match your Flexible Identifiers configuration."}],"type":"paragraph"},{"text":"Availability","level":2,"anchor":"Availability","type":"heading"},{"inlineContent":[{"type":"text","text":"This feature is currently available in"},{"type":"text","text":" "},{"type":"reference","isActive":true,"identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access"},{"type":"text","text":"."},{"type":"text","text":" "},{"type":"text","text":"Please reach out to Auth0 support to get it enabled for your tenant."}],"type":"paragraph"},{"text":"Usage","level":2,"anchor":"Usage","type":"heading"},{"syntax":"swift","code":["Auth0"," .authentication()"," .passkeySignupChallenge(email: \"support@auth0.com\","," name: \"John Appleseed\","," connection: \"Username-Password-Authentication\","," organization: \"org_aaAA1aa11aAAAA1a\")"," .start { result in"," switch result {"," case .success(let signupChallenge):"," print(\"Obtained signup challenge: \\(signupChallenge)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"],"type":"codeListing"},{"inlineContent":[{"type":"text","text":"Use the challenge with "},{"type":"reference","isActive":true,"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialprovider"},{"type":"text","text":" "},{"type":"text","text":"from the "},{"type":"codeVoice","code":"AuthenticationServices"},{"type":"text","text":" framework to generate a new passkey credential. It will be delivered through the "},{"type":"reference","isActive":true,"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate"},{"type":"text","text":" "},{"type":"text","text":"delegate. Check out "},{"type":"reference","isActive":true,"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/supporting-passkeys#Register-a-new-account-on-a-service"},{"type":"text","text":" "},{"type":"text","text":"to learn more."}],"type":"paragraph"},{"syntax":"swift","code":["let credentialProvider = ASAuthorizationPlatformPublicKeyCredentialProvider("," relyingPartyIdentifier: signupChallenge.relyingPartyId",")","","let request = credentialProvider.createCredentialRegistrationRequest("," challenge: signupChallenge.challengeData,"," name: signupChallenge.userName,"," userID: signupChallenge.userId",")","","let authController = ASAuthorizationController(authorizationRequests: [request])","authController.delegate = self \/\/ ASAuthorizationControllerDelegate","authController.presentationContextProvider = self","authController.performRequests()"],"type":"codeListing"},{"inlineContent":[{"type":"text","text":"Then, call "},{"type":"codeVoice","code":"login(passkey:challenge:connection:audience:scope:)-4q8i0"},{"type":"text","text":" with the created"},{"type":"text","text":" "},{"type":"text","text":"passkey credential and the challenge to log the new user in."}],"type":"paragraph"}],"kind":"content"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/passkeysignupchallenge(email:phonenumber:username:name:connection:organization:)-8jlyt"]}],"seeAlsoSections":[{"title":"Related Documentation","anchor":"Related-Documentation","identifiers":["https:\/\/auth0.com\/docs\/native-passkeys-api#request-signup-challenge","https:\/\/auth0.com\/docs\/native-passkeys-for-mobile-applications","https:\/\/developer.apple.com\/documentation\/authenticationservices\/supporting-passkeys#Register-a-new-account-on-a-service"]}],"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/passkeySignupChallenge(email:phoneNumber:username:name:connection:organization:)-8jlyt"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"abstract":[{"text":"Requests a challenge for registering a new user with a passkey. This is the first part of the passkey signup flow.","type":"text"}],"metadata":{"roleHeading":"Instance Method","extendedModule":"Auth0","role":"symbol","title":"passkeySignupChallenge(email:phoneNumber:username:name:connection:organization:)","symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"passkeySignupChallenge","kind":"identifier"},{"text":"(","kind":"text"},{"text":"email","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"phoneNumber","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"username","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"name","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"organization","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?) -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"PasskeySignupChallenge","preciseIdentifier":"s:5Auth022PasskeySignupChallengeV","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"externalID":"s:5Auth014AuthenticationPAAE22passkeySignupChallenge5email11phoneNumber8username4name10connection12organizationAA7RequestVyAA07PasskeydE0VAA0B5ErrorVGSSSg_A5RtF","modules":[{"name":"Auth0"}],"platforms":[{"unavailable":false,"name":"iOS","beta":false,"introducedAt":"16.6","deprecated":false},{"unavailable":false,"name":"iPadOS","beta":false,"introducedAt":"16.6","deprecated":false},{"unavailable":false,"name":"Mac Catalyst","beta":false,"introducedAt":"16.6","deprecated":false},{"unavailable":false,"name":"macOS","beta":false,"introducedAt":"13.5","deprecated":false},{"unavailable":false,"name":"visionOS","beta":false,"introducedAt":"1.0","deprecated":false}]},"references":{"https://auth0.com/docs/api/authentication":{"title":"Auth0 Authentication API","titleInlineContent":[{"text":"Auth0 Authentication API","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"link"},"https://developer.apple.com/documentation/authenticationservices/asauthorizationcontrollerdelegate":{"title":"ASAuthorizationControllerDelegate","titleInlineContent":[{"code":"ASAuthorizationControllerDelegate","type":"codeVoice"}],"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","type":"link"},"https://auth0.com/docs/native-passkeys-api#request-signup-challenge":{"title":"Authentication API Endpoint","titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}],"url":"https:\/\/auth0.com\/docs\/native-passkeys-api#request-signup-challenge","identifier":"https:\/\/auth0.com\/docs\/native-passkeys-api#request-signup-challenge","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"title":"Request","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"abstract":[{"text":"Auth0 API request.","type":"text"}],"url":"\/documentation\/auth0\/request","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","abstract":[{"type":"text","text":"Client for the "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","isActive":true},{"type":"text","text":"."}],"type":"topic","title":"Authentication","url":"\/documentation\/auth0\/authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"https://developer.apple.com/documentation/authenticationservices/asauthorizationplatformpublickeycredentialprovider":{"title":"ASAuthorizationPlatformPublicKeyCredentialProvider","titleInlineContent":[{"code":"ASAuthorizationPlatformPublicKeyCredentialProvider","type":"codeVoice"}],"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialprovider","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialprovider","type":"link"},"https://auth0.com/docs/authenticate/database-connections/activate-and-configure-attributes-for-flexible-identifiers":{"title":"Flexible Identifiers","titleInlineContent":[{"text":"Flexible Identifiers","type":"text"}],"url":"https:\/\/auth0.com\/docs\/authenticate\/database-connections\/activate-and-configure-attributes-for-flexible-identifiers","identifier":"https:\/\/auth0.com\/docs\/authenticate\/database-connections\/activate-and-configure-attributes-for-flexible-identifiers","type":"link"},"https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access":{"title":"Early Access","titleInlineContent":[{"text":"Early Access","type":"text"}],"url":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","type":"link"},"https://developer.apple.com/documentation/authenticationservices/supporting-passkeys#Register-a-new-account-on-a-service":{"title":"Supporting passkeys","titleInlineContent":[{"text":"Supporting passkeys","type":"text"}],"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/supporting-passkeys#Register-a-new-account-on-a-service","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/supporting-passkeys#Register-a-new-account-on-a-service","type":"link"},"https://auth0.com/docs/native-passkeys-for-mobile-applications":{"title":"Native Passkeys for Mobile Applications","titleInlineContent":[{"text":"Native Passkeys for Mobile Applications","type":"text"}],"url":"https:\/\/auth0.com\/docs\/native-passkeys-for-mobile-applications","identifier":"https:\/\/auth0.com\/docs\/native-passkeys-for-mobile-applications","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeySignupChallenge":{"title":"PasskeySignupChallenge","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge","role":"symbol","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"PasskeySignupChallenge","kind":"identifier"}],"abstract":[{"text":"A passkey signup challenge.","type":"text"}],"url":"\/documentation\/auth0\/passkeysignupchallenge","navigatorTitle":[{"text":"PasskeySignupChallenge","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/passkeySignupChallenge(email:phoneNumber:username:name:connection:organization:)-8jlyt":{"kind":"symbol","title":"passkeySignupChallenge(email:phoneNumber:username:name:connection:organization:)","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"passkeySignupChallenge"},{"kind":"text","text":"("},{"kind":"externalParam","text":"email"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"phoneNumber"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"username"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"name"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"organization"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth022PasskeySignupChallengeV","text":"PasskeySignupChallenge"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/passkeySignupChallenge(email:phoneNumber:username:name:connection:organization:)-8jlyt","abstract":[{"type":"text","text":"Requests a challenge for registering a new user with a passkey. This is the first part of the passkey signup flow."}],"url":"\/documentation\/auth0\/authentication\/passkeysignupchallenge(email:phonenumber:username:name:connection:organization:)-8jlyt"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authentication/passkeysignupchallenge(email:phonenumber:username:name:connection:organization:).json b/docs/data/documentation/auth0/authentication/passkeysignupchallenge(email:phonenumber:username:name:connection:organization:).json index 580aeb5f1..36d31f1ce 100644 --- a/docs/data/documentation/auth0/authentication/passkeysignupchallenge(email:phonenumber:username:name:connection:organization:).json +++ b/docs/data/documentation/auth0/authentication/passkeysignupchallenge(email:phonenumber:username:name:connection:organization:).json @@ -1 +1 @@ -{"metadata":{"externalID":"s:5Auth014AuthenticationP22passkeySignupChallenge5email11phoneNumber8username4name10connection12organizationAA7RequestVyAA07PasskeydE0VAA0B5ErrorVGSSSg_A5RtF","symbolKind":"method","title":"passkeySignupChallenge(email:phoneNumber:username:name:connection:organization:)","platforms":[{"beta":false,"name":"iOS","unavailable":false,"introducedAt":"16.6","deprecated":false},{"beta":false,"name":"iPadOS","unavailable":false,"introducedAt":"16.6","deprecated":false},{"beta":false,"name":"Mac Catalyst","unavailable":false,"introducedAt":"16.6","deprecated":false},{"beta":false,"name":"macOS","unavailable":false,"introducedAt":"13.5","deprecated":false},{"beta":false,"name":"visionOS","unavailable":false,"introducedAt":"1.0","deprecated":false}],"modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"passkeySignupChallenge"},{"kind":"text","text":"("},{"kind":"externalParam","text":"email"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"phoneNumber"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"username"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"name"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"organization"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth022PasskeySignupChallengeV","text":"PasskeySignupChallenge"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"required":true,"roleHeading":"Instance Method","role":"symbol"},"variants":[{"paths":["\/documentation\/auth0\/authentication\/passkeysignupchallenge(email:phonenumber:username:name:connection:organization:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/passkeySignupChallenge(email:phoneNumber:username:name:connection:organization:)"},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"sections":[],"schemaVersion":{"major":0,"patch":0,"minor":3},"defaultImplementationsSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/passkeySignupChallenge(email:phoneNumber:username:name:connection:organization:)-8jlyt"],"anchor":"Authentication-Implementations","title":"Authentication Implementations"}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"passkeySignupChallenge"},{"kind":"text","text":"("},{"kind":"externalParam","text":"email"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"phoneNumber"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"username"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"name"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"organization"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?) -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","text":"Request"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:5Auth022PasskeySignupChallengeV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge","text":"PasskeySignupChallenge"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","text":"AuthenticationError"},{"kind":"text","text":">"}],"languages":["swift"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"text":"Email address of the user. Defaults to ","type":"text"},{"code":"nil","type":"codeVoice"},{"text":".","type":"text"}]}],"name":"email"},{"content":[{"type":"paragraph","inlineContent":[{"text":"Phone number of the user. Defaults to ","type":"text"},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}]}],"name":"phoneNumber"},{"content":[{"type":"paragraph","inlineContent":[{"text":"Username of the user. Defaults to ","type":"text"},{"code":"nil","type":"codeVoice"},{"text":".","type":"text"}]}],"name":"username"},{"content":[{"type":"paragraph","inlineContent":[{"text":"Display name of the user. Defaults to ","type":"text"},{"code":"nil","type":"codeVoice"},{"text":".","type":"text"}]}],"name":"name"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Name of the database connection where the user will be created. If a connection name is not specified, your tenant’s default directory will be used."}]}],"name":"connection"},{"content":[{"inlineContent":[{"text":"Identifier of an organization the user is a member of.","type":"text"}],"type":"paragraph"}],"name":"organization"}]},{"content":[{"type":"heading","text":"Return Value","level":2,"anchor":"return-value"},{"type":"paragraph","inlineContent":[{"text":"A request that will yield a passkey signup challenge.","type":"text"}]}],"kind":"content"},{"content":[{"type":"heading","text":"Discussion","level":2,"anchor":"discussion"},{"inlineContent":[{"type":"text","text":"You need to provide at least one user identifier when requesting the challenge, along with an optional user"},{"type":"text","text":" "},{"type":"text","text":"display name, and an optional database connection name. If a connection name is not specified, your tenant’s"},{"type":"text","text":" "},{"type":"text","text":"default directory will be used."}],"type":"paragraph"},{"inlineContent":[{"text":"By default, database connections require a valid ","type":"text"},{"code":"email","type":"codeVoice"},{"text":". If you have enabled ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/authenticate\/database-connections\/activate-and-configure-attributes-for-flexible-identifiers","isActive":true,"type":"reference"},{"text":" ","type":"text"},{"text":"for your database connection, you may use any combination of ","type":"text"},{"code":"email","type":"codeVoice"},{"text":", ","type":"text"},{"code":"phoneNumber","type":"codeVoice"},{"text":", or ","type":"text"},{"code":"username","type":"codeVoice"},{"text":". These user","type":"text"},{"text":" ","type":"text"},{"text":"identifiers can be required or optional and must match your Flexible Identifiers configuration.","type":"text"}],"type":"paragraph"},{"type":"heading","text":"Availability","level":2,"anchor":"Availability"},{"inlineContent":[{"type":"text","text":"This feature is currently available in"},{"type":"text","text":" "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access"},{"type":"text","text":"."},{"type":"text","text":" "},{"type":"text","text":"Please reach out to Auth0 support to get it enabled for your tenant."}],"type":"paragraph"},{"type":"heading","text":"Usage","level":2,"anchor":"Usage"},{"type":"codeListing","code":["Auth0"," .authentication()"," .passkeySignupChallenge(email: \"support@auth0.com\","," name: \"John Appleseed\","," connection: \"Username-Password-Authentication\","," organization: \"org_aaAA1aa11aAAAA1a\")"," .start { result in"," switch result {"," case .success(let signupChallenge):"," print(\"Obtained signup challenge: \\(signupChallenge)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"],"syntax":"swift"},{"inlineContent":[{"text":"Use the challenge with ","type":"text"},{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialprovider","isActive":true,"type":"reference"},{"text":" ","type":"text"},{"text":"from the ","type":"text"},{"code":"AuthenticationServices","type":"codeVoice"},{"text":" framework to generate a new passkey credential. It will be delivered through the ","type":"text"},{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","isActive":true,"type":"reference"},{"text":" ","type":"text"},{"text":"delegate. Check out ","type":"text"},{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/supporting-passkeys#Register-a-new-account-on-a-service","isActive":true,"type":"reference"},{"text":" ","type":"text"},{"text":"to learn more.","type":"text"}],"type":"paragraph"},{"type":"codeListing","code":["let credentialProvider = ASAuthorizationPlatformPublicKeyCredentialProvider("," relyingPartyIdentifier: signupChallenge.relyingPartyId",")","","let request = credentialProvider.createCredentialRegistrationRequest("," challenge: signupChallenge.challengeData,"," name: signupChallenge.userName,"," userID: signupChallenge.userId",")","","let authController = ASAuthorizationController(authorizationRequests: [request])","authController.delegate = self \/\/ ASAuthorizationControllerDelegate","authController.presentationContextProvider = self","authController.performRequests()"],"syntax":"swift"},{"inlineContent":[{"text":"Then, call ","type":"text"},{"type":"codeVoice","code":"login(passkey:challenge:connection:audience:scope:)-4q8i0"},{"text":" with the created","type":"text"},{"text":" ","type":"text"},{"text":"passkey credential and the challenge to log the new user in.","type":"text"}],"type":"paragraph"}],"kind":"content"}],"abstract":[{"type":"text","text":"Requests a challenge for registering a new user with a passkey. This is the first part of the passkey signup flow."}],"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/native-passkeys-api#request-signup-challenge","https:\/\/auth0.com\/docs\/native-passkeys-for-mobile-applications","https:\/\/developer.apple.com\/documentation\/authenticationservices\/supporting-passkeys#Register-a-new-account-on-a-service"],"anchor":"Related-Documentation","title":"Related Documentation"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/passkeySignupChallenge(email:phoneNumber:username:name:connection:organization:)-8jlyt":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/passkeySignupChallenge(email:phoneNumber:username:name:connection:organization:)-8jlyt","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"passkeySignupChallenge"},{"kind":"text","text":"("},{"kind":"externalParam","text":"email"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"phoneNumber"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"username"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"name"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"organization"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth022PasskeySignupChallengeV","text":"PasskeySignupChallenge"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/authentication\/passkeysignupchallenge(email:phonenumber:username:name:connection:organization:)-8jlyt","title":"passkeySignupChallenge(email:phoneNumber:username:name:connection:organization:)","abstract":[{"type":"text","text":"Requests a challenge for registering a new user with a passkey. This is the first part of the passkey signup flow."}]},"https://auth0.com/docs/native-passkeys-for-mobile-applications":{"identifier":"https:\/\/auth0.com\/docs\/native-passkeys-for-mobile-applications","title":"Native Passkeys for Mobile Applications","url":"https:\/\/auth0.com\/docs\/native-passkeys-for-mobile-applications","titleInlineContent":[{"type":"text","text":"Native Passkeys for Mobile Applications"}],"type":"link"},"https://developer.apple.com/documentation/authenticationservices/supporting-passkeys#Register-a-new-account-on-a-service":{"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/supporting-passkeys#Register-a-new-account-on-a-service","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/supporting-passkeys#Register-a-new-account-on-a-service","type":"link","titleInlineContent":[{"type":"text","text":"Supporting passkeys"}],"title":"Supporting passkeys"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/request","kind":"symbol","abstract":[{"type":"text","text":"Auth0 API request."}]},"https://auth0.com/docs/authenticate/database-connections/activate-and-configure-attributes-for-flexible-identifiers":{"identifier":"https:\/\/auth0.com\/docs\/authenticate\/database-connections\/activate-and-configure-attributes-for-flexible-identifiers","title":"Flexible Identifiers","url":"https:\/\/auth0.com\/docs\/authenticate\/database-connections\/activate-and-configure-attributes-for-flexible-identifiers","titleInlineContent":[{"type":"text","text":"Flexible Identifiers"}],"type":"link"},"https://developer.apple.com/documentation/authenticationservices/asauthorizationcontrollerdelegate":{"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","type":"link","titleInlineContent":[{"type":"codeVoice","code":"ASAuthorizationControllerDelegate"}],"title":"ASAuthorizationControllerDelegate"},"https://auth0.com/docs/api/authentication":{"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"}],"type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeySignupChallenge":{"type":"topic","abstract":[{"type":"text","text":"A passkey signup challenge."}],"kind":"symbol","title":"PasskeySignupChallenge","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge","role":"symbol","url":"\/documentation\/auth0\/passkeysignupchallenge","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasskeySignupChallenge"}],"navigatorTitle":[{"kind":"identifier","text":"PasskeySignupChallenge"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/passkeySignupChallenge(email:phoneNumber:username:name:connection:organization:)":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"passkeySignupChallenge","kind":"identifier"},{"text":"(","kind":"text"},{"text":"email","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"phoneNumber","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"username","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"name","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"organization","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?) -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"PasskeySignupChallenge","preciseIdentifier":"s:5Auth022PasskeySignupChallengeV","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/authentication\/passkeysignupchallenge(email:phonenumber:username:name:connection:organization:)","defaultImplementations":1,"title":"passkeySignupChallenge(email:phoneNumber:username:name:connection:organization:)","type":"topic","abstract":[{"type":"text","text":"Requests a challenge for registering a new user with a passkey. This is the first part of the passkey signup flow."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/passkeySignupChallenge(email:phoneNumber:username:name:connection:organization:)","required":true,"role":"symbol"},"https://auth0.com/docs/native-passkeys-api#request-signup-challenge":{"identifier":"https:\/\/auth0.com\/docs\/native-passkeys-api#request-signup-challenge","title":"Authentication API Endpoint","url":"https:\/\/auth0.com\/docs\/native-passkeys-api#request-signup-challenge","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"type":"link"},"https://developer.apple.com/documentation/authenticationservices/asauthorizationplatformpublickeycredentialprovider":{"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialprovider","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialprovider","type":"link","titleInlineContent":[{"type":"codeVoice","code":"ASAuthorizationPlatformPublicKeyCredentialProvider"}],"title":"ASAuthorizationPlatformPublicKeyCredentialProvider"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"type":"topic","role":"symbol","title":"Authentication","abstract":[{"text":"Client for the ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"text":".","type":"text"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access":{"identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","title":"Early Access","url":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","titleInlineContent":[{"type":"text","text":"Early Access"}],"type":"link"}}} \ No newline at end of file +{"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"passkeySignupChallenge"},{"kind":"text","text":"("},{"kind":"externalParam","text":"email"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"phoneNumber"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"username"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"name"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"organization"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?) -> "},{"preciseIdentifier":"s:5Auth07RequestV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier","text":"Request"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:5Auth022PasskeySignupChallengeV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge","kind":"typeIdentifier","text":"PasskeySignupChallenge"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","kind":"typeIdentifier","text":"AuthenticationError"},{"kind":"text","text":">"}]}]},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"type":"text","text":"Email address of the user. Defaults to "},{"code":"nil","type":"codeVoice"},{"type":"text","text":"."}],"type":"paragraph"}],"name":"email"},{"content":[{"inlineContent":[{"type":"text","text":"Phone number of the user. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"type":"paragraph"}],"name":"phoneNumber"},{"content":[{"inlineContent":[{"type":"text","text":"Username of the user. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"type":"paragraph"}],"name":"username"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Display name of the user. Defaults to "},{"code":"nil","type":"codeVoice"},{"type":"text","text":"."}]}],"name":"name"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Name of the database connection where the user will be created. If a connection name is not specified, your tenant’s default directory will be used."}]}],"name":"connection"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Identifier of an organization the user is a member of."}]}],"name":"organization"}]},{"kind":"content","content":[{"level":2,"type":"heading","anchor":"return-value","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A request that will yield a passkey signup challenge."}]}]},{"kind":"content","content":[{"level":2,"type":"heading","anchor":"discussion","text":"Discussion"},{"type":"paragraph","inlineContent":[{"type":"text","text":"You need to provide at least one user identifier when requesting the challenge, along with an optional user"},{"type":"text","text":" "},{"type":"text","text":"display name, and an optional database connection name. If a connection name is not specified, your tenant’s"},{"type":"text","text":" "},{"type":"text","text":"default directory will be used."}]},{"inlineContent":[{"type":"text","text":"By default, database connections require a valid "},{"type":"codeVoice","code":"email"},{"type":"text","text":". If you have enabled "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/authenticate\/database-connections\/activate-and-configure-attributes-for-flexible-identifiers","isActive":true},{"type":"text","text":" "},{"type":"text","text":"for your database connection, you may use any combination of "},{"code":"email","type":"codeVoice"},{"type":"text","text":", "},{"code":"phoneNumber","type":"codeVoice"},{"type":"text","text":", or "},{"code":"username","type":"codeVoice"},{"type":"text","text":". These user"},{"type":"text","text":" "},{"type":"text","text":"identifiers can be required or optional and must match your Flexible Identifiers configuration."}],"type":"paragraph"},{"type":"heading","level":2,"text":"Availability","anchor":"Availability"},{"type":"paragraph","inlineContent":[{"type":"text","text":"This feature is currently available in"},{"type":"text","text":" "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access"},{"type":"text","text":"."},{"type":"text","text":" "},{"type":"text","text":"Please reach out to Auth0 support to get it enabled for your tenant."}]},{"type":"heading","text":"Usage","anchor":"Usage","level":2},{"type":"codeListing","syntax":"swift","code":["Auth0"," .authentication()"," .passkeySignupChallenge(email: \"support@auth0.com\","," name: \"John Appleseed\","," connection: \"Username-Password-Authentication\","," organization: \"org_aaAA1aa11aAAAA1a\")"," .start { result in"," switch result {"," case .success(let signupChallenge):"," print(\"Obtained signup challenge: \\(signupChallenge)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"]},{"type":"paragraph","inlineContent":[{"type":"text","text":"Use the challenge with "},{"isActive":true,"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialprovider"},{"type":"text","text":" "},{"type":"text","text":"from the "},{"type":"codeVoice","code":"AuthenticationServices"},{"type":"text","text":" framework to generate a new passkey credential. It will be delivered through the "},{"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","isActive":true},{"type":"text","text":" "},{"type":"text","text":"delegate. Check out "},{"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/supporting-passkeys#Register-a-new-account-on-a-service","isActive":true},{"type":"text","text":" "},{"type":"text","text":"to learn more."}]},{"type":"codeListing","code":["let credentialProvider = ASAuthorizationPlatformPublicKeyCredentialProvider("," relyingPartyIdentifier: signupChallenge.relyingPartyId",")","","let request = credentialProvider.createCredentialRegistrationRequest("," challenge: signupChallenge.challengeData,"," name: signupChallenge.userName,"," userID: signupChallenge.userId",")","","let authController = ASAuthorizationController(authorizationRequests: [request])","authController.delegate = self \/\/ ASAuthorizationControllerDelegate","authController.presentationContextProvider = self","authController.performRequests()"],"syntax":"swift"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Then, call "},{"type":"codeVoice","code":"login(passkey:challenge:connection:audience:scope:)-4q8i0"},{"type":"text","text":" with the created"},{"type":"text","text":" "},{"type":"text","text":"passkey credential and the challenge to log the new user in."}]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/passkeysignupchallenge(email:phonenumber:username:name:connection:organization:)"]}],"seeAlsoSections":[{"title":"Related Documentation","anchor":"Related-Documentation","identifiers":["https:\/\/auth0.com\/docs\/native-passkeys-api#request-signup-challenge","https:\/\/auth0.com\/docs\/native-passkeys-for-mobile-applications","https:\/\/developer.apple.com\/documentation\/authenticationservices\/supporting-passkeys#Register-a-new-account-on-a-service"]}],"sections":[],"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\/passkeySignupChallenge(email:phoneNumber:username:name:connection:organization:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Requests a challenge for registering a new user with a passkey. This is the first part of the passkey signup flow."}],"defaultImplementationsSections":[{"title":"Authentication Implementations","anchor":"Authentication-Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/passkeySignupChallenge(email:phoneNumber:username:name:connection:organization:)-8jlyt"]}],"metadata":{"roleHeading":"Instance Method","symbolKind":"method","role":"symbol","title":"passkeySignupChallenge(email:phoneNumber:username:name:connection:organization:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"passkeySignupChallenge","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"email"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"phoneNumber"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"username"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"name"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"connection"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"organization"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth022PasskeySignupChallengeV","text":"PasskeySignupChallenge"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"required":true,"externalID":"s:5Auth014AuthenticationP22passkeySignupChallenge5email11phoneNumber8username4name10connection12organizationAA7RequestVyAA07PasskeydE0VAA0B5ErrorVGSSSg_A5RtF","modules":[{"name":"Auth0"}],"platforms":[{"beta":false,"name":"iOS","introducedAt":"16.6","unavailable":false,"deprecated":false},{"beta":false,"name":"iPadOS","unavailable":false,"introducedAt":"16.6","deprecated":false},{"beta":false,"name":"Mac Catalyst","unavailable":false,"introducedAt":"16.6","deprecated":false},{"beta":false,"name":"macOS","unavailable":false,"introducedAt":"13.5","deprecated":false},{"beta":false,"name":"visionOS","unavailable":false,"introducedAt":"1.0","deprecated":false}]},"references":{"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"},"https://developer.apple.com/documentation/authenticationservices/asauthorizationcontrollerdelegate":{"titleInlineContent":[{"type":"codeVoice","code":"ASAuthorizationControllerDelegate"}],"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","type":"link","title":"ASAuthorizationControllerDelegate","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate"},"https://auth0.com/docs/native-passkeys-api#request-signup-challenge":{"titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"url":"https:\/\/auth0.com\/docs\/native-passkeys-api#request-signup-challenge","type":"link","title":"Authentication API Endpoint","identifier":"https:\/\/auth0.com\/docs\/native-passkeys-api#request-signup-challenge"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"title":"Request","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"abstract":[{"text":"Auth0 API request.","type":"text"}],"url":"\/documentation\/auth0\/request","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","abstract":[{"type":"text","text":"Client for the "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","isActive":true},{"type":"text","text":"."}],"type":"topic","title":"Authentication","url":"\/documentation\/auth0\/authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/passkeySignupChallenge(email:phoneNumber:username:name:connection:organization:)":{"kind":"symbol","title":"passkeySignupChallenge(email:phoneNumber:username:name:connection:organization:)","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"passkeySignupChallenge"},{"kind":"text","text":"("},{"kind":"externalParam","text":"email"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"phoneNumber"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"username"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"name"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"organization"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth022PasskeySignupChallengeV","text":"PasskeySignupChallenge"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"type":"topic","defaultImplementations":1,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/passkeySignupChallenge(email:phoneNumber:username:name:connection:organization:)","required":true,"abstract":[{"type":"text","text":"Requests a challenge for registering a new user with a passkey. This is the first part of the passkey signup flow."}],"url":"\/documentation\/auth0\/authentication\/passkeysignupchallenge(email:phonenumber:username:name:connection:organization:)"},"https://auth0.com/docs/authenticate/database-connections/activate-and-configure-attributes-for-flexible-identifiers":{"titleInlineContent":[{"type":"text","text":"Flexible Identifiers"}],"url":"https:\/\/auth0.com\/docs\/authenticate\/database-connections\/activate-and-configure-attributes-for-flexible-identifiers","type":"link","title":"Flexible Identifiers","identifier":"https:\/\/auth0.com\/docs\/authenticate\/database-connections\/activate-and-configure-attributes-for-flexible-identifiers"},"https://developer.apple.com/documentation/authenticationservices/asauthorizationplatformpublickeycredentialprovider":{"titleInlineContent":[{"type":"codeVoice","code":"ASAuthorizationPlatformPublicKeyCredentialProvider"}],"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialprovider","type":"link","title":"ASAuthorizationPlatformPublicKeyCredentialProvider","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialprovider"},"https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access":{"titleInlineContent":[{"type":"text","text":"Early Access"}],"url":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","type":"link","title":"Early Access","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access"},"https://developer.apple.com/documentation/authenticationservices/supporting-passkeys#Register-a-new-account-on-a-service":{"titleInlineContent":[{"type":"text","text":"Supporting passkeys"}],"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/supporting-passkeys#Register-a-new-account-on-a-service","type":"link","title":"Supporting passkeys","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/supporting-passkeys#Register-a-new-account-on-a-service"},"https://auth0.com/docs/native-passkeys-for-mobile-applications":{"titleInlineContent":[{"type":"text","text":"Native Passkeys for Mobile Applications"}],"url":"https:\/\/auth0.com\/docs\/native-passkeys-for-mobile-applications","type":"link","title":"Native Passkeys for Mobile Applications","identifier":"https:\/\/auth0.com\/docs\/native-passkeys-for-mobile-applications"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeySignupChallenge":{"title":"PasskeySignupChallenge","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge","role":"symbol","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"PasskeySignupChallenge","kind":"identifier"}],"abstract":[{"text":"A passkey signup challenge.","type":"text"}],"url":"\/documentation\/auth0\/passkeysignupchallenge","navigatorTitle":[{"text":"PasskeySignupChallenge","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/passkeySignupChallenge(email:phoneNumber:username:name:connection:organization:)-8jlyt":{"kind":"symbol","title":"passkeySignupChallenge(email:phoneNumber:username:name:connection:organization:)","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"passkeySignupChallenge"},{"kind":"text","text":"("},{"kind":"externalParam","text":"email"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"phoneNumber"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"username"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"name"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"organization"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth022PasskeySignupChallengeV","text":"PasskeySignupChallenge"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/passkeySignupChallenge(email:phoneNumber:username:name:connection:organization:)-8jlyt","abstract":[{"type":"text","text":"Requests a challenge for registering a new user with a passkey. This is the first part of the passkey signup flow."}],"url":"\/documentation\/auth0\/authentication\/passkeysignupchallenge(email:phonenumber:username:name:connection:organization:)-8jlyt"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authentication/renew(withrefreshtoken:audience:scope:)-1orlu.json b/docs/data/documentation/auth0/authentication/renew(withrefreshtoken:audience:scope:)-1orlu.json index 4d7a5f01b..77f128409 100644 --- a/docs/data/documentation/auth0/authentication/renew(withrefreshtoken:audience:scope:)-1orlu.json +++ b/docs/data/documentation/auth0/authentication/renew(withrefreshtoken:audience:scope:)-1orlu.json @@ -1 +1 @@ -{"metadata":{"externalID":"s:5Auth014AuthenticationPAAE5renew16withRefreshToken8audience5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_SSSgAOtF","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"renew"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withRefreshToken"},{"kind":"text","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":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","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":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"extendedModule":"Auth0","symbolKind":"method","title":"renew(withRefreshToken:audience:scope:)","role":"symbol","modules":[{"name":"Auth0"}],"roleHeading":"Instance Method"},"abstract":[{"type":"text","text":"Renews the user’s credentials using a refresh token."}],"variants":[{"paths":["\/documentation\/auth0\/authentication\/renew(withrefreshtoken:audience:scope:)-1orlu"],"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"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/renew(withRefreshToken:audience:scope:)-1orlu"},"kind":"symbol","sections":[],"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/api\/authentication\/refresh-token\/refresh-token","https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens"],"anchor":"Related-Documentation","title":"Related Documentation"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"renew","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withRefreshToken","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"refreshToken","kind":"internalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"? = nil, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"? = nil) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}]}]},{"kind":"parameters","parameters":[{"name":"refreshToken","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The refresh token."}]}]},{"name":"audience","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Identifier of the API that your application is requesting access to. Currently, only the Auth0 My Account API is supported. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}]}]},{"name":"scope","content":[{"inlineContent":[{"type":"text","text":"Space-separated list of scope values to request. Defaults to "},{"code":"nil","type":"codeVoice"},{"type":"text","text":"."}],"type":"paragraph"}]}]},{"kind":"content","content":[{"type":"heading","level":2,"anchor":"return-value","text":"Return Value"},{"type":"paragraph","inlineContent":[{"text":"A request that will yield Auth0 user’s credentials.","type":"text"}]}]},{"kind":"content","content":[{"text":"Usage","level":2,"anchor":"Usage","type":"heading"},{"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)\")"," }"," }"],"syntax":"swift","type":"codeListing"},{"inlineContent":[{"type":"text","text":"You can request credentials for a specific API by passing its audience value. The default scopes configured for"},{"type":"text","text":" "},{"type":"text","text":"the API will be granted if you don’t request any specific scopes."}],"type":"paragraph"},{"name":"Important","content":[{"inlineContent":[{"type":"text","text":"Currently, only the Auth0 My Account API is supported. Support for other APIs will be added in the future."}],"type":"paragraph"}],"style":"important","type":"aside"},{"code":["Auth0"," .authentication()"," .renew(withRefreshToken: credentials.refreshToken,"," audience: \"https:\/\/samples.us.auth0.com\/me\","," scope: \"create:me:authentication_methods\")"," .start { print($0) }"],"syntax":"swift","type":"codeListing"}]}],"references":{"https://auth0.com/docs/api/authentication":{"titleInlineContent":[{"text":"Auth0 Authentication API","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication","type":"link","title":"Auth0 Authentication API","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"url":"\/documentation\/auth0\/credentials","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"role":"symbol","type":"topic","abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/RefreshTokens":{"url":"\/documentation\/auth0\/refreshtokens","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens","kind":"article","title":"Refresh Tokens: Common Errors","type":"topic","abstract":[],"role":"article"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/renew(withRefreshToken:audience:scope:)-1orlu":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/renew(withRefreshToken:audience:scope:)-1orlu","type":"topic","title":"renew(withRefreshToken:audience:scope:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"renew","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withRefreshToken","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?) -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"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"}],"abstract":[{"text":"Renews the user’s credentials using a refresh token.","type":"text"}],"url":"\/documentation\/auth0\/authentication\/renew(withrefreshtoken:audience:scope:)-1orlu","kind":"symbol"},"https://auth0.com/docs/api/authentication/refresh-token/refresh-token":{"type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/refresh-token\/refresh-token","title":"Authentication API Endpoint","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication\/refresh-token\/refresh-token"},"https://auth0.com/docs/secure/tokens/refresh-tokens":{"titleInlineContent":[{"text":"Refresh Tokens","type":"text"}],"url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","type":"link","title":"Refresh Tokens","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/request","kind":"symbol","abstract":[{"type":"text","text":"Auth0 API request."}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"type":"topic","role":"symbol","title":"Authentication","abstract":[{"text":"Client for the ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"text":".","type":"text"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/renew(withrefreshtoken:audience:scope:)-1orlu"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"abstract":[{"text":"Renews the user’s credentials using a refresh token.","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"renew","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withRefreshToken","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"refreshToken","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"? = nil, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"? = nil) -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"platforms":["iOS"]}]},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"type":"text","text":"The refresh token."}],"type":"paragraph"}],"name":"refreshToken"},{"content":[{"inlineContent":[{"type":"text","text":"Identifier of the API that your application is requesting access to. Currently, only the Auth0 My Account API is supported. Defaults to "},{"code":"nil","type":"codeVoice"},{"type":"text","text":"."}],"type":"paragraph"}],"name":"audience"},{"content":[{"inlineContent":[{"type":"text","text":"Space-separated list of scope values to request. Defaults to "},{"code":"nil","type":"codeVoice"},{"type":"text","text":"."}],"type":"paragraph"}],"name":"scope"}]},{"kind":"content","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","content":[{"level":2,"text":"Usage","type":"heading","anchor":"Usage"},{"syntax":"swift","type":"codeListing","code":["Auth0"," .authentication()"," .renew(withRefreshToken: credentials.refreshToken)"," .start { result in"," switch result {"," case .success(let credentials):"," print(\"Obtained new credentials: \\(credentials)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"]},{"inlineContent":[{"text":"You can request credentials for a specific API by passing its audience value. The default scopes configured for","type":"text"},{"text":" ","type":"text"},{"text":"the API will be granted if you don’t request any specific scopes.","type":"text"}],"type":"paragraph"},{"style":"important","content":[{"inlineContent":[{"type":"text","text":"Currently, only the Auth0 My Account API is supported. Support for other APIs will be added in the future."}],"type":"paragraph"}],"type":"aside","name":"Important"},{"syntax":"swift","type":"codeListing","code":["Auth0"," .authentication()"," .renew(withRefreshToken: credentials.refreshToken,"," audience: \"https:\/\/samples.us.auth0.com\/me\","," scope: \"create:me:authentication_methods\")"," .start { print($0) }"]}]}],"kind":"symbol","schemaVersion":{"minor":3,"major":0,"patch":0},"sections":[],"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/api\/authentication\/refresh-token\/refresh-token","https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens"],"title":"Related Documentation","anchor":"Related-Documentation"}],"metadata":{"externalID":"s:5Auth014AuthenticationPAAE5renew16withRefreshToken8audience5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_SSSgAOtF","extendedModule":"Auth0","symbolKind":"method","title":"renew(withRefreshToken:audience:scope:)","role":"symbol","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"renew"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withRefreshToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?) -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"modules":[{"name":"Auth0"}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/renew(withRefreshToken:audience:scope:)-1orlu"},"references":{"https://auth0.com/docs/api/authentication/refresh-token/refresh-token":{"titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication\/refresh-token\/refresh-token","type":"link","title":"Authentication API Endpoint","identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/refresh-token\/refresh-token"},"doc://com.auth0.Auth0/documentation/Auth0/RefreshTokens":{"title":"Refresh Tokens: Common Errors","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens","role":"article","kind":"article","abstract":[],"url":"\/documentation\/auth0\/refreshtokens"},"https://auth0.com/docs/secure/tokens/refresh-tokens":{"titleInlineContent":[{"text":"Refresh Tokens","type":"text"}],"url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","type":"link","title":"Refresh Tokens","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"title":"Request","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"abstract":[{"text":"Auth0 API request.","type":"text"}],"url":"\/documentation\/auth0\/request","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"Credentials","kind":"identifier"}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"https://auth0.com/docs/api/authentication":{"titleInlineContent":[{"text":"Auth0 Authentication API","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication","type":"link","title":"Auth0 Authentication API","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/renew(withRefreshToken:audience:scope:)-1orlu":{"type":"topic","title":"renew(withRefreshToken:audience:scope:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/renew(withRefreshToken:audience:scope:)-1orlu","kind":"symbol","abstract":[{"type":"text","text":"Renews the user’s credentials using a refresh token."}],"url":"\/documentation\/auth0\/authentication\/renew(withrefreshtoken:audience:scope:)-1orlu","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"renew"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withRefreshToken"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","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","kind":"typeIdentifier","text":"AuthenticationError"},{"kind":"text","text":">"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","abstract":[{"type":"text","text":"Client for the "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","isActive":true},{"type":"text","text":"."}],"type":"topic","title":"Authentication","url":"\/documentation\/auth0\/authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authentication/renew(withrefreshtoken:audience:scope:).json b/docs/data/documentation/auth0/authentication/renew(withrefreshtoken:audience:scope:).json index b2e153a69..5352a5609 100644 --- a/docs/data/documentation/auth0/authentication/renew(withrefreshtoken:audience:scope:).json +++ b/docs/data/documentation/auth0/authentication/renew(withrefreshtoken:audience:scope:).json @@ -1 +1 @@ -{"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"renew","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withRefreshToken","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"refreshToken","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?) -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","preciseIdentifier":"s:5Auth07RequestV"},{"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":", "},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}]}]},{"kind":"parameters","parameters":[{"name":"refreshToken","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The refresh token."}]}]},{"name":"audience","content":[{"inlineContent":[{"type":"text","text":"Identifier of the API that your application is requesting access to. Currently, only the Auth0 My Account API is supported. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"type":"paragraph"}]},{"name":"scope","content":[{"inlineContent":[{"type":"text","text":"Space-separated list of scope values to request. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"type":"paragraph"}]}]},{"kind":"content","content":[{"type":"heading","level":2,"anchor":"return-value","text":"Return Value"},{"type":"paragraph","inlineContent":[{"text":"A request that will yield Auth0 user’s credentials.","type":"text"}]}]},{"kind":"content","content":[{"text":"Usage","level":2,"type":"heading","anchor":"Usage"},{"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":[{"text":"You can request credentials for a specific API by passing its audience value. The default scopes configured for","type":"text"},{"text":" ","type":"text"},{"text":"the API will be granted if you don’t request any specific scopes.","type":"text"}]},{"type":"aside","content":[{"inlineContent":[{"text":"Currently, only the Auth0 My Account API is supported. Support for other APIs will be added in the future.","type":"text"}],"type":"paragraph"}],"name":"Important","style":"important"},{"code":["Auth0"," .authentication()"," .renew(withRefreshToken: credentials.refreshToken,"," audience: \"https:\/\/samples.us.auth0.com\/me\","," scope: \"create:me:authentication_methods\")"," .start { print($0) }"],"type":"codeListing","syntax":"swift"}]}],"defaultImplementationsSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/renew(withRefreshToken:audience:scope:)-1orlu"],"anchor":"Authentication-Implementations","title":"Authentication Implementations"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/renew(withRefreshToken:audience:scope:)"},"kind":"symbol","seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/api\/authentication\/refresh-token\/refresh-token","https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens"],"anchor":"Related-Documentation","title":"Related Documentation"}],"metadata":{"role":"symbol","required":true,"modules":[{"name":"Auth0"}],"title":"renew(withRefreshToken:audience:scope:)","externalID":"s:5Auth014AuthenticationP5renew16withRefreshToken8audience5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_SSSgAOtF","roleHeading":"Instance Method","symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"renew","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withRefreshToken","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?) -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"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"}]},"schemaVersion":{"patch":0,"major":0,"minor":3},"abstract":[{"text":"Renews the user’s credentials using a refresh token.","type":"text"}],"variants":[{"paths":["\/documentation\/auth0\/authentication\/renew(withrefreshtoken:audience:scope:)"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"https://auth0.com/docs/api/authentication":{"type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","title":"Auth0 Authentication API","titleInlineContent":[{"text":"Auth0 Authentication API","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/renew(withRefreshToken:audience:scope:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/renew(withRefreshToken:audience:scope:)","title":"renew(withRefreshToken:audience:scope:)","type":"topic","required":true,"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"renew"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withRefreshToken"},{"kind":"text","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":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","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":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"defaultImplementations":1,"abstract":[{"text":"Renews the user’s credentials using a refresh token.","type":"text"}],"url":"\/documentation\/auth0\/authentication\/renew(withrefreshtoken:audience:scope:)","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/renew(withRefreshToken:audience:scope:)-1orlu":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/renew(withRefreshToken:audience:scope:)-1orlu","type":"topic","title":"renew(withRefreshToken:audience:scope:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"renew","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withRefreshToken","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?) -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"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"}],"abstract":[{"text":"Renews the user’s credentials using a refresh token.","type":"text"}],"url":"\/documentation\/auth0\/authentication\/renew(withrefreshtoken:audience:scope:)-1orlu","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/RefreshTokens":{"url":"\/documentation\/auth0\/refreshtokens","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens","kind":"article","title":"Refresh Tokens: Common Errors","type":"topic","abstract":[],"role":"article"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/request","kind":"symbol","abstract":[{"type":"text","text":"Auth0 API request."}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"url":"\/documentation\/auth0\/credentials","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"role":"symbol","type":"topic","abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}]},"https://auth0.com/docs/api/authentication/refresh-token/refresh-token":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/refresh-token\/refresh-token","url":"https:\/\/auth0.com\/docs\/api\/authentication\/refresh-token\/refresh-token","title":"Authentication API Endpoint","titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}],"type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"type":"topic","role":"symbol","title":"Authentication","abstract":[{"text":"Client for the ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"text":".","type":"text"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"https://auth0.com/docs/secure/tokens/refresh-tokens":{"type":"link","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","title":"Refresh Tokens","titleInlineContent":[{"text":"Refresh Tokens","type":"text"}],"url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens"}}} \ No newline at end of file +{"metadata":{"symbolKind":"method","roleHeading":"Instance Method","externalID":"s:5Auth014AuthenticationP5renew16withRefreshToken8audience5scopeAA7RequestVyAA11CredentialsCAA0B5ErrorVGSS_SSSgAOtF","title":"renew(withRefreshToken:audience:scope:)","modules":[{"name":"Auth0"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"renew","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withRefreshToken","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"role":"symbol","required":true},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/renew(withrefreshtoken:audience:scope:)"]}],"defaultImplementationsSections":[{"title":"Authentication Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/renew(withRefreshToken:audience:scope:)-1orlu"],"anchor":"Authentication-Implementations"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/renew(withRefreshToken:audience:scope:)"},"kind":"symbol","abstract":[{"type":"text","text":"Renews the user’s credentials using a refresh token."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication\/refresh-token\/refresh-token","https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens"],"anchor":"Related-Documentation"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"renew","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withRefreshToken","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"refreshToken","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"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"},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"},{"text":", ","kind":"text"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"},{"text":">","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]},{"parameters":[{"name":"refreshToken","content":[{"inlineContent":[{"text":"The refresh token.","type":"text"}],"type":"paragraph"}]},{"name":"audience","content":[{"inlineContent":[{"text":"Identifier of the API that your application is requesting access to. Currently, only the Auth0 My Account API is supported. Defaults to ","type":"text"},{"code":"nil","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"}]},{"name":"scope","content":[{"inlineContent":[{"text":"Space-separated list of scope values to request. Defaults to ","type":"text"},{"code":"nil","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"}]}],"kind":"parameters"},{"kind":"content","content":[{"type":"heading","text":"Return Value","anchor":"return-value","level":2},{"type":"paragraph","inlineContent":[{"text":"A request that will yield Auth0 user’s credentials.","type":"text"}]}]},{"kind":"content","content":[{"type":"heading","text":"Usage","anchor":"Usage","level":2},{"type":"codeListing","code":["Auth0"," .authentication()"," .renew(withRefreshToken: credentials.refreshToken)"," .start { result in"," switch result {"," case .success(let credentials):"," print(\"Obtained new credentials: \\(credentials)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"],"syntax":"swift"},{"type":"paragraph","inlineContent":[{"text":"You can request credentials for a specific API by passing its audience value. The default scopes configured for","type":"text"},{"text":" ","type":"text"},{"text":"the API will be granted if you don’t request any specific scopes.","type":"text"}]},{"type":"aside","name":"Important","style":"important","content":[{"inlineContent":[{"text":"Currently, only the Auth0 My Account API is supported. Support for other APIs will be added in the future.","type":"text"}],"type":"paragraph"}]},{"type":"codeListing","code":["Auth0"," .authentication()"," .renew(withRefreshToken: credentials.refreshToken,"," audience: \"https:\/\/samples.us.auth0.com\/me\","," scope: \"create:me:authentication_methods\")"," .start { print($0) }"],"syntax":"swift"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Authentication/renew(withRefreshToken:audience:scope:)":{"kind":"symbol","required":true,"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"renew"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withRefreshToken"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","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","kind":"typeIdentifier","text":"AuthenticationError"},{"kind":"text","text":">"}],"title":"renew(withRefreshToken:audience:scope:)","type":"topic","defaultImplementations":1,"role":"symbol","abstract":[{"text":"Renews the user’s credentials using a refresh token.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/renew(withRefreshToken:audience:scope:)","url":"\/documentation\/auth0\/authentication\/renew(withrefreshtoken:audience:scope:)"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/RefreshTokens":{"title":"Refresh Tokens: Common Errors","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens","role":"article","kind":"article","abstract":[],"url":"\/documentation\/auth0\/refreshtokens"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/renew(withRefreshToken:audience:scope:)-1orlu":{"type":"topic","title":"renew(withRefreshToken:audience:scope:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/renew(withRefreshToken:audience:scope:)-1orlu","kind":"symbol","abstract":[{"type":"text","text":"Renews the user’s credentials using a refresh token."}],"url":"\/documentation\/auth0\/authentication\/renew(withrefreshtoken:audience:scope:)-1orlu","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"renew"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withRefreshToken"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","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","kind":"typeIdentifier","text":"AuthenticationError"},{"kind":"text","text":">"}]},"https://auth0.com/docs/api/authentication/refresh-token/refresh-token":{"title":"Authentication API Endpoint","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/refresh-token\/refresh-token","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication\/refresh-token\/refresh-token"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","abstract":[{"type":"text","text":"Client for the "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","isActive":true},{"type":"text","text":"."}],"type":"topic","title":"Authentication","url":"\/documentation\/auth0\/authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"Credentials","kind":"identifier"}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}]},"https://auth0.com/docs/secure/tokens/refresh-tokens":{"title":"Refresh Tokens","type":"link","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","titleInlineContent":[{"type":"text","text":"Refresh Tokens"}],"url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"title":"Request","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"abstract":[{"text":"Auth0 API request.","type":"text"}],"url":"\/documentation\/auth0\/request","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"https://auth0.com/docs/api/authentication":{"title":"Auth0 Authentication API","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","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/authentication/resetpassword(email:connection:).json b/docs/data/documentation/auth0/authentication/resetpassword(email:connection:).json index 23aaad3cb..65bf90f5e 100644 --- a/docs/data/documentation/auth0/authentication/resetpassword(email:connection:).json +++ b/docs/data/documentation/auth0/authentication/resetpassword(email:connection:).json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"resetPassword","kind":"identifier"},{"text":"(","kind":"text"},{"text":"email","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"},{"text":"<","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":", ","kind":"text"},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"},{"text":">","kind":"text"}],"languages":["swift"]}]},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"text":"Email of the database user.","type":"text"}]}],"name":"email"},{"content":[{"inlineContent":[{"type":"text","text":"Name of the database connection."}],"type":"paragraph"}],"name":"connection"}]},{"content":[{"type":"heading","anchor":"return-value","level":2,"text":"Return Value"},{"type":"paragraph","inlineContent":[{"text":"A request for resetting the password.","type":"text"}]}],"kind":"content"},{"content":[{"type":"heading","level":2,"text":"Usage","anchor":"Usage"},{"type":"codeListing","code":["Auth0"," .authentication()"," .resetPassword(email: \"support@auth0.com\","," connection: \"Username-Password-Authentication\")"," .start { print($0) }"],"syntax":"swift"}],"kind":"content"}],"kind":"symbol","abstract":[{"text":"Resets the password of a database user.","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"metadata":{"title":"resetPassword(email:connection:)","required":true,"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"resetPassword","kind":"identifier"},{"text":"(","kind":"text"},{"text":"email","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"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"},{"text":">","kind":"text"}],"roleHeading":"Instance Method","role":"symbol","modules":[{"name":"Auth0"}],"externalID":"s:5Auth014AuthenticationP13resetPassword5email10connectionAA7RequestVyytAA0B5ErrorVGSS_SStF","symbolKind":"method"},"variants":[{"paths":["\/documentation\/auth0\/authentication\/resetpassword(email:connection:)"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/api\/authentication\/change-password\/change-password"],"anchor":"Related-Documentation","title":"Related Documentation"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/resetPassword(email:connection:)","interfaceLanguage":"swift"},"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Authentication/resetPassword(email:connection:)":{"abstract":[{"type":"text","text":"Resets the password of a database user."}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"resetPassword","kind":"identifier"},{"text":"(","kind":"text"},{"text":"email","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"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"},{"text":">","kind":"text"}],"url":"\/documentation\/auth0\/authentication\/resetpassword(email:connection:)","title":"resetPassword(email:connection:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/resetPassword(email:connection:)","type":"topic","required":true,"role":"symbol","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/request","kind":"symbol","abstract":[{"type":"text","text":"Auth0 API request."}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"https://auth0.com/docs/api/authentication/change-password/change-password":{"type":"link","title":"Authentication API Endpoint","identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/change-password\/change-password","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication\/change-password\/change-password"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"https://auth0.com/docs/api/authentication":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","url":"https:\/\/auth0.com\/docs\/api\/authentication","type":"link","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"title":"Auth0 Authentication API"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"type":"topic","role":"symbol","title":"Authentication","abstract":[{"text":"Client for the ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"text":".","type":"text"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]}}} \ No newline at end of file +{"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"resetPassword","kind":"identifier"},{"text":"(","kind":"text"},{"text":"email","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"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"},{"text":"Void","preciseIdentifier":"s:s4Voida","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"},{"text":">","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]},{"parameters":[{"name":"email","content":[{"inlineContent":[{"text":"Email of the database user.","type":"text"}],"type":"paragraph"}]},{"name":"connection","content":[{"inlineContent":[{"text":"Name of the database connection.","type":"text"}],"type":"paragraph"}]}],"kind":"parameters"},{"kind":"content","content":[{"type":"heading","text":"Return Value","anchor":"return-value","level":2},{"type":"paragraph","inlineContent":[{"text":"A request for resetting the password.","type":"text"}]}]},{"kind":"content","content":[{"type":"heading","text":"Usage","anchor":"Usage","level":2},{"type":"codeListing","code":["Auth0"," .authentication()"," .resetPassword(email: \"support@auth0.com\","," connection: \"Username-Password-Authentication\")"," .start { print($0) }"],"syntax":"swift"}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/resetpassword(email:connection:)"]}],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication\/change-password\/change-password"],"anchor":"Related-Documentation"}],"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/resetPassword(email:connection:)"},"abstract":[{"type":"text","text":"Resets the password of a database user."}],"metadata":{"roleHeading":"Instance Method","symbolKind":"method","role":"symbol","title":"resetPassword(email:connection:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"resetPassword","kind":"identifier"},{"text":"(","kind":"text"},{"text":"email","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"required":true,"externalID":"s:5Auth014AuthenticationP13resetPassword5email10connectionAA7RequestVyytAA0B5ErrorVGSS_SStF","modules":[{"name":"Auth0"}]},"references":{"https://auth0.com/docs/api/authentication":{"title":"Auth0 Authentication API","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/resetPassword(email:connection:)":{"kind":"symbol","title":"resetPassword(email:connection:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"resetPassword","kind":"identifier"},{"text":"(","kind":"text"},{"text":"email","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"Void","preciseIdentifier":"s:s4Voida","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/resetPassword(email:connection:)","required":true,"abstract":[{"type":"text","text":"Resets the password of a database user."}],"url":"\/documentation\/auth0\/authentication\/resetpassword(email:connection:)"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"title":"Request","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"abstract":[{"text":"Auth0 API request.","type":"text"}],"url":"\/documentation\/auth0\/request","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"https://auth0.com/docs/api/authentication/change-password/change-password":{"title":"Authentication API Endpoint","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/change-password\/change-password","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication\/change-password\/change-password"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","abstract":[{"type":"text","text":"Client for the "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","isActive":true},{"type":"text","text":"."}],"type":"topic","title":"Authentication","url":"\/documentation\/auth0\/authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]}}} \ 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 eb3780713..408f7895e 100644 --- a/docs/data/documentation/auth0/authentication/revoke(refreshtoken:).json +++ b/docs/data/documentation/auth0/authentication/revoke(refreshtoken:).json @@ -1 +1 @@ -{"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"metadata":{"title":"revoke(refreshToken:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"revoke"},{"kind":"text","text":"("},{"kind":"externalParam","text":"refreshToken"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:s4Voida","kind":"typeIdentifier","text":"Void"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","text":"AuthenticationError"},{"kind":"text","text":">"}],"roleHeading":"Instance Method","required":true,"externalID":"s:5Auth014AuthenticationP6revoke12refreshTokenAA7RequestVyytAA0B5ErrorVGSS_tF","symbolKind":"method","modules":[{"name":"Auth0"}]},"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"}],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication\/revoke-refresh-token\/revoke-refresh-token","https:\/\/auth0.com\/docs\/api\/authentication#post-oauth-revoke"],"anchor":"Related-Documentation"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/revoke(refreshtoken:)"]}],"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"revoke","kind":"identifier"},{"text":"(","kind":"text"},{"text":"refreshToken","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"Void","preciseIdentifier":"s:s4Voida","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}]}],"kind":"declarations"},{"parameters":[{"name":"refreshToken","content":[{"inlineContent":[{"type":"text","text":"The refresh token to revoke."}],"type":"paragraph"}]}],"kind":"parameters"},{"content":[{"level":2,"text":"Return Value","anchor":"return-value","type":"heading"},{"inlineContent":[{"type":"text","text":"A request for revoking the refresh token."}],"type":"paragraph"}],"kind":"content"},{"content":[{"type":"heading","level":2,"anchor":"Usage","text":"Usage"},{"type":"codeListing","code":["Auth0"," .authentication()"," .revoke(refreshToken: credentials.refreshToken)"," .start { print($0) }"],"syntax":"swift"}],"kind":"content"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/revoke(refreshToken:)","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"type":"topic","role":"symbol","title":"Authentication","abstract":[{"text":"Client for the ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"text":".","type":"text"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/request","kind":"symbol","abstract":[{"type":"text","text":"Auth0 API request."}]},"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/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"https://auth0.com/docs/api/authentication/revoke-refresh-token/revoke-refresh-token":{"titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}],"identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/revoke-refresh-token\/revoke-refresh-token","type":"link","url":"https:\/\/auth0.com\/docs\/api\/authentication\/revoke-refresh-token\/revoke-refresh-token","title":"Authentication API Endpoint"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"https://auth0.com/docs/api/authentication#post-oauth-revoke":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication#post-oauth-revoke","title":"Error Responses","titleInlineContent":[{"type":"text","text":"Error Responses"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication#post-oauth-revoke","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/revoke(refreshToken:)":{"url":"\/documentation\/auth0\/authentication\/revoke(refreshtoken:)","abstract":[{"text":"Revokes a user’s refresh token by performing a request to the ","type":"text"},{"type":"codeVoice","code":"\/oauth\/revoke"},{"text":" endpoint.","type":"text"}],"type":"topic","required":true,"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/revoke(refreshToken:)","title":"revoke(refreshToken:)","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"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"},{"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"},{"text":">","kind":"text"}]}}} \ No newline at end of file +{"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/revoke(refreshToken:)"},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"revoke","kind":"identifier"},{"text":"(","kind":"text"},{"text":"refreshToken","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"},{"text":">","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]},{"parameters":[{"content":[{"type":"paragraph","inlineContent":[{"text":"The refresh token to revoke.","type":"text"}]}],"name":"refreshToken"}],"kind":"parameters"},{"kind":"content","content":[{"type":"heading","text":"Return Value","anchor":"return-value","level":2},{"type":"paragraph","inlineContent":[{"type":"text","text":"A request for revoking the refresh token."}]}]},{"kind":"content","content":[{"type":"heading","text":"Usage","anchor":"Usage","level":2},{"type":"codeListing","syntax":"swift","code":["Auth0"," .authentication()"," .revoke(refreshToken: credentials.refreshToken)"," .start { print($0) }"]}]}],"variants":[{"paths":["\/documentation\/auth0\/authentication\/revoke(refreshtoken:)"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","metadata":{"modules":[{"name":"Auth0"}],"title":"revoke(refreshToken:)","externalID":"s:5Auth014AuthenticationP6revoke12refreshTokenAA7RequestVyytAA0B5ErrorVGSS_tF","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"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"},{"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"},{"text":">","kind":"text"}],"roleHeading":"Instance Method","symbolKind":"method","required":true},"schemaVersion":{"patch":0,"minor":3,"major":0},"abstract":[{"type":"text","text":"Revokes a user’s refresh token by performing a request to the "},{"type":"codeVoice","code":"\/oauth\/revoke"},{"type":"text","text":" endpoint."}],"seeAlsoSections":[{"title":"Related Documentation","anchor":"Related-Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication\/revoke-refresh-token\/revoke-refresh-token","https:\/\/auth0.com\/docs\/api\/authentication#post-oauth-revoke"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Request":{"title":"Request","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"abstract":[{"text":"Auth0 API request.","type":"text"}],"url":"\/documentation\/auth0\/request","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"https://auth0.com/docs/api/authentication#post-oauth-revoke":{"type":"link","titleInlineContent":[{"type":"text","text":"Error Responses"}],"identifier":"https:\/\/auth0.com\/docs\/api\/authentication#post-oauth-revoke","title":"Error Responses","url":"https:\/\/auth0.com\/docs\/api\/authentication#post-oauth-revoke"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/revoke(refreshToken:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/revoke(refreshToken:)","type":"topic","title":"revoke(refreshToken:)","role":"symbol","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"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"},{"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"},{"text":">","kind":"text"}],"abstract":[{"type":"text","text":"Revokes a user’s refresh token by performing a request to the "},{"type":"codeVoice","code":"\/oauth\/revoke"},{"type":"text","text":" endpoint."}],"url":"\/documentation\/auth0\/authentication\/revoke(refreshtoken:)","required":true},"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"},"https://auth0.com/docs/api/authentication/revoke-refresh-token/revoke-refresh-token":{"title":"Authentication API Endpoint","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/revoke-refresh-token\/revoke-refresh-token","titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication\/revoke-refresh-token\/revoke-refresh-token"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","abstract":[{"type":"text","text":"Client for the "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","isActive":true},{"type":"text","text":"."}],"type":"topic","title":"Authentication","url":"\/documentation\/auth0\/authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"}}} \ 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 966c9cf32..c8b11aa52 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 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"signup"},{"kind":"text","text":"("},{"kind":"externalParam","text":"email"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"username"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"? = nil, "},{"kind":"externalParam","text":"password"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"userMetadata"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]? = nil, "},{"kind":"externalParam","text":"rootAttributes"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]? = nil) -> "},{"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\/DatabaseUser","kind":"typeIdentifier","text":"DatabaseUser","preciseIdentifier":"s:5Auth012DatabaseUsera"},{"kind":"text","text":", "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"languages":["swift"]}]},{"parameters":[{"name":"email","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Email for the new user."}]}]},{"name":"username","content":[{"inlineContent":[{"type":"text","text":"Username for the new user (if the connection requires a username). Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"type":"paragraph"}]},{"name":"password","content":[{"inlineContent":[{"text":"Password for the new user.","type":"text"}],"type":"paragraph"}]},{"name":"connection","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Name of the database connection where the user will be created."}]}]},{"name":"userMetadata","content":[{"inlineContent":[{"text":"Additional user metadata parameters that will be added to the newly created user.","type":"text"}],"type":"paragraph"}]},{"name":"rootAttributes","content":[{"inlineContent":[{"text":"Root attributes that will be added to the newly created user. These will not overwrite existing parameters. See https:\/\/auth0.com\/docs\/api\/authentication#signup for the full list of supported attributes.","type":"text"}],"type":"paragraph"}]}],"kind":"parameters"},{"content":[{"anchor":"return-value","type":"heading","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"},{"content":[{"level":2,"text":"Usage","anchor":"Usage","type":"heading"},{"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":"codeListing"},{"inlineContent":[{"type":"text","text":"You can also add additional metadata when creating the user:"}],"type":"paragraph"},{"syntax":"swift","code":["Auth0"," .authentication()"," .signup(email: \"support@auth0.com\","," password: \"secret-password\","," connection: \"Username-Password-Authentication\","," userMetadata: [\"first_name\": \"John\", \"last_name\": \"Appleseed\"])"," .start { print($0) }"],"type":"codeListing"},{"inlineContent":[{"type":"text","text":"If the database connection requires a username:"}],"type":"paragraph"},{"syntax":"swift","code":["Auth0"," .authentication()"," .signup(email: \"support@auth0.com\","," username: \"support\","," password: \"secret-password\","," connection: \"Username-Password-Authentication\")"," .start { print($0) }"],"type":"codeListing"}],"kind":"content"}],"sections":[],"metadata":{"symbolKind":"method","roleHeading":"Instance Method","externalID":"s:5Auth014AuthenticationPAAE6signup5email8username8password10connection12userMetadata14rootAttributesAA7RequestVySSAE_SSSgAFSb8verifiedtAA0B5ErrorVGSS_AMS2SSDySSypGSgAStF","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"signup"},{"kind":"text","text":"("},{"kind":"externalParam","text":"email"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"username"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"?, ","kind":"text"},{"text":"password","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","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"},{"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","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"DatabaseUser","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012DatabaseUsera"},{"text":", ","kind":"text"},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"modules":[{"name":"Auth0"}],"role":"symbol","title":"signup(email:username:password:connection:userMetadata:rootAttributes:)","extendedModule":"Auth0"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/signup(email:username:password:connection:userMetadata:rootAttributes:)-92l3l","interfaceLanguage":"swift"},"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/api\/authentication\/signup\/create-a-new-user"],"anchor":"Related-Documentation","title":"Related Documentation"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/signup(email:username:password:connection:usermetadata:rootattributes:)-92l3l"]}],"schemaVersion":{"patch":0,"minor":3,"major":0},"kind":"symbol","abstract":[{"type":"text","text":"Creates a user in a database connection."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/DatabaseUser":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DatabaseUser","fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"text":"DatabaseUser","kind":"identifier"}],"url":"\/documentation\/auth0\/databaseuser","kind":"symbol","title":"DatabaseUser","abstract":[{"type":"text","text":"A newly created database user (just the email, username, and email verified flag)."}],"role":"symbol","navigatorTitle":[{"text":"DatabaseUser","kind":"identifier"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"https://auth0.com/docs/api/authentication":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","url":"https:\/\/auth0.com\/docs\/api\/authentication","type":"link","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"title":"Auth0 Authentication API"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"type":"topic","role":"symbol","title":"Authentication","abstract":[{"text":"Client for the ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"text":".","type":"text"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/signup(email:username:password:connection:userMetadata:rootAttributes:)-92l3l":{"type":"topic","kind":"symbol","url":"\/documentation\/auth0\/authentication\/signup(email:username:password:connection:usermetadata:rootattributes:)-92l3l","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"signup","kind":"identifier"},{"text":"(","kind":"text"},{"text":"email","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"username","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"password","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"userMetadata","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"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","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"DatabaseUser","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012DatabaseUsera"},{"text":", ","kind":"text"},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"abstract":[{"type":"text","text":"Creates a user in a database connection."}],"title":"signup(email:username:password:connection:userMetadata:rootAttributes:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/signup(email:username:password:connection:userMetadata:rootAttributes:)-92l3l","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/request","kind":"symbol","abstract":[{"type":"text","text":"Auth0 API request."}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"https://auth0.com/docs/api/authentication/signup/create-a-new-user":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/signup\/create-a-new-user","url":"https:\/\/auth0.com\/docs\/api\/authentication\/signup\/create-a-new-user","type":"link","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"title":"Authentication API Endpoint"}}} \ No newline at end of file +{"metadata":{"symbolKind":"method","title":"signup(email:username:password:connection:userMetadata:rootAttributes:)","externalID":"s:5Auth014AuthenticationPAAE6signup5email8username8password10connection12userMetadata14rootAttributesAA7RequestVySSAE_SSSgAFSb8verifiedtAA0B5ErrorVGSS_AMS2SSDySSypGSgAStF","extendedModule":"Auth0","roleHeading":"Instance Method","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"signup"},{"kind":"text","text":"("},{"kind":"externalParam","text":"email"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"username"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"password"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"userMetadata"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]?, "},{"kind":"externalParam","text":"rootAttributes"},{"kind":"text","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"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:5Auth012DatabaseUsera","kind":"typeIdentifier","text":"DatabaseUser"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","text":"AuthenticationError"},{"kind":"text","text":">"}],"role":"symbol"},"sections":[],"variants":[{"paths":["\/documentation\/auth0\/authentication\/signup(email:username:password:connection:usermetadata:rootattributes:)-92l3l"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/signup(email:username:password:connection:userMetadata:rootAttributes:)-92l3l","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"type":"text","text":"Creates a user in a database connection."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"seeAlsoSections":[{"title":"Related Documentation","anchor":"Related-Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication\/signup\/create-a-new-user"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"signup","kind":"identifier"},{"text":"(","kind":"text"},{"text":"email","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"username","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"? = nil, ","kind":"text"},{"text":"password","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"userMetadata","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"]? = nil, ","kind":"text"},{"text":"rootAttributes","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"]? = nil) -> ","kind":"text"},{"text":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"DatabaseUser","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DatabaseUser","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012DatabaseUsera"},{"text":", ","kind":"text"},{"text":"AuthenticationError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}]},{"parameters":[{"name":"email","content":[{"inlineContent":[{"type":"text","text":"Email for the new user."}],"type":"paragraph"}]},{"name":"username","content":[{"inlineContent":[{"type":"text","text":"Username for the new user (if the connection requires a username). Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"type":"paragraph"}]},{"name":"password","content":[{"inlineContent":[{"type":"text","text":"Password for the new user."}],"type":"paragraph"}]},{"name":"connection","content":[{"inlineContent":[{"type":"text","text":"Name of the database connection where the user will be created."}],"type":"paragraph"}]},{"name":"userMetadata","content":[{"inlineContent":[{"type":"text","text":"Additional user metadata parameters that will be added to the newly created user."}],"type":"paragraph"}]},{"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"}]}],"kind":"parameters"},{"kind":"content","content":[{"type":"heading","level":2,"text":"Return Value","anchor":"return-value"},{"inlineContent":[{"text":"A request that will yield a newly created database user (just the email, username, and email verified flag).","type":"text"}],"type":"paragraph"}]},{"kind":"content","content":[{"type":"heading","level":2,"text":"Usage","anchor":"Usage"},{"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":"codeListing"},{"inlineContent":[{"type":"text","text":"You can also add additional metadata when creating the user:"}],"type":"paragraph"},{"syntax":"swift","code":["Auth0"," .authentication()"," .signup(email: \"support@auth0.com\","," password: \"secret-password\","," connection: \"Username-Password-Authentication\","," userMetadata: [\"first_name\": \"John\", \"last_name\": \"Appleseed\"])"," .start { print($0) }"],"type":"codeListing"},{"inlineContent":[{"type":"text","text":"If the database connection requires a username:"}],"type":"paragraph"},{"syntax":"swift","code":["Auth0"," .authentication()"," .signup(email: \"support@auth0.com\","," username: \"support\","," password: \"secret-password\","," connection: \"Username-Password-Authentication\")"," .start { print($0) }"],"type":"codeListing"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Request":{"title":"Request","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"abstract":[{"text":"Auth0 API request.","type":"text"}],"url":"\/documentation\/auth0\/request","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"https://auth0.com/docs/api/authentication/signup/create-a-new-user":{"title":"Authentication API Endpoint","type":"link","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/signup\/create-a-new-user","url":"https:\/\/auth0.com\/docs\/api\/authentication\/signup\/create-a-new-user"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/signup(email:username:password:connection:userMetadata:rootAttributes:)-92l3l":{"type":"topic","title":"signup(email:username:password:connection:userMetadata:rootAttributes:)","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","abstract":[{"type":"text","text":"Creates a user in a database connection."}],"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"signup"},{"kind":"text","text":"("},{"kind":"externalParam","text":"email"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"username"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"password"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"userMetadata"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]?, "},{"kind":"externalParam","text":"rootAttributes"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]?) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012DatabaseUsera","text":"DatabaseUser"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"https://auth0.com/docs/api/authentication":{"title":"Auth0 Authentication API","url":"https:\/\/auth0.com\/docs\/api\/authentication","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}]},"doc://com.auth0.Auth0/documentation/Auth0/DatabaseUser":{"url":"\/documentation\/auth0\/databaseuser","abstract":[{"type":"text","text":"A newly created database user (just the email, username, and email verified flag)."}],"title":"DatabaseUser","navigatorTitle":[{"kind":"identifier","text":"DatabaseUser"}],"fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"DatabaseUser"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DatabaseUser","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","abstract":[{"type":"text","text":"Client for the "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","isActive":true},{"type":"text","text":"."}],"type":"topic","title":"Authentication","url":"\/documentation\/auth0\/authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authentication/signup(email:username:password:connection:usermetadata:rootattributes:).json b/docs/data/documentation/auth0/authentication/signup(email:username:password:connection:usermetadata:rootattributes:).json index a015b1309..5e373e04f 100644 --- a/docs/data/documentation/auth0/authentication/signup(email:username:password:connection:usermetadata:rootattributes:).json +++ b/docs/data/documentation/auth0/authentication/signup(email:username:password:connection:usermetadata:rootattributes:).json @@ -1 +1 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/signup(email:username:password:connection:userMetadata:rootAttributes:)","interfaceLanguage":"swift"},"sections":[],"defaultImplementationsSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/signup(email:username:password:connection:userMetadata:rootAttributes:)-92l3l"],"anchor":"Authentication-Implementations","title":"Authentication Implementations"}],"abstract":[{"type":"text","text":"Creates a user in a database connection."}],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"signup"},{"kind":"text","text":"("},{"kind":"externalParam","text":"email"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"username"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"password"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"userMetadata"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]?, "},{"kind":"externalParam","text":"rootAttributes"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]?) -> "},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DatabaseUser","preciseIdentifier":"s:5Auth012DatabaseUsera","text":"DatabaseUser"},{"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":"declarations"},{"parameters":[{"name":"email","content":[{"type":"paragraph","inlineContent":[{"text":"Email for the new user.","type":"text"}]}]},{"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":"."}]}]},{"name":"password","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Password for the new user."}]}]},{"name":"connection","content":[{"inlineContent":[{"text":"Name of the database connection where the user will be created.","type":"text"}],"type":"paragraph"}]},{"name":"userMetadata","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Additional user metadata parameters that will be added to the newly created user."}]}]},{"name":"rootAttributes","content":[{"inlineContent":[{"text":"Root attributes that will be added to the newly created user. These will not overwrite existing parameters. See https:\/\/auth0.com\/docs\/api\/authentication#signup for the full list of supported attributes.","type":"text"}],"type":"paragraph"}]}],"kind":"parameters"},{"content":[{"anchor":"return-value","type":"heading","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"},{"content":[{"text":"Usage","anchor":"Usage","type":"heading","level":2},{"type":"codeListing","syntax":"swift","code":["Auth0"," .authentication()"," .signup(email: \"support@auth0.com\","," password: \"secret-password\","," connection: \"Username-Password-Authentication\")"," .start { result in"," switch result {"," case .success(let user):"," print(\"User signed up: \\(user)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"]},{"inlineContent":[{"text":"You can also add additional metadata when creating the user:","type":"text"}],"type":"paragraph"},{"type":"codeListing","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) }"]},{"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"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/signup(email:username:password:connection:usermetadata:rootattributes:)"]}],"kind":"symbol","schemaVersion":{"patch":0,"minor":3,"major":0},"metadata":{"symbolKind":"method","roleHeading":"Instance Method","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"signup"},{"kind":"text","text":"("},{"kind":"externalParam","text":"email"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"username"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"password"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"userMetadata"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]?, "},{"kind":"externalParam","text":"rootAttributes"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]?) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012DatabaseUsera","text":"DatabaseUser"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"title":"signup(email:username:password:connection:userMetadata:rootAttributes:)","modules":[{"name":"Auth0"}],"required":true,"externalID":"s:5Auth014AuthenticationP6signup5email8username8password10connection12userMetadata14rootAttributesAA7RequestVySSAE_SSSgAFSb8verifiedtAA0B5ErrorVGSS_AMS2SSDySSypGSgAStF"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/api\/authentication\/signup\/create-a-new-user"],"anchor":"Related-Documentation","title":"Related Documentation"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Request":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/request","kind":"symbol","abstract":[{"type":"text","text":"Auth0 API request."}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"https://auth0.com/docs/api/authentication":{"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"}],"type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/signup(email:username:password:connection:userMetadata:rootAttributes:)":{"role":"symbol","abstract":[{"type":"text","text":"Creates a user in a database connection."}],"title":"signup(email:username:password:connection:userMetadata:rootAttributes:)","defaultImplementations":1,"required":true,"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/signup(email:username:password:connection:userMetadata:rootAttributes:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"signup","kind":"identifier"},{"text":"(","kind":"text"},{"text":"email","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"username","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"password","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"userMetadata","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"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"},{"text":"Any","kind":"keyword"},{"text":"]?) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth012DatabaseUsera","text":"DatabaseUser","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"url":"\/documentation\/auth0\/authentication\/signup(email:username:password:connection:usermetadata:rootattributes:)","type":"topic"},"https://auth0.com/docs/api/authentication/signup/create-a-new-user":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/signup\/create-a-new-user","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication\/signup\/create-a-new-user","title":"Authentication API Endpoint","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/signup(email:username:password:connection:userMetadata:rootAttributes:)-92l3l":{"type":"topic","kind":"symbol","url":"\/documentation\/auth0\/authentication\/signup(email:username:password:connection:usermetadata:rootattributes:)-92l3l","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"signup","kind":"identifier"},{"text":"(","kind":"text"},{"text":"email","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"username","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"password","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"userMetadata","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"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","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"DatabaseUser","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012DatabaseUsera"},{"text":", ","kind":"text"},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"abstract":[{"type":"text","text":"Creates a user in a database connection."}],"title":"signup(email:username:password:connection:userMetadata:rootAttributes:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/signup(email:username:password:connection:userMetadata:rootAttributes:)-92l3l","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"type":"topic","role":"symbol","title":"Authentication","abstract":[{"text":"Client for the ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"text":".","type":"text"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"doc://com.auth0.Auth0/documentation/Auth0/DatabaseUser":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DatabaseUser","fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"text":"DatabaseUser","kind":"identifier"}],"url":"\/documentation\/auth0\/databaseuser","kind":"symbol","title":"DatabaseUser","abstract":[{"type":"text","text":"A newly created database user (just the email, username, and email verified flag)."}],"role":"symbol","navigatorTitle":[{"text":"DatabaseUser","kind":"identifier"}],"type":"topic"}}} \ No newline at end of file +{"metadata":{"symbolKind":"method","roleHeading":"Instance Method","title":"signup(email:username:password:connection:userMetadata:rootAttributes:)","externalID":"s:5Auth014AuthenticationP6signup5email8username8password10connection12userMetadata14rootAttributesAA7RequestVySSAE_SSSgAFSb8verifiedtAA0B5ErrorVGSS_AMS2SSDySSypGSgAStF","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"signup"},{"kind":"text","text":"("},{"kind":"externalParam","text":"email"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"username"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"password"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"userMetadata"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]?, "},{"kind":"externalParam","text":"rootAttributes"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]?) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"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","required":true},"sections":[],"variants":[{"paths":["\/documentation\/auth0\/authentication\/signup(email:username:password:connection:usermetadata:rootattributes:)"],"traits":[{"interfaceLanguage":"swift"}]}],"defaultImplementationsSections":[{"anchor":"Authentication-Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/signup(email:username:password:connection:userMetadata:rootAttributes:)-92l3l"],"title":"Authentication Implementations"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/signup(email:username:password:connection:userMetadata:rootAttributes:)","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"type":"text","text":"Creates a user in a database connection."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"seeAlsoSections":[{"anchor":"Related-Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication\/signup\/create-a-new-user"],"title":"Related Documentation"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"signup","kind":"identifier"},{"text":"(","kind":"text"},{"text":"email","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"username","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"password","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"userMetadata","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"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"},{"text":"Any","kind":"keyword"},{"text":"]?) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth012DatabaseUsera","text":"DatabaseUser","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DatabaseUser"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"},{"text":">","kind":"text"}]}]},{"parameters":[{"content":[{"type":"paragraph","inlineContent":[{"text":"Email for the new user.","type":"text"}]}],"name":"email"},{"content":[{"type":"paragraph","inlineContent":[{"text":"Username for the new user (if the connection requires a username). Defaults to ","type":"text"},{"code":"nil","type":"codeVoice"},{"text":".","type":"text"}]}],"name":"username"},{"content":[{"type":"paragraph","inlineContent":[{"text":"Password for the new user.","type":"text"}]}],"name":"password"},{"content":[{"type":"paragraph","inlineContent":[{"text":"Name of the database connection where the user will be created.","type":"text"}]}],"name":"connection"},{"content":[{"type":"paragraph","inlineContent":[{"text":"Additional user metadata parameters that will be added to the newly created user.","type":"text"}]}],"name":"userMetadata"},{"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"}]}],"name":"rootAttributes"}],"kind":"parameters"},{"kind":"content","content":[{"anchor":"return-value","type":"heading","level":2,"text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A request that will yield a newly created database user (just the email, username, and email verified flag)."}]}]},{"kind":"content","content":[{"anchor":"Usage","type":"heading","level":2,"text":"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:"}]},{"type":"codeListing","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":"paragraph","inlineContent":[{"type":"text","text":"If the database connection requires a username:"}]},{"type":"codeListing","syntax":"swift","code":["Auth0"," .authentication()"," .signup(email: \"support@auth0.com\","," username: \"support\","," password: \"secret-password\","," connection: \"Username-Password-Authentication\")"," .start { print($0) }"]}]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Authentication/signup(email:username:password:connection:userMetadata:rootAttributes:)":{"defaultImplementations":1,"type":"topic","title":"signup(email:username:password:connection:userMetadata:rootAttributes:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/signup(email:username:password:connection:userMetadata:rootAttributes:)","kind":"symbol","url":"\/documentation\/auth0\/authentication\/signup(email:username:password:connection:usermetadata:rootattributes:)","abstract":[{"type":"text","text":"Creates a user in a database connection."}],"required":true,"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"signup"},{"kind":"text","text":"("},{"kind":"externalParam","text":"email"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"username"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"password"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"userMetadata"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]?, "},{"kind":"externalParam","text":"rootAttributes"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]?) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012DatabaseUsera","text":"DatabaseUser"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}]},"doc://com.auth0.Auth0/documentation/Auth0/DatabaseUser":{"url":"\/documentation\/auth0\/databaseuser","abstract":[{"type":"text","text":"A newly created database user (just the email, username, and email verified flag)."}],"title":"DatabaseUser","navigatorTitle":[{"kind":"identifier","text":"DatabaseUser"}],"fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"DatabaseUser"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DatabaseUser","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"},"https://auth0.com/docs/api/authentication":{"titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","title":"Auth0 Authentication API","url":"https:\/\/auth0.com\/docs\/api\/authentication","type":"link"},"https://auth0.com/docs/api/authentication/signup/create-a-new-user":{"titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/signup\/create-a-new-user","title":"Authentication API Endpoint","url":"https:\/\/auth0.com\/docs\/api\/authentication\/signup\/create-a-new-user","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","abstract":[{"type":"text","text":"Client for the "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","isActive":true},{"type":"text","text":"."}],"type":"topic","title":"Authentication","url":"\/documentation\/auth0\/authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"title":"Request","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"abstract":[{"text":"Auth0 API request.","type":"text"}],"url":"\/documentation\/auth0\/request","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/signup(email:username:password:connection:userMetadata:rootAttributes:)-92l3l":{"type":"topic","title":"signup(email:username:password:connection:userMetadata:rootAttributes:)","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","abstract":[{"type":"text","text":"Creates a user in a database connection."}],"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"signup"},{"kind":"text","text":"("},{"kind":"externalParam","text":"email"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"username"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"password"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"userMetadata"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]?, "},{"kind":"externalParam","text":"rootAttributes"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]?) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012DatabaseUsera","text":"DatabaseUser"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authentication/ssoexchange(withrefreshtoken:).json b/docs/data/documentation/auth0/authentication/ssoexchange(withrefreshtoken:).json index 05fc97950..8c4abf7f2 100644 --- a/docs/data/documentation/auth0/authentication/ssoexchange(withrefreshtoken:).json +++ b/docs/data/documentation/auth0/authentication/ssoexchange(withrefreshtoken:).json @@ -1 +1 @@ -{"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#refresh-token","https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens"],"title":"Related Documentation","anchor":"Related-Documentation"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/ssoExchange(withRefreshToken:)","interfaceLanguage":"swift"},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"schemaVersion":{"patch":0,"minor":3,"major":0},"abstract":[{"text":"Exchanges a user’s refresh token for a session transfer token that can be used to perform web single sign-on","type":"text"},{"text":" ","type":"text"},{"text":"(SSO).","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"ssoExchange"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withRefreshToken"},{"kind":"text","text":" "},{"kind":"internalParam","text":"refreshToken"},{"kind":"text","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":"SSOCredentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials","preciseIdentifier":"s:5Auth014SSOCredentialsV"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"AuthenticationError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"platforms":["iOS"]}]},{"kind":"parameters","parameters":[{"name":"refreshToken","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The refresh token."}]}]}]},{"kind":"content","content":[{"level":2,"text":"Return Value","type":"heading","anchor":"return-value"},{"type":"paragraph","inlineContent":[{"text":"A request that will yield SSO credentials.","type":"text"}]}]},{"kind":"content","content":[{"anchor":"Availability","type":"heading","level":2,"text":"Availability"},{"inlineContent":[{"text":"This feature is currently available in","type":"text"},{"text":" ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","isActive":true,"type":"reference"},{"text":".","type":"text"},{"text":" ","type":"text"},{"text":"Please reach out to Auth0 support to get it enabled for your tenant.","type":"text"}],"type":"paragraph"},{"anchor":"Usage","type":"heading","level":2,"text":"Usage"},{"code":["Auth0"," .authentication()"," .ssoExchange(refreshToken: credentials.refreshToken)"," .start { result in"," switch result {"," case .success(let ssoCredentials):"," print(\"Obtained new SSO credentials: \\(ssoCredentials)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"],"type":"codeListing","syntax":"swift"},{"inlineContent":[{"text":"When opening your website on any browser or web view, add the session transfer token to the URL as a query","type":"text"},{"text":" ","type":"text"},{"text":"parameter. Then your website can redirect the user to Auth0’s ","type":"text"},{"type":"codeVoice","code":"\/authorize"},{"text":" endpoint, passing along the query","type":"text"},{"text":" ","type":"text"},{"text":"parameter with the session transfer token. For example,","type":"text"},{"text":" ","type":"text"},{"type":"codeVoice","code":"https:\/\/example.com\/login?session_transfer_token=THE_TOKEN"},{"text":".","type":"text"}],"type":"paragraph"},{"inlineContent":[{"type":"text","text":"If you’re using "},{"type":"codeVoice","code":"WKWebView"},{"type":"text","text":" to open your website, you can place the session transfer token inside a cookie"},{"type":"text","text":" "},{"type":"text","text":"instead. It will be automatically sent to the "},{"type":"codeVoice","code":"\/authorize"},{"text":" endpoint.","type":"text"}],"type":"paragraph"},{"syntax":"swift","type":"codeListing","code":["let cookie = HTTPCookie(properties: ["," .domain: \"YOUR_AUTH0_DOMAIN\", \/\/ Or custom domain, if your website is using one"," .path: \"\/\","," .name: \"auth0_session_transfer_token\","," .value: ssoCredentials.sessionTransferToken,"," .expires: ssoCredentials.expiresIn,"," .secure: true","])!","","webView.configuration.websiteDataStore.httpCookieStore.setCookie(cookie)"]},{"name":"Important","type":"aside","content":[{"type":"paragraph","inlineContent":[{"text":"Make sure the cookie’s domain matches the Auth0 domain your ","type":"text"},{"inlineContent":[{"text":"website","type":"text"}],"type":"emphasis"},{"text":" is using, regardless of the","type":"text"},{"text":" ","type":"text"},{"text":"one your mobile app is using. Otherwise, the ","type":"text"},{"type":"codeVoice","code":"\/authorize"},{"text":" endpoint will not receive the cookie. If your website","type":"text"},{"text":" ","type":"text"},{"text":"is using the provided Auth0 domain (like ","type":"text"},{"type":"codeVoice","code":"example.us.auth0.com"},{"text":"), set the cookie’s domain to this value. On the","type":"text"},{"text":" ","type":"text"},{"text":"other hand, if your website is using a custom domain, use this value instead.","type":"text"}]}],"style":"important"}]}],"sections":[],"metadata":{"symbolKind":"method","externalID":"s:5Auth014AuthenticationP11ssoExchange16withRefreshTokenAA7RequestVyAA14SSOCredentialsVAA0B5ErrorVGSS_tF","title":"ssoExchange(withRefreshToken:)","required":true,"role":"symbol","modules":[{"name":"Auth0"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ssoExchange","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withRefreshToken","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"SSOCredentials","kind":"typeIdentifier","preciseIdentifier":"s:5Auth014SSOCredentialsV"},{"text":", ","kind":"text"},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"roleHeading":"Instance Method"},"variants":[{"paths":["\/documentation\/auth0\/authentication\/ssoexchange(withrefreshtoken:)"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Authentication/ssoExchange(withRefreshToken:)":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ssoExchange","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withRefreshToken","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth014SSOCredentialsV","text":"SSOCredentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"abstract":[{"type":"text","text":"Exchanges a user’s refresh token for a session transfer token that can be used to perform web single sign-on"},{"type":"text","text":" "},{"type":"text","text":"(SSO)."}],"url":"\/documentation\/auth0\/authentication\/ssoexchange(withrefreshtoken:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/ssoExchange(withRefreshToken:)","title":"ssoExchange(withRefreshToken:)","role":"symbol","kind":"symbol","type":"topic","required":true},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"https://auth0.com/docs/api/authentication":{"url":"https:\/\/auth0.com\/docs\/api\/authentication","title":"Auth0 Authentication API","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"type":"link"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access":{"url":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","title":"Early Access","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","titleInlineContent":[{"type":"text","text":"Early Access"}],"type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/SSOCredentials":{"url":"\/documentation\/auth0\/ssocredentials","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"SSOCredentials","kind":"identifier"}],"abstract":[{"type":"text","text":"Credentials obtained from Auth0 to perform web single sign-on (SSO)."}],"role":"symbol","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials","title":"SSOCredentials","type":"topic","navigatorTitle":[{"text":"SSOCredentials","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/request","kind":"symbol","abstract":[{"type":"text","text":"Auth0 API request."}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"type":"topic","role":"symbol","title":"Authentication","abstract":[{"text":"Client for the ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"text":".","type":"text"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"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","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"type":"link"},"https://auth0.com/docs/secure/tokens/refresh-tokens":{"url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","title":"Refresh Tokens","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","titleInlineContent":[{"type":"text","text":"Refresh Tokens"}],"type":"link"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"metadata":{"symbolKind":"method","modules":[{"name":"Auth0"}],"title":"ssoExchange(withRefreshToken:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"ssoExchange"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withRefreshToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth014SSOCredentialsV","text":"SSOCredentials"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"externalID":"s:5Auth014AuthenticationP11ssoExchange16withRefreshTokenAA7RequestVyAA14SSOCredentialsVAA0B5ErrorVGSS_tF","role":"symbol","required":true,"roleHeading":"Instance Method"},"sections":[],"abstract":[{"type":"text","text":"Exchanges a user’s refresh token for a session transfer token that can be used to perform web single sign-on"},{"type":"text","text":" "},{"type":"text","text":"(SSO)."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/ssoexchange(withrefreshtoken:)"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/ssoExchange(withRefreshToken:)","interfaceLanguage":"swift"},"seeAlsoSections":[{"anchor":"Related-Documentation","title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#refresh-token","https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens"]}],"kind":"symbol","schemaVersion":{"patch":0,"major":0,"minor":3},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ssoExchange","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withRefreshToken","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"refreshToken","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"SSOCredentials","preciseIdentifier":"s:5Auth014SSOCredentialsV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}]}]},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"type":"text","text":"The refresh token."}],"type":"paragraph"}],"name":"refreshToken"}]},{"content":[{"anchor":"return-value","type":"heading","level":2,"text":"Return Value"},{"type":"paragraph","inlineContent":[{"text":"A request that will yield SSO credentials.","type":"text"}]}],"kind":"content"},{"content":[{"anchor":"Availability","type":"heading","level":2,"text":"Availability"},{"type":"paragraph","inlineContent":[{"text":"This feature is currently available in","type":"text"},{"text":" ","type":"text"},{"isActive":true,"identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","type":"reference"},{"text":".","type":"text"},{"text":" ","type":"text"},{"text":"Please reach out to Auth0 support to get it enabled for your tenant.","type":"text"}]},{"anchor":"Usage","type":"heading","level":2,"text":"Usage"},{"type":"codeListing","syntax":"swift","code":["Auth0"," .authentication()"," .ssoExchange(refreshToken: credentials.refreshToken)"," .start { result in"," switch result {"," case .success(let ssoCredentials):"," print(\"Obtained new SSO credentials: \\(ssoCredentials)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"]},{"type":"paragraph","inlineContent":[{"text":"When opening your website on any browser or web view, add the session transfer token to the URL as a query","type":"text"},{"text":" ","type":"text"},{"text":"parameter. Then your website can redirect the user to Auth0’s ","type":"text"},{"code":"\/authorize","type":"codeVoice"},{"text":" endpoint, passing along the query","type":"text"},{"text":" ","type":"text"},{"text":"parameter with the session transfer token. For example,","type":"text"},{"text":" ","type":"text"},{"code":"https:\/\/example.com\/login?session_transfer_token=THE_TOKEN","type":"codeVoice"},{"text":".","type":"text"}]},{"type":"paragraph","inlineContent":[{"text":"If you’re using ","type":"text"},{"code":"WKWebView","type":"codeVoice"},{"text":" to open your website, you can place the session transfer token inside a cookie","type":"text"},{"text":" ","type":"text"},{"text":"instead. It will be automatically sent to the ","type":"text"},{"code":"\/authorize","type":"codeVoice"},{"text":" endpoint.","type":"text"}]},{"type":"codeListing","syntax":"swift","code":["let cookie = HTTPCookie(properties: ["," .domain: \"YOUR_AUTH0_DOMAIN\", \/\/ Or custom domain, if your website is using one"," .path: \"\/\","," .name: \"auth0_session_transfer_token\","," .value: ssoCredentials.sessionTransferToken,"," .expires: ssoCredentials.expiresIn,"," .secure: true","])!","","webView.configuration.websiteDataStore.httpCookieStore.setCookie(cookie)"]},{"type":"aside","style":"important","content":[{"inlineContent":[{"type":"text","text":"Make sure the cookie’s domain matches the Auth0 domain your "},{"type":"emphasis","inlineContent":[{"text":"website","type":"text"}]},{"type":"text","text":" is using, regardless of the"},{"type":"text","text":" "},{"type":"text","text":"one your mobile app is using. Otherwise, the "},{"type":"codeVoice","code":"\/authorize"},{"type":"text","text":" endpoint will not receive the cookie. If your website"},{"type":"text","text":" "},{"type":"text","text":"is using the provided Auth0 domain (like "},{"type":"codeVoice","code":"example.us.auth0.com"},{"type":"text","text":"), set the cookie’s domain to this value. On the"},{"type":"text","text":" "},{"type":"text","text":"other hand, if your website is using a custom domain, use this value instead."}],"type":"paragraph"}],"name":"Important"}],"kind":"content"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/SSOCredentials":{"title":"SSOCredentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials","navigatorTitle":[{"kind":"identifier","text":"SSOCredentials"}],"url":"\/documentation\/auth0\/ssocredentials","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"SSOCredentials"}],"abstract":[{"type":"text","text":"Credentials obtained from Auth0 to perform web single sign-on (SSO)."}],"kind":"symbol","role":"symbol","type":"topic"},"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","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens"},"https://auth0.com/docs/api/authentication":{"type":"link","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication","title":"Auth0 Authentication API","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"title":"Request","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"abstract":[{"text":"Auth0 API request.","type":"text"}],"url":"\/documentation\/auth0\/request","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/ssoExchange(withRefreshToken:)":{"url":"\/documentation\/auth0\/authentication\/ssoexchange(withrefreshtoken:)","title":"ssoExchange(withRefreshToken:)","abstract":[{"type":"text","text":"Exchanges a user’s refresh token for a session transfer token that can be used to perform web single sign-on"},{"type":"text","text":" "},{"type":"text","text":"(SSO)."}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"ssoExchange"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withRefreshToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth014SSOCredentialsV","text":"SSOCredentials"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/ssoExchange(withRefreshToken:)","required":true,"kind":"symbol","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"https://auth0.com/docs/api/authentication#refresh-token":{"type":"link","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication#refresh-token","title":"Authentication API Endpoint","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#refresh-token"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","abstract":[{"type":"text","text":"Client for the "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","isActive":true},{"type":"text","text":"."}],"type":"topic","title":"Authentication","url":"\/documentation\/auth0\/authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access":{"type":"link","titleInlineContent":[{"type":"text","text":"Early Access"}],"url":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","title":"Early Access","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access"}}} \ 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 3abf329fb..c82ce2084 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 @@ -{"metadata":{"roleHeading":"Instance Method","modules":[{"name":"Auth0"}],"role":"symbol","title":"startPasswordless(email:type:connection:)","symbolKind":"method","externalID":"s:5Auth014AuthenticationPAAE17startPasswordless5email4type10connectionAA7RequestVyytAA0B5ErrorVGSS_AA0D4TypeOSStF","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"},{"text":": ","kind":"text"},{"text":"PasswordlessType","kind":"typeIdentifier","preciseIdentifier":"s:5Auth016PasswordlessTypeO"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"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"},{"text":">","kind":"text"}],"extendedModule":"Auth0"},"variants":[{"paths":["\/documentation\/auth0\/authentication\/startpasswordless(email:type:connection:)-6xl8p"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(email:type:connection:)-6xl8p"},"schemaVersion":{"major":0,"minor":3,"patch":0},"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."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"sections":[],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"startPasswordless"},{"kind":"text","text":"("},{"kind":"externalParam","text":"email"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"type"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth016PasswordlessTypeO","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","text":"PasswordlessType"},{"kind":"text","text":" = .code, "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" = \"email\") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","text":"AuthenticationError"},{"kind":"text","text":">"}],"languages":["swift"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"text":"Email where to send the code or link.","type":"text"}],"type":"paragraph"}],"name":"email"},{"content":[{"inlineContent":[{"type":"text","text":"Type of passwordless authentication. Defaults to ‘code’."}],"type":"paragraph"}],"name":"type"},{"content":[{"inlineContent":[{"type":"text","text":"Name of the passwordless connection. Defaults to ‘email’."}],"type":"paragraph"}],"name":"connection"}]},{"content":[{"type":"heading","level":2,"anchor":"return-value","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A request for starting the passwordless flow."}]}],"kind":"content"},{"content":[{"level":2,"anchor":"Usage","text":"Usage","type":"heading"},{"code":["Auth0"," .authentication()"," .startPasswordless(email: \"support@auth0.com\")"," .start { print($0) }"],"syntax":"swift","type":"codeListing"},{"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) }"],"syntax":"swift","type":"codeListing"},{"content":[{"type":"paragraph","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"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types"},{"text":" for more information.","type":"text"}]}],"style":"note","type":"aside","name":"Requires"}],"kind":"content"}],"seeAlsoSections":[{"anchor":"Related-Documentation","title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication\/passwordless\/get-code-or-link"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Request":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/request","kind":"symbol","abstract":[{"type":"text","text":"Auth0 API request."}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/startPasswordless(email:type:connection:)-6xl8p":{"url":"\/documentation\/auth0\/authentication\/startpasswordless(email:type:connection:)-6xl8p","abstract":[{"text":"Starts passwordless authentication by sending an email with an OTP code. This is the first part of the","type":"text"},{"text":" ","type":"text"},{"text":"passwordless login flow.","type":"text"}],"role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(email:type:connection:)-6xl8p","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"startPasswordless"},{"kind":"text","text":"("},{"kind":"externalParam","text":"email"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"type"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"PasswordlessType","preciseIdentifier":"s:5Auth016PasswordlessTypeO"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"title":"startPasswordless(email:type:connection:)"},"https://auth0.com/docs/get-started/applications/application-grant-types":{"title":"our documentation","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"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"type":"topic","role":"symbol","title":"Authentication","abstract":[{"text":"Client for the ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"text":".","type":"text"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"https://auth0.com/docs/api/authentication":{"title":"Auth0 Authentication API","url":"https:\/\/auth0.com\/docs\/api\/authentication","titleInlineContent":[{"text":"Auth0 Authentication API","type":"text"}],"type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"url":"\/documentation\/auth0\/passwordlesstype","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasswordlessType"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","type":"topic","navigatorTitle":[{"kind":"identifier","text":"PasswordlessType"}],"kind":"symbol","title":"PasswordlessType","abstract":[{"type":"text","text":"Types of passwordless authentication."}]},"https://auth0.com/docs/api/authentication/passwordless/get-code-or-link":{"title":"Authentication API Endpoint","url":"https:\/\/auth0.com\/docs\/api\/authentication\/passwordless\/get-code-or-link","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/passwordless\/get-code-or-link"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"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\/Authentication"]]},"metadata":{"extendedModule":"Auth0","symbolKind":"method","modules":[{"name":"Auth0"}],"title":"startPasswordless(email:type:connection:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"startPasswordless","kind":"identifier"},{"text":"(","kind":"text"},{"text":"email","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"type","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth016PasswordlessTypeO","text":"PasswordlessType","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"externalID":"s:5Auth014AuthenticationPAAE17startPasswordless5email4type10connectionAA7RequestVyytAA0B5ErrorVGSS_AA0D4TypeOSStF","role":"symbol","roleHeading":"Instance Method"},"sections":[],"abstract":[{"type":"text","text":"Starts passwordless authentication by sending an email with an OTP code. This is the first part of the"},{"type":"text","text":" "},{"type":"text","text":"passwordless login flow."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/startpasswordless(email:type:connection:)-6xl8p"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(email:type:connection:)-6xl8p","interfaceLanguage":"swift"},"seeAlsoSections":[{"title":"Related Documentation","anchor":"Related-Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication\/passwordless\/get-code-or-link"]}],"kind":"symbol","schemaVersion":{"patch":0,"minor":3,"major":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"startPasswordless","kind":"identifier"},{"text":"(","kind":"text"},{"text":"email","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"type","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth016PasswordlessTypeO","text":"PasswordlessType","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"},{"text":" = .code, ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" = \"email\") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"},{"text":">","kind":"text"}]}]},{"kind":"parameters","parameters":[{"name":"email","content":[{"type":"paragraph","inlineContent":[{"text":"Email where to send the code or link.","type":"text"}]}]},{"name":"type","content":[{"inlineContent":[{"text":"Type of passwordless authentication. Defaults to ‘code’.","type":"text"}],"type":"paragraph"}]},{"name":"connection","content":[{"inlineContent":[{"text":"Name of the passwordless connection. Defaults to ‘email’.","type":"text"}],"type":"paragraph"}]}]},{"content":[{"type":"heading","text":"Return Value","anchor":"return-value","level":2},{"type":"paragraph","inlineContent":[{"type":"text","text":"A request for starting the passwordless flow."}]}],"kind":"content"},{"content":[{"type":"heading","text":"Usage","anchor":"Usage","level":2},{"type":"codeListing","code":["Auth0"," .authentication()"," .startPasswordless(email: \"support@auth0.com\")"," .start { print($0) }"],"syntax":"swift"},{"type":"paragraph","inlineContent":[{"type":"text","text":"If you have configured iOS Universal Links:"}]},{"syntax":"swift","type":"codeListing","code":["Auth0"," .authentication()"," .startPasswordless(email: \"support@auth0.com\", type: .iOSLink)"," .start { print($0) }"]},{"name":"Requires","style":"note","content":[{"inlineContent":[{"type":"text","text":"Passwordless OTP Grant "},{"type":"codeVoice","code":"http:\/\/auth0.com\/oauth\/grant-type\/passwordless\/otp"},{"type":"text","text":". Check"},{"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"}],"type":"aside"}],"kind":"content"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"navigatorTitle":[{"kind":"identifier","text":"PasswordlessType"}],"kind":"symbol","url":"\/documentation\/auth0\/passwordlesstype","role":"symbol","abstract":[{"type":"text","text":"Types of passwordless authentication."}],"type":"topic","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasswordlessType"}],"title":"PasswordlessType","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"},"https://auth0.com/docs/api/authentication":{"url":"https:\/\/auth0.com\/docs\/api\/authentication","title":"Auth0 Authentication API","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","titleInlineContent":[{"text":"Auth0 Authentication API","type":"text"}],"type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/startPasswordless(email:type:connection:)-6xl8p":{"url":"\/documentation\/auth0\/authentication\/startpasswordless(email:type:connection:)-6xl8p","abstract":[{"text":"Starts passwordless authentication by sending an email with an OTP code. This is the first part of the","type":"text"},{"text":" ","type":"text"},{"text":"passwordless login flow.","type":"text"}],"title":"startPasswordless(email:type:connection:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"startPasswordless","kind":"identifier"},{"text":"(","kind":"text"},{"text":"email","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"type","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"PasswordlessType","preciseIdentifier":"s:5Auth016PasswordlessTypeO","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"Void","preciseIdentifier":"s:s4Voida","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(email:type:connection:)-6xl8p","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"title":"Request","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"abstract":[{"text":"Auth0 API request.","type":"text"}],"url":"\/documentation\/auth0\/request","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","abstract":[{"type":"text","text":"Client for the "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","isActive":true},{"type":"text","text":"."}],"type":"topic","title":"Authentication","url":"\/documentation\/auth0\/authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"https://auth0.com/docs/api/authentication/passwordless/get-code-or-link":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/passwordless\/get-code-or-link","titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication\/passwordless\/get-code-or-link","title":"Authentication API Endpoint","type":"link"},"https://auth0.com/docs/get-started/applications/application-grant-types":{"title":"our documentation","titleInlineContent":[{"text":"our documentation","type":"text"}],"url":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","type":"link"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authentication/startpasswordless(email:type:connection:).json b/docs/data/documentation/auth0/authentication/startpasswordless(email:type:connection:).json index 8331611e7..1404c88c9 100644 --- a/docs/data/documentation/auth0/authentication/startpasswordless(email:type:connection:).json +++ b/docs/data/documentation/auth0/authentication/startpasswordless(email:type:connection:).json @@ -1 +1 @@ -{"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(email:type:connection:)"},"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."}],"defaultImplementationsSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(email:type:connection:)-6xl8p"],"anchor":"Authentication-Implementations","title":"Authentication Implementations"}],"schemaVersion":{"patch":0,"minor":3,"major":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"metadata":{"modules":[{"name":"Auth0"}],"required":true,"roleHeading":"Instance Method","title":"startPasswordless(email:type:connection:)","externalID":"s:5Auth014AuthenticationP17startPasswordless5email4type10connectionAA7RequestVyytAA0B5ErrorVGSS_AA0D4TypeOSStF","symbolKind":"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"},{"text":": ","kind":"text"},{"text":"PasswordlessType","kind":"typeIdentifier","preciseIdentifier":"s:5Auth016PasswordlessTypeO"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"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"},{"text":">","kind":"text"}]},"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/api\/authentication\/passwordless\/get-code-or-link"],"anchor":"Related-Documentation","title":"Related Documentation"}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"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"},{"text":": ","kind":"text"},{"text":"PasswordlessType","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","kind":"typeIdentifier","preciseIdentifier":"s:5Auth016PasswordlessTypeO"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":", ","kind":"text"},{"text":"AuthenticationError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}],"platforms":["iOS"]}],"kind":"declarations"},{"parameters":[{"content":[{"type":"paragraph","inlineContent":[{"text":"Email where to send the code or link.","type":"text"}]}],"name":"email"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Type of passwordless authentication. Defaults to ‘code’."}]}],"name":"type"},{"content":[{"inlineContent":[{"text":"Name of the passwordless connection. Defaults to ‘email’.","type":"text"}],"type":"paragraph"}],"name":"connection"}],"kind":"parameters"},{"kind":"content","content":[{"anchor":"return-value","type":"heading","text":"Return Value","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"},{"type":"codeListing","syntax":"swift","code":["Auth0"," .authentication()"," .startPasswordless(email: \"support@auth0.com\")"," .start { print($0) }"]},{"type":"paragraph","inlineContent":[{"type":"text","text":"If you have configured iOS Universal Links:"}]},{"type":"codeListing","syntax":"swift","code":["Auth0"," .authentication()"," .startPasswordless(email: \"support@auth0.com\", type: .iOSLink)"," .start { print($0) }"]},{"type":"aside","style":"note","name":"Requires","content":[{"inlineContent":[{"type":"text","text":"Passwordless OTP Grant "},{"code":"http:\/\/auth0.com\/oauth\/grant-type\/passwordless\/otp","type":"codeVoice"},{"type":"text","text":". Check"},{"type":"text","text":" "},{"type":"reference","isActive":true,"identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types"},{"type":"text","text":" for more information."}],"type":"paragraph"}]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/startpasswordless(email:type:connection:)"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/startPasswordless(email:type:connection:)":{"required":true,"role":"symbol","url":"\/documentation\/auth0\/authentication\/startpasswordless(email:type:connection:)","title":"startPasswordless(email:type:connection:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(email:type:connection:)","defaultImplementations":1,"type":"topic","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"startPasswordless","kind":"identifier"},{"text":"(","kind":"text"},{"text":"email","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"type","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth016PasswordlessTypeO","text":"PasswordlessType","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"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"},{"type":"text","text":" "},{"type":"text","text":"passwordless login flow."}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/startPasswordless(email:type:connection:)-6xl8p":{"url":"\/documentation\/auth0\/authentication\/startpasswordless(email:type:connection:)-6xl8p","abstract":[{"text":"Starts passwordless authentication by sending an email with an OTP code. This is the first part of the","type":"text"},{"text":" ","type":"text"},{"text":"passwordless login flow.","type":"text"}],"role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(email:type:connection:)-6xl8p","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"startPasswordless"},{"kind":"text","text":"("},{"kind":"externalParam","text":"email"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"type"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"PasswordlessType","preciseIdentifier":"s:5Auth016PasswordlessTypeO"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"title":"startPasswordless(email:type:connection:)"},"https://auth0.com/docs/api/authentication":{"title":"Auth0 Authentication API","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},"https://auth0.com/docs/api/authentication/passwordless/get-code-or-link":{"title":"Authentication API Endpoint","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication\/passwordless\/get-code-or-link","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/passwordless\/get-code-or-link"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"url":"\/documentation\/auth0\/passwordlesstype","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasswordlessType"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","type":"topic","navigatorTitle":[{"kind":"identifier","text":"PasswordlessType"}],"kind":"symbol","title":"PasswordlessType","abstract":[{"type":"text","text":"Types of passwordless authentication."}]},"https://auth0.com/docs/get-started/applications/application-grant-types":{"title":"our documentation","titleInlineContent":[{"type":"text","text":"our documentation"}],"url":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","type":"link","identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"type":"topic","role":"symbol","title":"Authentication","abstract":[{"text":"Client for the ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"text":".","type":"text"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/request","kind":"symbol","abstract":[{"type":"text","text":"Auth0 API request."}]}}} \ No newline at end of file +{"metadata":{"externalID":"s:5Auth014AuthenticationP17startPasswordless5email4type10connectionAA7RequestVyytAA0B5ErrorVGSS_AA0D4TypeOSStF","symbolKind":"method","title":"startPasswordless(email:type:connection:)","roleHeading":"Instance Method","role":"symbol","required":true,"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"},{"text":": ","kind":"text"},{"text":"PasswordlessType","kind":"typeIdentifier","preciseIdentifier":"s:5Auth016PasswordlessTypeO"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"modules":[{"name":"Auth0"}]},"sections":[],"variants":[{"paths":["\/documentation\/auth0\/authentication\/startpasswordless(email:type:connection:)"],"traits":[{"interfaceLanguage":"swift"}]}],"defaultImplementationsSections":[{"title":"Authentication Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(email:type:connection:)-6xl8p"],"anchor":"Authentication-Implementations"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(email:type:connection:)","interfaceLanguage":"swift"},"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."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication\/passwordless\/get-code-or-link"],"anchor":"Related-Documentation"}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"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"},{"text":": ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","text":"PasswordlessType","kind":"typeIdentifier","preciseIdentifier":"s:5Auth016PasswordlessTypeO"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"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"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":", ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":">","kind":"text"}]}],"kind":"declarations"},{"parameters":[{"content":[{"inlineContent":[{"type":"text","text":"Email where to send the code or link."}],"type":"paragraph"}],"name":"email"},{"content":[{"inlineContent":[{"type":"text","text":"Type of passwordless authentication. Defaults to ‘code’."}],"type":"paragraph"}],"name":"type"},{"content":[{"inlineContent":[{"type":"text","text":"Name of the passwordless connection. Defaults to ‘email’."}],"type":"paragraph"}],"name":"connection"}],"kind":"parameters"},{"kind":"content","content":[{"level":2,"anchor":"return-value","text":"Return Value","type":"heading"},{"inlineContent":[{"text":"A request for starting the passwordless flow.","type":"text"}],"type":"paragraph"}]},{"kind":"content","content":[{"type":"heading","text":"Usage","anchor":"Usage","level":2},{"syntax":"swift","code":["Auth0"," .authentication()"," .startPasswordless(email: \"support@auth0.com\")"," .start { print($0) }"],"type":"codeListing"},{"inlineContent":[{"type":"text","text":"If you have configured iOS Universal Links:"}],"type":"paragraph"},{"syntax":"swift","code":["Auth0"," .authentication()"," .startPasswordless(email: \"support@auth0.com\", type: .iOSLink)"," .start { print($0) }"],"type":"codeListing"},{"content":[{"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."}],"type":"paragraph"}],"type":"aside","name":"Requires","style":"note"}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"},"https://auth0.com/docs/api/authentication":{"title":"Auth0 Authentication API","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","abstract":[{"type":"text","text":"Client for the "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","isActive":true},{"type":"text","text":"."}],"type":"topic","title":"Authentication","url":"\/documentation\/auth0\/authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/startPasswordless(email:type:connection:)-6xl8p":{"url":"\/documentation\/auth0\/authentication\/startpasswordless(email:type:connection:)-6xl8p","abstract":[{"text":"Starts passwordless authentication by sending an email with an OTP code. This is the first part of the","type":"text"},{"text":" ","type":"text"},{"text":"passwordless login flow.","type":"text"}],"title":"startPasswordless(email:type:connection:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"startPasswordless","kind":"identifier"},{"text":"(","kind":"text"},{"text":"email","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"type","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"PasswordlessType","preciseIdentifier":"s:5Auth016PasswordlessTypeO","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"Void","preciseIdentifier":"s:s4Voida","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(email:type:connection:)-6xl8p","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"title":"Request","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"abstract":[{"text":"Auth0 API request.","type":"text"}],"url":"\/documentation\/auth0\/request","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/startPasswordless(email:type:connection:)":{"defaultImplementations":1,"type":"topic","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"},{"text":"passwordless login flow.","type":"text"}],"kind":"symbol","title":"startPasswordless(email:type:connection:)","url":"\/documentation\/auth0\/authentication\/startpasswordless(email:type:connection:)","required":true,"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"startPasswordless"},{"kind":"text","text":"("},{"kind":"externalParam","text":"email"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"type"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth016PasswordlessTypeO","kind":"typeIdentifier","text":"PasswordlessType"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:s4Voida","kind":"typeIdentifier","text":"Void"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","text":"AuthenticationError"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(email:type:connection:)"},"https://auth0.com/docs/api/authentication/passwordless/get-code-or-link":{"title":"Authentication API Endpoint","type":"link","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/passwordless\/get-code-or-link","url":"https:\/\/auth0.com\/docs\/api\/authentication\/passwordless\/get-code-or-link"},"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","identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","titleInlineContent":[{"type":"text","text":"our documentation"}]},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"navigatorTitle":[{"kind":"identifier","text":"PasswordlessType"}],"kind":"symbol","url":"\/documentation\/auth0\/passwordlesstype","role":"symbol","abstract":[{"type":"text","text":"Types of passwordless authentication."}],"type":"topic","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasswordlessType"}],"title":"PasswordlessType","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"}}} \ 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 363424b7c..ba5ea67fe 100644 --- a/docs/data/documentation/auth0/authentication/startpasswordless(phonenumber:type:connection:)-5azmm.json +++ b/docs/data/documentation/auth0/authentication/startpasswordless(phonenumber:type:connection:)-5azmm.json @@ -1 +1 @@ -{"seeAlsoSections":[{"title":"Related Documentation","anchor":"Related-Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication\/passwordless\/get-code-or-link"]}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"startPasswordless"},{"kind":"text","text":"("},{"kind":"externalParam","text":"phoneNumber"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"type"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth016PasswordlessTypeO","kind":"typeIdentifier","text":"PasswordlessType","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"},{"kind":"text","text":" = .code, "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" = \"sms\") -> "},{"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"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","text":"AuthenticationError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"},{"kind":"text","text":">"}]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"type":"text","text":"Phone number where to send the SMS with the code or link."}],"type":"paragraph"}],"name":"phoneNumber"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Type of passwordless authentication. Defaults to ‘code’."}]}],"name":"type"},{"content":[{"type":"paragraph","inlineContent":[{"text":"Name of the passwordless connection. Defaults to ‘sms’.","type":"text"}]}],"name":"connection"}]},{"kind":"content","content":[{"text":"Return Value","level":2,"anchor":"return-value","type":"heading"},{"inlineContent":[{"type":"text","text":"A request for starting the passwordless flow."}],"type":"paragraph"}]},{"kind":"content","content":[{"level":2,"type":"heading","text":"Usage","anchor":"Usage"},{"type":"codeListing","code":["Auth0"," .authentication()"," .startPasswordless(phoneNumber: \"+12025550135\")"," .start { print($0) }"],"syntax":"swift"},{"type":"paragraph","inlineContent":[{"type":"text","text":"If you have configured iOS Universal Links:"}]},{"type":"codeListing","code":["Auth0"," .authentication()"," .startPasswordless(phoneNumber: \"+12025550135\", type: .iOSLink)"," .start { print($0) }"],"syntax":"swift"},{"style":"note","type":"aside","content":[{"type":"paragraph","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},{"text":" for more information.","type":"text"}]}],"name":"Requires"}]}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"variants":[{"paths":["\/documentation\/auth0\/authentication\/startpasswordless(phonenumber:type:connection:)-5azmm"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"externalID":"s:5Auth014AuthenticationPAAE17startPasswordless11phoneNumber4type10connectionAA7RequestVyytAA0B5ErrorVGSS_AA0D4TypeOSStF","role":"symbol","roleHeading":"Instance Method","extendedModule":"Auth0","symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"startPasswordless","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"phoneNumber"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"type"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth016PasswordlessTypeO","text":"PasswordlessType"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"title":"startPasswordless(phoneNumber:type:connection:)","modules":[{"name":"Auth0"}]},"schemaVersion":{"minor":3,"major":0,"patch":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(phoneNumber:type:connection:)-5azmm","interfaceLanguage":"swift"},"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."}],"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Authentication/startPasswordless(phoneNumber:type:connection:)-5azmm":{"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"startPasswordless","kind":"identifier"},{"text":"(","kind":"text"},{"text":"phoneNumber","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"type","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"PasswordlessType","preciseIdentifier":"s:5Auth016PasswordlessTypeO","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"Void","preciseIdentifier":"s:s4Voida","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"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"},{"type":"text","text":" "},{"type":"text","text":"login flow."}],"type":"topic","kind":"symbol","url":"\/documentation\/auth0\/authentication\/startpasswordless(phonenumber:type:connection:)-5azmm","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(phoneNumber:type:connection:)-5azmm"},"https://auth0.com/docs/api/authentication/passwordless/get-code-or-link":{"url":"https:\/\/auth0.com\/docs\/api\/authentication\/passwordless\/get-code-or-link","title":"Authentication API Endpoint","type":"link","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/passwordless\/get-code-or-link"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/request","kind":"symbol","abstract":[{"type":"text","text":"Auth0 API request."}]},"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":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"type":"topic","role":"symbol","title":"Authentication","abstract":[{"text":"Client for the ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"text":".","type":"text"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"url":"\/documentation\/auth0\/passwordlesstype","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasswordlessType"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","type":"topic","navigatorTitle":[{"kind":"identifier","text":"PasswordlessType"}],"kind":"symbol","title":"PasswordlessType","abstract":[{"type":"text","text":"Types of passwordless authentication."}]},"https://auth0.com/docs/api/authentication":{"url":"https:\/\/auth0.com\/docs\/api\/authentication","title":"Auth0 Authentication API","type":"link","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]}}} \ No newline at end of file +{"kind":"symbol","primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"startPasswordless"},{"kind":"text","text":"("},{"kind":"externalParam","text":"phoneNumber"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"type"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth016PasswordlessTypeO","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","kind":"typeIdentifier","text":"PasswordlessType"},{"kind":"text","text":" = .code, "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" = \"sms\") -> "},{"preciseIdentifier":"s:5Auth07RequestV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier","text":"Request"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:s4Voida","kind":"typeIdentifier","text":"Void"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","kind":"typeIdentifier","text":"AuthenticationError"},{"kind":"text","text":">"}]}],"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’."}]}]},{"name":"connection","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Name of the passwordless connection. Defaults to ‘sms’."}]}]}]},{"content":[{"anchor":"return-value","type":"heading","level":2,"text":"Return Value"},{"inlineContent":[{"type":"text","text":"A request for starting the passwordless flow."}],"type":"paragraph"}],"kind":"content"},{"content":[{"anchor":"Usage","type":"heading","level":2,"text":"Usage"},{"type":"codeListing","code":["Auth0"," .authentication()"," .startPasswordless(phoneNumber: \"+12025550135\")"," .start { print($0) }"],"syntax":"swift"},{"inlineContent":[{"type":"text","text":"If you have configured iOS Universal Links:"}],"type":"paragraph"},{"type":"codeListing","code":["Auth0"," .authentication()"," .startPasswordless(phoneNumber: \"+12025550135\", type: .iOSLink)"," .start { print($0) }"],"syntax":"swift"},{"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":" "},{"type":"reference","isActive":true,"identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types"},{"type":"text","text":" for more information."}]}],"style":"note"}],"kind":"content"}],"variants":[{"paths":["\/documentation\/auth0\/authentication\/startpasswordless(phonenumber:type:connection:)-5azmm"],"traits":[{"interfaceLanguage":"swift"}]}],"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/api\/authentication\/passwordless\/get-code-or-link"],"title":"Related Documentation","anchor":"Related-Documentation"}],"sections":[],"schemaVersion":{"patch":0,"minor":3,"major":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(phoneNumber:type:connection:)-5azmm","interfaceLanguage":"swift"},"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":{"roleHeading":"Instance Method","extendedModule":"Auth0","role":"symbol","title":"startPasswordless(phoneNumber:type:connection:)","symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"startPasswordless","kind":"identifier"},{"text":"(","kind":"text"},{"text":"phoneNumber","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"type","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth016PasswordlessTypeO","text":"PasswordlessType","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"externalID":"s:5Auth014AuthenticationPAAE17startPasswordless11phoneNumber4type10connectionAA7RequestVyytAA0B5ErrorVGSS_AA0D4TypeOSStF","modules":[{"name":"Auth0"}]},"references":{"https://auth0.com/docs/api/authentication":{"url":"https:\/\/auth0.com\/docs\/api\/authentication","titleInlineContent":[{"text":"Auth0 Authentication API","type":"text"}],"title":"Auth0 Authentication API","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"title":"Request","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"abstract":[{"text":"Auth0 API request.","type":"text"}],"url":"\/documentation\/auth0\/request","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"navigatorTitle":[{"kind":"identifier","text":"PasswordlessType"}],"kind":"symbol","url":"\/documentation\/auth0\/passwordlesstype","role":"symbol","abstract":[{"type":"text","text":"Types of passwordless authentication."}],"type":"topic","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasswordlessType"}],"title":"PasswordlessType","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"},"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","identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","abstract":[{"type":"text","text":"Client for the "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","isActive":true},{"type":"text","text":"."}],"type":"topic","title":"Authentication","url":"\/documentation\/auth0\/authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"https://auth0.com/docs/api/authentication/passwordless/get-code-or-link":{"url":"https:\/\/auth0.com\/docs\/api\/authentication\/passwordless\/get-code-or-link","titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}],"title":"Authentication API Endpoint","identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/passwordless\/get-code-or-link","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/startPasswordless(phoneNumber:type:connection:)-5azmm":{"kind":"symbol","title":"startPasswordless(phoneNumber:type:connection:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"startPasswordless","kind":"identifier"},{"text":"(","kind":"text"},{"text":"phoneNumber","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"type","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"PasswordlessType","preciseIdentifier":"s:5Auth016PasswordlessTypeO","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"Void","preciseIdentifier":"s:s4Voida","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(phoneNumber:type:connection:)-5azmm","abstract":[{"text":"Starts passwordless authentication by sending an SMS with an OTP code. This is the first part of the passwordless","type":"text"},{"text":" ","type":"text"},{"text":"login flow.","type":"text"}],"url":"\/documentation\/auth0\/authentication\/startpasswordless(phonenumber:type:connection:)-5azmm"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authentication/startpasswordless(phonenumber:type:connection:).json b/docs/data/documentation/auth0/authentication/startpasswordless(phonenumber:type:connection:).json index 40e229c8b..df7ec2aaf 100644 --- a/docs/data/documentation/auth0/authentication/startpasswordless(phonenumber:type:connection:).json +++ b/docs/data/documentation/auth0/authentication/startpasswordless(phonenumber:type:connection:).json @@ -1 +1 @@ -{"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"startPasswordless","kind":"identifier"},{"text":"(","kind":"text"},{"text":"phoneNumber","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"type","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"PasswordlessType","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","preciseIdentifier":"s:5Auth016PasswordlessTypeO"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"kind":"text","text":", "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}]}],"kind":"declarations"},{"parameters":[{"name":"phoneNumber","content":[{"inlineContent":[{"type":"text","text":"Phone number where to send the SMS with the code or link."}],"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"},{"kind":"content","content":[{"anchor":"return-value","text":"Return Value","level":2,"type":"heading"},{"inlineContent":[{"type":"text","text":"A request for starting the passwordless flow."}],"type":"paragraph"}]},{"kind":"content","content":[{"text":"Usage","type":"heading","level":2,"anchor":"Usage"},{"syntax":"swift","code":["Auth0"," .authentication()"," .startPasswordless(phoneNumber: \"+12025550135\")"," .start { print($0) }"],"type":"codeListing"},{"inlineContent":[{"type":"text","text":"If you have configured iOS Universal Links:"}],"type":"paragraph"},{"syntax":"swift","code":["Auth0"," .authentication()"," .startPasswordless(phoneNumber: \"+12025550135\", type: .iOSLink)"," .start { print($0) }"],"type":"codeListing"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Passwordless OTP Grant "},{"type":"codeVoice","code":"http:\/\/auth0.com\/oauth\/grant-type\/passwordless\/otp"},{"type":"text","text":". Check"},{"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","type":"aside","name":"Requires"}]}],"abstract":[{"text":"Starts passwordless authentication by sending an SMS with an OTP code. This is the first part of the passwordless","type":"text"},{"text":" ","type":"text"},{"text":"login flow.","type":"text"}],"seeAlsoSections":[{"anchor":"Related-Documentation","title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication\/passwordless\/get-code-or-link"]}],"metadata":{"required":true,"title":"startPasswordless(phoneNumber:type:connection:)","externalID":"s:5Auth014AuthenticationP17startPasswordless11phoneNumber4type10connectionAA7RequestVyytAA0B5ErrorVGSS_AA0D4TypeOSStF","roleHeading":"Instance Method","symbolKind":"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","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"type"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"PasswordlessType","preciseIdentifier":"s:5Auth016PasswordlessTypeO"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"role":"symbol","modules":[{"name":"Auth0"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(phoneNumber:type:connection:)","interfaceLanguage":"swift"},"defaultImplementationsSections":[{"title":"Authentication Implementations","anchor":"Authentication-Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(phoneNumber:type:connection:)-5azmm"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"schemaVersion":{"patch":0,"major":0,"minor":3},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/startpasswordless(phonenumber:type:connection:)"]}],"sections":[],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/Authentication/startPasswordless(phoneNumber:type:connection:)-5azmm":{"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"startPasswordless","kind":"identifier"},{"text":"(","kind":"text"},{"text":"phoneNumber","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"type","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"PasswordlessType","preciseIdentifier":"s:5Auth016PasswordlessTypeO","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"Void","preciseIdentifier":"s:s4Voida","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"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"},{"type":"text","text":" "},{"type":"text","text":"login flow."}],"type":"topic","kind":"symbol","url":"\/documentation\/auth0\/authentication\/startpasswordless(phonenumber:type:connection:)-5azmm","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(phoneNumber:type:connection:)-5azmm"},"https://auth0.com/docs/api/authentication":{"type":"link","title":"Auth0 Authentication API","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","titleInlineContent":[{"text":"Auth0 Authentication API","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication"},"https://auth0.com/docs/api/authentication/passwordless/get-code-or-link":{"type":"link","titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}],"title":"Authentication API Endpoint","url":"https:\/\/auth0.com\/docs\/api\/authentication\/passwordless\/get-code-or-link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/passwordless\/get-code-or-link"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"url":"\/documentation\/auth0\/passwordlesstype","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasswordlessType"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","type":"topic","navigatorTitle":[{"kind":"identifier","text":"PasswordlessType"}],"kind":"symbol","title":"PasswordlessType","abstract":[{"type":"text","text":"Types of passwordless authentication."}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/startPasswordless(phoneNumber:type:connection:)":{"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"},{"type":"text","text":" "},{"type":"text","text":"login flow."}],"required":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(phoneNumber:type:connection:)","url":"\/documentation\/auth0\/authentication\/startpasswordless(phonenumber:type:connection:)","role":"symbol","defaultImplementations":1,"kind":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"startPasswordless"},{"kind":"text","text":"("},{"kind":"externalParam","text":"phoneNumber"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"type"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth016PasswordlessTypeO","kind":"typeIdentifier","text":"PasswordlessType"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:s4Voida","kind":"typeIdentifier","text":"Void"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","text":"AuthenticationError"},{"kind":"text","text":">"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"https://auth0.com/docs/get-started/applications/application-grant-types":{"type":"link","titleInlineContent":[{"text":"our documentation","type":"text"}],"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":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/request","kind":"symbol","abstract":[{"type":"text","text":"Auth0 API request."}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"type":"topic","role":"symbol","title":"Authentication","abstract":[{"text":"Client for the ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"text":".","type":"text"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]}}} \ No newline at end of file +{"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."}],"seeAlsoSections":[{"title":"Related Documentation","anchor":"Related-Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication\/passwordless\/get-code-or-link"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"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"},{"kind":"text","text":", "},{"kind":"externalParam","text":"type"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth016PasswordlessTypeO","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","text":"PasswordlessType"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"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"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","text":"AuthenticationError"},{"kind":"text","text":">"}]}]},{"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’."}]}]},{"name":"connection","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Name of the passwordless connection. Defaults to ‘sms’."}]}]}],"kind":"parameters"},{"kind":"content","content":[{"level":2,"anchor":"return-value","type":"heading","text":"Return Value"},{"inlineContent":[{"type":"text","text":"A request for starting the passwordless flow."}],"type":"paragraph"}]},{"kind":"content","content":[{"level":2,"anchor":"Usage","type":"heading","text":"Usage"},{"code":["Auth0"," .authentication()"," .startPasswordless(phoneNumber: \"+12025550135\")"," .start { print($0) }"],"type":"codeListing","syntax":"swift"},{"inlineContent":[{"type":"text","text":"If you have configured iOS Universal Links:"}],"type":"paragraph"},{"code":["Auth0"," .authentication()"," .startPasswordless(phoneNumber: \"+12025550135\", type: .iOSLink)"," .start { print($0) }"],"type":"codeListing","syntax":"swift"},{"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":" "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types"},{"type":"text","text":" for more information."}]}],"type":"aside","style":"note"}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/startpasswordless(phonenumber:type:connection:)"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"defaultImplementationsSections":[{"title":"Authentication Implementations","anchor":"Authentication-Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(phoneNumber:type:connection:)-5azmm"]}],"metadata":{"modules":[{"name":"Auth0"}],"title":"startPasswordless(phoneNumber:type:connection:)","roleHeading":"Instance Method","symbolKind":"method","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"startPasswordless"},{"kind":"text","text":"("},{"kind":"externalParam","text":"phoneNumber"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"type"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"PasswordlessType","preciseIdentifier":"s:5Auth016PasswordlessTypeO"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"required":true,"externalID":"s:5Auth014AuthenticationP17startPasswordless11phoneNumber4type10connectionAA7RequestVyytAA0B5ErrorVGSS_AA0D4TypeOSStF"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(phoneNumber:type:connection:)","interfaceLanguage":"swift"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"navigatorTitle":[{"kind":"identifier","text":"PasswordlessType"}],"kind":"symbol","url":"\/documentation\/auth0\/passwordlesstype","role":"symbol","abstract":[{"type":"text","text":"Types of passwordless authentication."}],"type":"topic","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasswordlessType"}],"title":"PasswordlessType","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"},"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/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"title":"Request","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"abstract":[{"text":"Auth0 API request.","type":"text"}],"url":"\/documentation\/auth0\/request","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","abstract":[{"type":"text","text":"Client for the "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","isActive":true},{"type":"text","text":"."}],"type":"topic","title":"Authentication","url":"\/documentation\/auth0\/authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"https://auth0.com/docs/api/authentication/passwordless/get-code-or-link":{"title":"Authentication API Endpoint","type":"link","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/passwordless\/get-code-or-link","url":"https:\/\/auth0.com\/docs\/api\/authentication\/passwordless\/get-code-or-link"},"https://auth0.com/docs/get-started/applications/application-grant-types":{"title":"our documentation","type":"link","titleInlineContent":[{"type":"text","text":"our documentation"}],"identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types","url":"https:\/\/auth0.com\/docs\/get-started\/applications\/application-grant-types"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/startPasswordless(phoneNumber:type:connection:)":{"defaultImplementations":1,"type":"topic","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."}],"kind":"symbol","url":"\/documentation\/auth0\/authentication\/startpasswordless(phonenumber:type:connection:)","title":"startPasswordless(phoneNumber:type:connection:)","required":true,"role":"symbol","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"},{"kind":"text","text":", "},{"kind":"externalParam","text":"type"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"PasswordlessType","preciseIdentifier":"s:5Auth016PasswordlessTypeO"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(phoneNumber:type:connection:)"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/startPasswordless(phoneNumber:type:connection:)-5azmm":{"kind":"symbol","title":"startPasswordless(phoneNumber:type:connection:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"startPasswordless","kind":"identifier"},{"text":"(","kind":"text"},{"text":"phoneNumber","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"type","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"PasswordlessType","preciseIdentifier":"s:5Auth016PasswordlessTypeO","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"Void","preciseIdentifier":"s:s4Voida","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/startPasswordless(phoneNumber:type:connection:)-5azmm","abstract":[{"text":"Starts passwordless authentication by sending an SMS with an OTP code. This is the first part of the passwordless","type":"text"},{"text":" ","type":"text"},{"text":"login flow.","type":"text"}],"url":"\/documentation\/auth0\/authentication\/startpasswordless(phonenumber:type:connection:)-5azmm"}}} \ 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 3ade71d03..f4bb1e617 100644 --- a/docs/data/documentation/auth0/authentication/url.json +++ b/docs/data/documentation/auth0/authentication/url.json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"url"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"URL","preciseIdentifier":"s:10Foundation3URLV"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"languages":["swift"],"platforms":["iOS"]}]}],"kind":"symbol","metadata":{"roleHeading":"Instance Property","externalID":"s:5Auth014AuthenticationP3url10Foundation3URLVvp","title":"url","role":"symbol","modules":[{"name":"Auth0"}],"required":true,"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"url"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"URL","preciseIdentifier":"s:10Foundation3URLV"}],"symbolKind":"property"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/url"]}],"abstract":[{"text":"The Auth0 Domain URL.","type":"text"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/url"},"sections":[],"schemaVersion":{"patch":0,"major":0,"minor":3},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Authentication/url":{"required":true,"url":"\/documentation\/auth0\/authentication\/url","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"url"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV","text":"URL"}],"abstract":[{"text":"The Auth0 Domain URL.","type":"text"}],"role":"symbol","kind":"symbol","type":"topic","title":"url","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/url"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"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":[{"type":"text","text":"Auth0 Authentication API"}],"type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"type":"topic","role":"symbol","title":"Authentication","abstract":[{"text":"Client for the ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"text":".","type":"text"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]}}} \ No newline at end of file +{"abstract":[{"type":"text","text":"The Auth0 Domain URL."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"url","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation3URLV","text":"URL","kind":"typeIdentifier"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/url"]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"metadata":{"modules":[{"name":"Auth0"}],"title":"url","roleHeading":"Instance Property","symbolKind":"property","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"url"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV","text":"URL"}],"required":true,"externalID":"s:5Auth014AuthenticationP3url10Foundation3URLVvp"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/url","interfaceLanguage":"swift"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","abstract":[{"type":"text","text":"Client for the "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","isActive":true},{"type":"text","text":"."}],"type":"topic","title":"Authentication","url":"\/documentation\/auth0\/authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/url":{"kind":"symbol","title":"url","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"url"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation3URLV","text":"URL","kind":"typeIdentifier"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/url","required":true,"abstract":[{"type":"text","text":"The Auth0 Domain URL."}],"url":"\/documentation\/auth0\/authentication\/url"},"https://auth0.com/docs/api/authentication":{"type":"link","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication","title":"Auth0 Authentication API","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authentication/userinfo(withaccesstoken:tokentype:)-i0qu.json b/docs/data/documentation/auth0/authentication/userinfo(withaccesstoken:tokentype:)-i0qu.json index c711e0fb1..49530cb08 100644 --- a/docs/data/documentation/auth0/authentication/userinfo(withaccesstoken:tokentype:)-i0qu.json +++ b/docs/data/documentation/auth0/authentication/userinfo(withaccesstoken:tokentype:)-i0qu.json @@ -1 +1 @@ -{"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/api\/authentication\/user-profile\/get-user-info"],"title":"Related Documentation","anchor":"Related-Documentation"}],"variants":[{"paths":["\/documentation\/auth0\/authentication\/userinfo(withaccesstoken:tokentype:)-i0qu"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/userInfo(withAccessToken:tokenType:)-i0qu","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"userInfo","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withAccessToken","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"accessToken","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"tokenType","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" = \"Bearer\") -> ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","text":"UserInfo","preciseIdentifier":"s:5Auth08UserInfoV","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"platforms":["iOS"]}]},{"parameters":[{"name":"accessToken","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Access token obtained by authenticating the user."}]}]},{"name":"tokenType","content":[{"type":"paragraph","inlineContent":[{"text":"Indicates how the access token should be used. Defaults to ","type":"text"},{"code":"Bearer","type":"codeVoice"},{"text":".","type":"text"}]}]}],"kind":"parameters"},{"content":[{"type":"heading","level":2,"text":"Return Value","anchor":"return-value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A request that will yield user information."}]}],"kind":"content"},{"content":[{"anchor":"Usage","text":"Usage","level":2,"type":"heading"},{"syntax":"swift","code":["Auth0"," .authentication()"," .userInfo(withAccessToken: credentials.accessToken)"," .start { result in"," switch result {"," case .success(let user):"," print(\"Obtained user: \\(user)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"],"type":"codeListing"},{"content":[{"inlineContent":[{"text":"If you’re using DPoP, make sure to set the ","type":"text"},{"code":"tokenType","type":"codeVoice"},{"text":" parameter to ","type":"text"},{"code":"DPoP","type":"codeVoice"},{"text":" instead of ","type":"text"},{"code":"Bearer","type":"codeVoice"},{"text":".","type":"text"},{"text":" ","type":"text"},{"text":"You can simply use the ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/tokenType","isActive":true,"type":"reference"},{"text":" value for this purpose.","type":"text"}],"type":"paragraph"}],"name":"Important","style":"important","type":"aside"}],"kind":"content"}],"metadata":{"symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"userInfo","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withAccessToken","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"tokenType","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth08UserInfoV","text":"UserInfo","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"role":"symbol","externalID":"s:5Auth014AuthenticationPAAE8userInfo15withAccessToken9tokenTypeAA7RequestVyAA04UserD0VAA0B5ErrorVGSS_SStF","extendedModule":"Auth0","modules":[{"name":"Auth0"}],"title":"userInfo(withAccessToken:tokenType:)","roleHeading":"Instance Method"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"text":"Returns OIDC standard claims information by performing a request to the ","type":"text"},{"code":"\/userinfo","type":"codeVoice"},{"text":" endpoint.","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"type":"topic","role":"symbol","title":"Authentication","abstract":[{"text":"Client for the ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"text":".","type":"text"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/userInfo(withAccessToken:tokenType:)-i0qu":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"userInfo","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withAccessToken","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"tokenType","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth08UserInfoV","text":"UserInfo","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"title":"userInfo(withAccessToken:tokenType:)","url":"\/documentation\/auth0\/authentication\/userinfo(withaccesstoken:tokentype:)-i0qu","abstract":[{"type":"text","text":"Returns OIDC standard claims information by performing a request to the "},{"type":"codeVoice","code":"\/userinfo"},{"type":"text","text":" endpoint."}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/userInfo(withAccessToken:tokenType:)-i0qu","role":"symbol","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/tokenType":{"url":"\/documentation\/auth0\/credentials\/tokentype","abstract":[{"text":"Indicates how the access token should be used. For example, as a bearer token.","type":"text"}],"title":"tokenType","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/tokenType","kind":"symbol","type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"tokenType"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}]},"https://auth0.com/docs/api/authentication":{"titleInlineContent":[{"text":"Auth0 Authentication API","type":"text"}],"title":"Auth0 Authentication API","url":"https:\/\/auth0.com\/docs\/api\/authentication","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"},"https://auth0.com/docs/api/authentication/user-profile/get-user-info":{"titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"title":"Authentication API Endpoint","url":"https:\/\/auth0.com\/docs\/api\/authentication\/user-profile\/get-user-info","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/user-profile\/get-user-info"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"text":"UserInfo","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/userinfo","type":"topic","title":"UserInfo","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/request","kind":"symbol","abstract":[{"type":"text","text":"Auth0 API request."}]}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/userinfo(withaccesstoken:tokentype:)-i0qu"]}],"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"},{"type":"text","text":" endpoint."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"userInfo","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withAccessToken","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"accessToken","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"tokenType","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" = \"Bearer\") -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"},{"text":"<","kind":"text"},{"text":"UserInfo","preciseIdentifier":"s:5Auth08UserInfoV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"},{"text":", ","kind":"text"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"},{"text":">","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]},{"parameters":[{"name":"accessToken","content":[{"inlineContent":[{"text":"Access token obtained by authenticating the user.","type":"text"}],"type":"paragraph"}]},{"name":"tokenType","content":[{"inlineContent":[{"text":"Indicates how the access token should be used. Defaults to ","type":"text"},{"code":"Bearer","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"}]}],"kind":"parameters"},{"kind":"content","content":[{"type":"heading","text":"Return Value","anchor":"return-value","level":2},{"type":"paragraph","inlineContent":[{"text":"A request that will yield user information.","type":"text"}]}]},{"kind":"content","content":[{"type":"heading","text":"Usage","anchor":"Usage","level":2},{"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)\")"," }"," }"],"syntax":"swift"},{"type":"aside","name":"Important","style":"important","content":[{"inlineContent":[{"text":"If you’re using DPoP, make sure to set the ","type":"text"},{"code":"tokenType","type":"codeVoice"},{"text":" parameter to ","type":"text"},{"code":"DPoP","type":"codeVoice"},{"text":" instead of ","type":"text"},{"code":"Bearer","type":"codeVoice"},{"text":".","type":"text"},{"text":" ","type":"text"},{"text":"You can simply use the ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/tokenType","type":"reference"},{"text":" value for this purpose.","type":"text"}],"type":"paragraph"}]}]}],"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication\/user-profile\/get-user-info"],"anchor":"Related-Documentation"}],"metadata":{"symbolKind":"method","roleHeading":"Instance Method","externalID":"s:5Auth014AuthenticationPAAE8userInfo15withAccessToken9tokenTypeAA7RequestVyAA04UserD0VAA0B5ErrorVGSS_SStF","extendedModule":"Auth0","title":"userInfo(withAccessToken:tokenType:)","modules":[{"name":"Auth0"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"userInfo","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withAccessToken","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"tokenType","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth08UserInfoV","text":"UserInfo","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"role":"symbol"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/userInfo(withAccessToken:tokenType:)-i0qu"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"},"https://auth0.com/docs/api/authentication/user-profile/get-user-info":{"title":"Authentication API Endpoint","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/user-profile\/get-user-info","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication\/user-profile\/get-user-info"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/userInfo(withAccessToken:tokenType:)-i0qu":{"role":"symbol","title":"userInfo(withAccessToken:tokenType:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"userInfo"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withAccessToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"tokenType"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"UserInfo","preciseIdentifier":"s:5Auth08UserInfoV"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"abstract":[{"type":"text","text":"Returns OIDC standard claims information by performing a request to the "},{"type":"codeVoice","code":"\/userinfo"},{"type":"text","text":" endpoint."}],"kind":"symbol","url":"\/documentation\/auth0\/authentication\/userinfo(withaccesstoken:tokentype:)-i0qu","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/userInfo(withAccessToken:tokenType:)-i0qu","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/tokenType":{"type":"topic","title":"tokenType","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/tokenType","url":"\/documentation\/auth0\/credentials\/tokentype","abstract":[{"text":"Indicates how the access token should be used. For example, as a bearer token.","type":"text"}],"kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"tokenType"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","abstract":[{"type":"text","text":"Client for the "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","isActive":true},{"type":"text","text":"."}],"type":"topic","title":"Authentication","url":"\/documentation\/auth0\/authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"https://auth0.com/docs/api/authentication":{"title":"Auth0 Authentication API","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"title":"Request","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"abstract":[{"text":"Auth0 API request.","type":"text"}],"url":"\/documentation\/auth0\/request","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"title":"UserInfo","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"UserInfo"}],"abstract":[{"text":"OIDC Standard Claims user information.","type":"text"}],"url":"\/documentation\/auth0\/userinfo","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authentication/userinfo(withaccesstoken:tokentype:).json b/docs/data/documentation/auth0/authentication/userinfo(withaccesstoken:tokentype:).json index 1a5c7ea27..53f56b241 100644 --- a/docs/data/documentation/auth0/authentication/userinfo(withaccesstoken:tokentype:).json +++ b/docs/data/documentation/auth0/authentication/userinfo(withaccesstoken:tokentype:).json @@ -1 +1 @@ -{"metadata":{"externalID":"s:5Auth014AuthenticationP8userInfo15withAccessToken9tokenTypeAA7RequestVyAA04UserD0VAA0B5ErrorVGSS_SStF","roleHeading":"Instance Method","symbolKind":"method","role":"symbol","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"userInfo"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withAccessToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"tokenType"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth08UserInfoV","text":"UserInfo"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError"},{"kind":"text","text":">"}],"title":"userInfo(withAccessToken:tokenType:)","required":true},"kind":"symbol","defaultImplementationsSections":[{"anchor":"Authentication-Implementations","title":"Authentication Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/userInfo(withAccessToken:tokenType:)-i0qu"]}],"sections":[],"abstract":[{"text":"Returns OIDC standard claims information by performing a request to the ","type":"text"},{"code":"\/userinfo","type":"codeVoice"},{"text":" endpoint.","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"userInfo"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withAccessToken"},{"kind":"text","text":" "},{"kind":"internalParam","text":"accessToken"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"tokenType"},{"kind":"text","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":"<"},{"preciseIdentifier":"s:5Auth08UserInfoV","kind":"typeIdentifier","text":"UserInfo","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","text":"AuthenticationError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"},{"kind":"text","text":">"}],"platforms":["iOS"]}]},{"kind":"parameters","parameters":[{"name":"accessToken","content":[{"type":"paragraph","inlineContent":[{"text":"Access token obtained by authenticating the user.","type":"text"}]}]},{"name":"tokenType","content":[{"inlineContent":[{"text":"Indicates how the access token should be used. Defaults to ","type":"text"},{"code":"Bearer","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"}]}]},{"kind":"content","content":[{"level":2,"anchor":"return-value","text":"Return Value","type":"heading"},{"inlineContent":[{"text":"A request that will yield user information.","type":"text"}],"type":"paragraph"}]},{"kind":"content","content":[{"level":2,"type":"heading","anchor":"Usage","text":"Usage"},{"syntax":"swift","code":["Auth0"," .authentication()"," .userInfo(withAccessToken: credentials.accessToken)"," .start { result in"," switch result {"," case .success(let user):"," print(\"Obtained user: \\(user)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"],"type":"codeListing"},{"style":"important","name":"Important","type":"aside","content":[{"type":"paragraph","inlineContent":[{"text":"If you’re using DPoP, make sure to set the ","type":"text"},{"code":"tokenType","type":"codeVoice"},{"text":" parameter to ","type":"text"},{"code":"DPoP","type":"codeVoice"},{"text":" instead of ","type":"text"},{"code":"Bearer","type":"codeVoice"},{"text":".","type":"text"},{"text":" ","type":"text"},{"text":"You can simply use the ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/tokenType","isActive":true,"type":"reference"},{"text":" value for this purpose.","type":"text"}]}]}]}],"seeAlsoSections":[{"anchor":"Related-Documentation","title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication\/user-profile\/get-user-info"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"variants":[{"paths":["\/documentation\/auth0\/authentication\/userinfo(withaccesstoken:tokentype:)"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/userInfo(withAccessToken:tokenType:)","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/userInfo(withAccessToken:tokenType:)-i0qu":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"userInfo","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withAccessToken","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"tokenType","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth08UserInfoV","text":"UserInfo","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"title":"userInfo(withAccessToken:tokenType:)","url":"\/documentation\/auth0\/authentication\/userinfo(withaccesstoken:tokentype:)-i0qu","abstract":[{"type":"text","text":"Returns OIDC standard claims information by performing a request to the "},{"type":"codeVoice","code":"\/userinfo"},{"type":"text","text":" endpoint."}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/userInfo(withAccessToken:tokenType:)-i0qu","role":"symbol","kind":"symbol"},"https://auth0.com/docs/api/authentication":{"type":"link","titleInlineContent":[{"text":"Auth0 Authentication API","type":"text"}],"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","url":"https:\/\/auth0.com\/docs\/api\/authentication","title":"Auth0 Authentication API"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/userInfo(withAccessToken:tokenType:)":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"userInfo","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withAccessToken","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"tokenType","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth08UserInfoV","text":"UserInfo","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"abstract":[{"type":"text","text":"Returns OIDC standard claims information by performing a request to the "},{"type":"codeVoice","code":"\/userinfo"},{"type":"text","text":" endpoint."}],"url":"\/documentation\/auth0\/authentication\/userinfo(withaccesstoken:tokentype:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/userInfo(withAccessToken:tokenType:)","title":"userInfo(withAccessToken:tokenType:)","role":"symbol","kind":"symbol","type":"topic","defaultImplementations":1,"required":true},"https://auth0.com/docs/api/authentication/user-profile/get-user-info":{"type":"link","titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}],"identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/user-profile\/get-user-info","url":"https:\/\/auth0.com\/docs\/api\/authentication\/user-profile\/get-user-info","title":"Authentication API Endpoint"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"type":"topic","role":"symbol","title":"Authentication","abstract":[{"text":"Client for the ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"text":".","type":"text"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"text":"UserInfo","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/userinfo","type":"topic","title":"UserInfo","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/request","kind":"symbol","abstract":[{"type":"text","text":"Auth0 API request."}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/tokenType":{"url":"\/documentation\/auth0\/credentials\/tokentype","abstract":[{"text":"Indicates how the access token should be used. For example, as a bearer token.","type":"text"}],"title":"tokenType","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/tokenType","kind":"symbol","type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"tokenType"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}]}}} \ No newline at end of file +{"sections":[],"defaultImplementationsSections":[{"title":"Authentication Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/userInfo(withAccessToken:tokenType:)-i0qu"],"anchor":"Authentication-Implementations"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/userInfo(withAccessToken:tokenType:)","interfaceLanguage":"swift"},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"userInfo"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withAccessToken"},{"kind":"text","text":" "},{"kind":"internalParam","text":"accessToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"tokenType","kind":"externalParam"},{"text":": ","kind":"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:5Auth08UserInfoV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","kind":"typeIdentifier","text":"UserInfo"},{"text":", ","kind":"text"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"},{"text":">","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"accessToken","content":[{"inlineContent":[{"type":"text","text":"Access token obtained by authenticating the user."}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Indicates how the access token should be used. Defaults to "},{"type":"codeVoice","code":"Bearer"},{"type":"text","text":"."}]}],"name":"tokenType"}]},{"content":[{"anchor":"return-value","text":"Return Value","type":"heading","level":2},{"inlineContent":[{"text":"A request that will yield user information.","type":"text"}],"type":"paragraph"}],"kind":"content"},{"content":[{"anchor":"Usage","text":"Usage","type":"heading","level":2},{"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)\")"," }"," }"]},{"type":"aside","name":"Important","content":[{"inlineContent":[{"text":"If you’re using DPoP, make sure to set the ","type":"text"},{"code":"tokenType","type":"codeVoice"},{"text":" parameter to ","type":"text"},{"code":"DPoP","type":"codeVoice"},{"text":" instead of ","type":"text"},{"code":"Bearer","type":"codeVoice"},{"text":".","type":"text"},{"text":" ","type":"text"},{"text":"You can simply use the ","type":"text"},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/tokenType"},{"text":" value for this purpose.","type":"text"}],"type":"paragraph"}],"style":"important"}],"kind":"content"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authentication\/userinfo(withaccesstoken:tokentype:)"]}],"kind":"symbol","metadata":{"modules":[{"name":"Auth0"}],"title":"userInfo(withAccessToken:tokenType:)","externalID":"s:5Auth014AuthenticationP8userInfo15withAccessToken9tokenTypeAA7RequestVyAA04UserD0VAA0B5ErrorVGSS_SStF","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"userInfo","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withAccessToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"tokenType"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"UserInfo","preciseIdentifier":"s:5Auth08UserInfoV"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"roleHeading":"Instance Method","symbolKind":"method","required":true},"schemaVersion":{"patch":0,"major":0,"minor":3},"abstract":[{"type":"text","text":"Returns OIDC standard claims information by performing a request to the "},{"code":"\/userinfo","type":"codeVoice"},{"text":" endpoint.","type":"text"}],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication\/user-profile\/get-user-info"],"anchor":"Related-Documentation"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/tokenType":{"type":"topic","title":"tokenType","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/tokenType","url":"\/documentation\/auth0\/credentials\/tokentype","abstract":[{"text":"Indicates how the access token should be used. For example, as a bearer token.","type":"text"}],"kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"tokenType"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"title":"UserInfo","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"UserInfo"}],"abstract":[{"text":"OIDC Standard Claims user information.","type":"text"}],"url":"\/documentation\/auth0\/userinfo","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"https://auth0.com/docs/api/authentication":{"title":"Auth0 Authentication API","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","abstract":[{"type":"text","text":"Client for the "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","isActive":true},{"type":"text","text":"."}],"type":"topic","title":"Authentication","url":"\/documentation\/auth0\/authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"title":"Request","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"abstract":[{"text":"Auth0 API request.","type":"text"}],"url":"\/documentation\/auth0\/request","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/userInfo(withAccessToken:tokenType:)":{"role":"symbol","title":"userInfo(withAccessToken:tokenType:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"userInfo"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withAccessToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"tokenType"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"UserInfo","preciseIdentifier":"s:5Auth08UserInfoV"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"abstract":[{"type":"text","text":"Returns OIDC standard claims information by performing a request to the "},{"type":"codeVoice","code":"\/userinfo"},{"type":"text","text":" endpoint."}],"kind":"symbol","defaultImplementations":1,"url":"\/documentation\/auth0\/authentication\/userinfo(withaccesstoken:tokentype:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/userInfo(withAccessToken:tokenType:)","required":true,"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/userInfo(withAccessToken:tokenType:)-i0qu":{"role":"symbol","title":"userInfo(withAccessToken:tokenType:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"userInfo"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withAccessToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"tokenType"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"UserInfo","preciseIdentifier":"s:5Auth08UserInfoV"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"kind":"text","text":">"}],"abstract":[{"type":"text","text":"Returns OIDC standard claims information by performing a request to the "},{"type":"codeVoice","code":"\/userinfo"},{"type":"text","text":" endpoint."}],"kind":"symbol","url":"\/documentation\/auth0\/authentication\/userinfo(withaccesstoken:tokentype:)-i0qu","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/userInfo(withAccessToken:tokenType:)-i0qu","type":"topic"},"https://auth0.com/docs/api/authentication/user-profile/get-user-info":{"title":"Authentication API Endpoint","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication\/user-profile\/get-user-info","identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/user-profile\/get-user-info","type":"link"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authenticationerror.json b/docs/data/documentation/auth0/authenticationerror.json index 64f67227b..64d70ea5c 100644 --- a/docs/data/documentation/auth0/authenticationerror.json +++ b/docs/data/documentation/auth0/authenticationerror.json @@ -1 +1 @@ -{"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","interfaceLanguage":"swift"},"metadata":{"roleHeading":"Structure","externalID":"s:5Auth019AuthenticationErrorV","symbolKind":"struct","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"role":"symbol","modules":[{"name":"Auth0"}],"navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}]},"topicSections":[{"title":"Initializers","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/init(info:statusCode:)"],"generated":true,"anchor":"Initializers"},{"title":"Instance Properties","identifiers":["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\/isDPoPNonceRequired","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\/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"],"generated":true,"anchor":"Instance-Properties"},{"title":"Default Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/Auth0APIError-Implementations","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,"anchor":"Default-Implementations"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"kind":"symbol","relationshipsSections":[{"type":"conformsTo","title":"Conforms To","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","doc:\/\/com.auth0.Auth0\/10Foundation14LocalizedErrorP","doc:\/\/com.auth0.Auth0\/s8CopyableP","doc:\/\/com.auth0.Auth0\/s28CustomDebugStringConvertibleP","doc:\/\/com.auth0.Auth0\/SQ","doc:\/\/com.auth0.Auth0\/s5ErrorP","doc:\/\/com.auth0.Auth0\/s8SendableP","doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP"],"kind":"relationships"}],"schemaVersion":{"minor":3,"major":0,"patch":0},"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#errors"],"anchor":"Related-Documentation"}],"primaryContentSections":[{"declarations":[{"tokens":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationError","kind":"identifier"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"variants":[{"paths":["\/documentation\/auth0\/authenticationerror"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isInvalidRefreshToken":{"url":"\/documentation\/auth0\/authenticationerror\/isinvalidrefreshtoken","role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isInvalidRefreshToken","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isInvalidRefreshToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"abstract":[{"type":"text","text":"When the provided refresh token is invalid or expired."}],"kind":"symbol","title":"isInvalidRefreshToken"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/Equatable-Implementations":{"kind":"article","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/Equatable-Implementations","url":"\/documentation\/auth0\/authenticationerror\/equatable-implementations","role":"collectionGroup","type":"topic","abstract":[],"title":"Equatable Implementations"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isLoginRequired":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isLoginRequired","abstract":[{"type":"text","text":"When performing Web Auth login with "},{"type":"codeVoice","code":"prompt: \"none\""},{"type":"text","text":" and the Auth0 session has expired."}],"title":"isLoginRequired","url":"\/documentation\/auth0\/authenticationerror\/isloginrequired","kind":"symbol","type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isLoginRequired"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/Auth0Error-Implementations":{"type":"topic","kind":"article","title":"Auth0Error Implementations","abstract":[],"role":"collectionGroup","url":"\/documentation\/auth0\/authenticationerror\/auth0error-implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/Auth0Error-Implementations"},"https://auth0.com/docs/api/authentication#errors":{"url":"https:\/\/auth0.com\/docs\/api\/authentication#errors","title":"Authentication API Errors","type":"link","titleInlineContent":[{"type":"text","text":"Authentication API Errors"}],"identifier":"https:\/\/auth0.com\/docs\/api\/authentication#errors"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error":{"url":"\/documentation\/auth0\/auth0error","title":"Auth0Error","kind":"symbol","type":"topic","abstract":[{"type":"text","text":"Generic representation of Auth0 errors."}],"role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Auth0Error"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","navigatorTitle":[{"kind":"identifier","text":"Auth0Error"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/statusCode":{"type":"topic","abstract":[{"type":"text","text":"HTTP status code of the response."}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"statusCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/statusCode","kind":"symbol","url":"\/documentation\/auth0\/authenticationerror\/statuscode","title":"statusCode","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorRequired":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired","type":"topic","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isMultifactorRequired","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror\/ismultifactorrequired","abstract":[{"text":"When MFA is required to authenticate.","type":"text"}],"title":"isMultifactorRequired"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/debugDescription":{"kind":"symbol","role":"symbol","type":"topic","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"debugDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"title":"debugDescription","abstract":[{"text":"Description of the error.","type":"text"}],"url":"\/documentation\/auth0\/authenticationerror\/debugdescription","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/debugDescription"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isRuleError":{"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror\/isruleerror","title":"isRuleError","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isRuleError","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isRuleError","abstract":[{"type":"text","text":"When an Auth0 rule returns an error."},{"type":"text","text":" "},{"type":"text","text":"The message returned by the rule is available in "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/localizedDescription","type":"reference","isActive":true},{"type":"text","text":"."}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/init(info:statusCode:)":{"type":"topic","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"info"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"statusCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"kind":"text","text":")"}],"role":"symbol","abstract":[{"text":"Creates an error from a JSON response.","type":"text"}],"url":"\/documentation\/auth0\/authenticationerror\/init(info:statuscode:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/init(info:statusCode:)","kind":"symbol","title":"init(info:statusCode:)"},"doc://com.auth0.Auth0/s28CustomDebugStringConvertibleP":{"identifier":"doc:\/\/com.auth0.Auth0\/s28CustomDebugStringConvertibleP","title":"Swift.CustomDebugStringConvertible","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/code":{"type":"topic","abstract":[{"type":"text","text":"Error code."}],"kind":"symbol","title":"code","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/code","url":"\/documentation\/auth0\/authenticationerror\/code","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"code","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isPasswordAlreadyUsed":{"url":"\/documentation\/auth0\/authenticationerror\/ispasswordalreadyused","abstract":[{"text":"When the password used for signup was already used before. This is reported when the Password History feature","type":"text"},{"text":" ","type":"text"},{"text":"is enabled.","type":"text"},{"text":" ","type":"text"},{"text":"Additional information is available in the ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/info","type":"reference","isActive":true},{"text":" dictionary.","type":"text"}],"title":"isPasswordAlreadyUsed","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isPasswordAlreadyUsed","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isPasswordAlreadyUsed","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/Auth0APIError-Implementations":{"url":"\/documentation\/auth0\/authenticationerror\/auth0apierror-implementations","abstract":[],"title":"Auth0APIError Implementations","kind":"article","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/Auth0APIError-Implementations","role":"collectionGroup","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/LocalizedError-Implementations":{"url":"\/documentation\/auth0\/authenticationerror\/localizederror-implementations","abstract":[],"title":"LocalizedError Implementations","kind":"article","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/LocalizedError-Implementations","role":"collectionGroup","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/info":{"url":"\/documentation\/auth0\/authenticationerror\/info","kind":"symbol","abstract":[{"type":"text","text":"Raw error values."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/info","title":"info","type":"topic","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"info","kind":"identifier"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"]","kind":"text"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isDPoPNonceRequired":{"type":"topic","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isDPoPNonceRequired"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"url":"\/documentation\/auth0\/authenticationerror\/isdpopnoncerequired","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isDPoPNonceRequired","role":"symbol","abstract":[{"text":"When a nonce must be included in the DPoP proof. The Authentication API client will retry the request ","type":"text"},{"inlineContent":[{"type":"text","text":"once"}],"type":"emphasis"},{"text":" ","type":"text"},{"text":"when a nonce is required by Auth0, but subsequent failures must be handled by the app.","type":"text"}],"title":"isDPoPNonceRequired","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorCodeInvalid":{"type":"topic","abstract":[{"type":"text","text":"When the MFA code sent is invalid or expired."}],"role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isMultifactorCodeInvalid"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"url":"\/documentation\/auth0\/authenticationerror\/ismultifactorcodeinvalid","title":"isMultifactorCodeInvalid","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorCodeInvalid"},"doc://com.auth0.Auth0/s8SendableP":{"identifier":"doc:\/\/com.auth0.Auth0\/s8SendableP","title":"Swift.Sendable","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isVerificationRequired":{"abstract":[{"type":"text","text":"When an additional verification step is required."}],"url":"\/documentation\/auth0\/authenticationerror\/isverificationrequired","type":"topic","title":"isVerificationRequired","kind":"symbol","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isVerificationRequired","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isVerificationRequired"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}]},"doc://com.auth0.Auth0/s5ErrorP":{"identifier":"doc:\/\/com.auth0.Auth0\/s5ErrorP","title":"Swift.Error","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isInvalidCredentials":{"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isInvalidCredentials","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isInvalidCredentials","type":"topic","abstract":[{"text":"When the username and\/or password used for authentication are invalid.","type":"text"}],"title":"isInvalidCredentials","kind":"symbol","role":"symbol","url":"\/documentation\/auth0\/authenticationerror\/isinvalidcredentials"},"doc://com.auth0.Auth0/s16SendableMetatypeP":{"identifier":"doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP","title":"Swift.SendableMetatype","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorTokenInvalid":{"type":"topic","abstract":[{"type":"text","text":"When the MFA token is invalid or expired."}],"role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isMultifactorTokenInvalid"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"url":"\/documentation\/auth0\/authenticationerror\/ismultifactortokeninvalid","title":"isMultifactorTokenInvalid","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorTokenInvalid"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","type":"topic","url":"\/documentation\/auth0\/auth0apierror","title":"Auth0APIError","abstract":[{"type":"text","text":"Generic representation of Auth0 API errors."}],"role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Auth0APIError","kind":"identifier"}],"kind":"symbol","navigatorTitle":[{"text":"Auth0APIError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isAccessDenied":{"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isAccessDenied"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"title":"isAccessDenied","kind":"symbol","type":"topic","abstract":[{"type":"text","text":"When Auth0 denies access due to some misconfiguration or an error in an Action or Rule."}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isAccessDenied","url":"\/documentation\/auth0\/authenticationerror\/isaccessdenied"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isPasswordNotStrongEnough":{"title":"isPasswordNotStrongEnough","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isPasswordNotStrongEnough","abstract":[{"type":"text","text":"When the password used for signup does not match the strength requirements of the connection."},{"type":"text","text":" "},{"type":"text","text":"Additional information is available in the "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/info","isActive":true},{"type":"text","text":" dictionary."}],"url":"\/documentation\/auth0\/authenticationerror\/ispasswordnotstrongenough","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isPasswordNotStrongEnough"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/s8CopyableP":{"identifier":"doc:\/\/com.auth0.Auth0\/s8CopyableP","title":"Swift.Copyable","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isTooManyAttempts":{"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isTooManyAttempts"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"type":"topic","title":"isTooManyAttempts","url":"\/documentation\/auth0\/authenticationerror\/istoomanyattempts","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isTooManyAttempts","abstract":[{"type":"text","text":"When the user is blocked due to too many attempts to log in."}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorEnrollRequired":{"role":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isMultifactorEnrollRequired"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"abstract":[{"text":"When MFA is required and the user is not enrolled.","type":"text"}],"url":"\/documentation\/auth0\/authenticationerror\/ismultifactorenrollrequired","title":"isMultifactorEnrollRequired","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorEnrollRequired"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isPasswordLeaked":{"url":"\/documentation\/auth0\/authenticationerror\/ispasswordleaked","type":"topic","title":"isPasswordLeaked","role":"symbol","kind":"symbol","abstract":[{"type":"text","text":"When the password used was reported to be leaked."}],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isPasswordLeaked"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isPasswordLeaked"},"doc://com.auth0.Auth0/10Foundation14LocalizedErrorP":{"identifier":"doc:\/\/com.auth0.Auth0\/10Foundation14LocalizedErrorP","title":"Foundation.LocalizedError","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isRefreshTokenDeleted":{"title":"isRefreshTokenDeleted","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isRefreshTokenDeleted"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isRefreshTokenDeleted","url":"\/documentation\/auth0\/authenticationerror\/isrefreshtokendeleted","kind":"symbol","abstract":[{"type":"text","text":"When the credentials renewal fails because the user was deleted."}],"role":"symbol"},"doc://com.auth0.Auth0/SQ":{"identifier":"doc:\/\/com.auth0.Auth0\/SQ","title":"Swift.Equatable","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/localizedDescription":{"type":"topic","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"localizedDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/localizedDescription","role":"symbol","url":"\/documentation\/auth0\/auth0error\/localizeddescription","title":"localizedDescription","abstract":[{"text":"Description of the error.","type":"text"}],"kind":"symbol"}}} \ No newline at end of file +{"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"languages":["swift"],"platforms":["iOS"]}]}],"relationshipsSections":[{"title":"Conforms To","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","doc:\/\/com.auth0.Auth0\/10Foundation14LocalizedErrorP","doc:\/\/com.auth0.Auth0\/s8CopyableP","doc:\/\/com.auth0.Auth0\/s28CustomDebugStringConvertibleP","doc:\/\/com.auth0.Auth0\/SQ","doc:\/\/com.auth0.Auth0\/s5ErrorP","doc:\/\/com.auth0.Auth0\/s8SendableP","doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP"],"kind":"relationships","type":"conformsTo"}],"topicSections":[{"title":"Initializers","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/init(info:statusCode:)"],"anchor":"Initializers","generated":true},{"title":"Instance Properties","identifiers":["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\/isDPoPNonceRequired","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\/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\/message","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/statusCode"],"anchor":"Instance-Properties","generated":true},{"title":"Default Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/Auth0APIError-Implementations","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"],"anchor":"Default-Implementations","generated":true}],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/authentication#errors"],"anchor":"Related-Documentation"}],"sections":[],"schemaVersion":{"minor":3,"patch":0,"major":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"abstract":[{"text":"Represents an error during a request to the Auth0 Authentication API.","type":"text"}],"variants":[{"paths":["\/documentation\/auth0\/authenticationerror"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"roleHeading":"Structure","navigatorTitle":[{"text":"AuthenticationError","kind":"identifier"}],"symbolKind":"struct","title":"AuthenticationError","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"externalID":"s:5Auth019AuthenticationErrorV","modules":[{"name":"Auth0"}]},"references":{"doc://com.auth0.Auth0/s5ErrorP":{"title":"Swift.Error","identifier":"doc:\/\/com.auth0.Auth0\/s5ErrorP","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/message":{"kind":"symbol","title":"message","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"message"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/message","abstract":[],"url":"\/documentation\/auth0\/authenticationerror\/message"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isRuleError":{"kind":"symbol","title":"isRuleError","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isRuleError"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isRuleError","abstract":[{"text":"When an Auth0 rule returns an error.","type":"text"},{"text":" ","type":"text"},{"text":"The message returned by the rule is available in ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/localizedDescription","type":"reference"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/authenticationerror\/isruleerror"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/debugDescription":{"kind":"symbol","title":"debugDescription","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"debugDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/debugDescription","abstract":[{"text":"Description of the error.","type":"text"}],"url":"\/documentation\/auth0\/authenticationerror\/debugdescription"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isPasswordNotStrongEnough":{"kind":"symbol","title":"isPasswordNotStrongEnough","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isPasswordNotStrongEnough"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isPasswordNotStrongEnough","abstract":[{"text":"When the password used for signup does not match the strength requirements of the connection.","type":"text"},{"text":" ","type":"text"},{"text":"Additional information is available in the ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/info","type":"reference"},{"text":" dictionary.","type":"text"}],"url":"\/documentation\/auth0\/authenticationerror\/ispasswordnotstrongenough"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorTokenInvalid":{"kind":"symbol","title":"isMultifactorTokenInvalid","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isMultifactorTokenInvalid"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorTokenInvalid","abstract":[{"text":"When the MFA token is invalid or expired.","type":"text"}],"url":"\/documentation\/auth0\/authenticationerror\/ismultifactortokeninvalid"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isInvalidRefreshToken":{"type":"topic","title":"isInvalidRefreshToken","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isInvalidRefreshToken","kind":"symbol","url":"\/documentation\/auth0\/authenticationerror\/isinvalidrefreshtoken","abstract":[{"type":"text","text":"When the provided refresh token is invalid or expired."}],"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isInvalidRefreshToken"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}]},"doc://com.auth0.Auth0/SQ":{"title":"Swift.Equatable","identifier":"doc:\/\/com.auth0.Auth0\/SQ","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isVerificationRequired":{"kind":"symbol","title":"isVerificationRequired","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isVerificationRequired"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isVerificationRequired","abstract":[{"text":"When an additional verification step is required.","type":"text"}],"url":"\/documentation\/auth0\/authenticationerror\/isverificationrequired"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/LocalizedError-Implementations":{"kind":"article","title":"LocalizedError Implementations","role":"collectionGroup","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/LocalizedError-Implementations","abstract":[],"url":"\/documentation\/auth0\/authenticationerror\/localizederror-implementations"},"doc://com.auth0.Auth0/s16SendableMetatypeP":{"title":"Swift.SendableMetatype","identifier":"doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/statusCode":{"kind":"symbol","title":"statusCode","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"statusCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/statusCode","abstract":[{"text":"HTTP status code of the response.","type":"text"}],"url":"\/documentation\/auth0\/authenticationerror\/statuscode"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isDPoPNonceRequired":{"kind":"symbol","abstract":[{"type":"text","text":"When a nonce must be included in the DPoP proof. The Authentication API client will retry the request "},{"type":"emphasis","inlineContent":[{"type":"text","text":"once"}]},{"type":"text","text":" "},{"type":"text","text":"when a nonce is required by Auth0, but subsequent failures must be handled by the app."}],"type":"topic","url":"\/documentation\/auth0\/authenticationerror\/isdpopnoncerequired","title":"isDPoPNonceRequired","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isDPoPNonceRequired"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isDPoPNonceRequired"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isRefreshTokenDeleted":{"kind":"symbol","title":"isRefreshTokenDeleted","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isRefreshTokenDeleted"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isRefreshTokenDeleted","abstract":[{"text":"When the credentials renewal fails because the user was deleted.","type":"text"}],"url":"\/documentation\/auth0\/authenticationerror\/isrefreshtokendeleted"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/code":{"title":"code","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/code","role":"symbol","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"code","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"abstract":[{"text":"Error code.","type":"text"}],"url":"\/documentation\/auth0\/authenticationerror\/code"},"doc://com.auth0.Auth0/10Foundation14LocalizedErrorP":{"title":"Foundation.LocalizedError","identifier":"doc:\/\/com.auth0.Auth0\/10Foundation14LocalizedErrorP","type":"unresolvable"},"doc://com.auth0.Auth0/s28CustomDebugStringConvertibleP":{"title":"Swift.CustomDebugStringConvertible","identifier":"doc:\/\/com.auth0.Auth0\/s28CustomDebugStringConvertibleP","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isInvalidCredentials":{"type":"topic","abstract":[{"text":"When the username and\/or password used for authentication are invalid.","type":"text"}],"title":"isInvalidCredentials","kind":"symbol","url":"\/documentation\/auth0\/authenticationerror\/isinvalidcredentials","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isInvalidCredentials"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isInvalidCredentials"},"https://auth0.com/docs/api/authentication#errors":{"title":"Authentication API Errors","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#errors","titleInlineContent":[{"text":"Authentication API Errors","type":"text"}],"type":"link","url":"https:\/\/auth0.com\/docs\/api\/authentication#errors"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/Auth0APIError-Implementations":{"kind":"article","title":"Auth0APIError Implementations","role":"collectionGroup","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/Auth0APIError-Implementations","abstract":[],"url":"\/documentation\/auth0\/authenticationerror\/auth0apierror-implementations"},"doc://com.auth0.Auth0/s8CopyableP":{"title":"Swift.Copyable","identifier":"doc:\/\/com.auth0.Auth0\/s8CopyableP","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError":{"url":"\/documentation\/auth0\/auth0apierror","abstract":[{"type":"text","text":"Generic representation of Auth0 API errors."}],"title":"Auth0APIError","navigatorTitle":[{"kind":"identifier","text":"Auth0APIError"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Auth0APIError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/Auth0Error-Implementations":{"kind":"article","title":"Auth0Error Implementations","role":"collectionGroup","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/Auth0Error-Implementations","abstract":[],"url":"\/documentation\/auth0\/authenticationerror\/auth0error-implementations"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isTooManyAttempts":{"type":"topic","title":"isTooManyAttempts","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isTooManyAttempts","kind":"symbol","url":"\/documentation\/auth0\/authenticationerror\/istoomanyattempts","abstract":[{"type":"text","text":"When the user is blocked due to too many attempts to log in."}],"role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isTooManyAttempts","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorRequired":{"type":"topic","title":"isMultifactorRequired","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired","kind":"symbol","url":"\/documentation\/auth0\/authenticationerror\/ismultifactorrequired","abstract":[{"type":"text","text":"When MFA is required to authenticate."}],"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isMultifactorRequired"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorCodeInvalid":{"title":"isMultifactorCodeInvalid","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorCodeInvalid","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isMultifactorCodeInvalid"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"abstract":[{"text":"When the MFA code sent is invalid or expired.","type":"text"}],"url":"\/documentation\/auth0\/authenticationerror\/ismultifactorcodeinvalid"},"doc://com.auth0.Auth0/s8SendableP":{"title":"Swift.Sendable","identifier":"doc:\/\/com.auth0.Auth0\/s8SendableP","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isPasswordAlreadyUsed":{"kind":"symbol","title":"isPasswordAlreadyUsed","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isPasswordAlreadyUsed"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isPasswordAlreadyUsed","abstract":[{"text":"When the password used for signup was already used before. This is reported when the Password History feature","type":"text"},{"text":" ","type":"text"},{"text":"is enabled.","type":"text"},{"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"},{"text":" dictionary.","type":"text"}],"url":"\/documentation\/auth0\/authenticationerror\/ispasswordalreadyused"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorEnrollRequired":{"type":"topic","title":"isMultifactorEnrollRequired","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorEnrollRequired","url":"\/documentation\/auth0\/authenticationerror\/ismultifactorenrollrequired","abstract":[{"type":"text","text":"When MFA is required and the user is not enrolled."}],"kind":"symbol","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"isMultifactorEnrollRequired"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/init(info:statusCode:)":{"url":"\/documentation\/auth0\/authenticationerror\/init(info:statuscode:)","abstract":[{"text":"Creates an error from a JSON response.","type":"text"}],"title":"init(info:statusCode:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"info"},{"kind":"text","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":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"kind":"text","text":")"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/init(info:statusCode:)","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/localizedDescription":{"kind":"symbol","title":"localizedDescription","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"localizedDescription"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/localizedDescription","abstract":[{"type":"text","text":"Description of the error."}],"url":"\/documentation\/auth0\/auth0error\/localizeddescription"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/info":{"kind":"symbol","abstract":[{"type":"text","text":"Raw error values."}],"type":"topic","url":"\/documentation\/auth0\/authenticationerror\/info","title":"info","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"info"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/info"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error":{"url":"\/documentation\/auth0\/auth0error","title":"Auth0Error","abstract":[{"type":"text","text":"Generic representation of Auth0 errors."}],"navigatorTitle":[{"kind":"identifier","text":"Auth0Error"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Auth0Error"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isLoginRequired":{"kind":"symbol","title":"isLoginRequired","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isLoginRequired"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isLoginRequired","abstract":[{"type":"text","text":"When performing Web Auth login with "},{"code":"prompt: \"none\"","type":"codeVoice"},{"type":"text","text":" and the Auth0 session has expired."}],"url":"\/documentation\/auth0\/authenticationerror\/isloginrequired"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isAccessDenied":{"kind":"symbol","title":"isAccessDenied","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isAccessDenied"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isAccessDenied","abstract":[{"text":"When Auth0 denies access due to some misconfiguration or an error in an Action or Rule.","type":"text"}],"url":"\/documentation\/auth0\/authenticationerror\/isaccessdenied"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/Equatable-Implementations":{"type":"topic","abstract":[],"title":"Equatable Implementations","kind":"article","url":"\/documentation\/auth0\/authenticationerror\/equatable-implementations","role":"collectionGroup","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/Equatable-Implementations"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isPasswordLeaked":{"type":"topic","abstract":[{"text":"When the password used was reported to be leaked.","type":"text"}],"title":"isPasswordLeaked","kind":"symbol","url":"\/documentation\/auth0\/authenticationerror\/ispasswordleaked","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isPasswordLeaked"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isPasswordLeaked"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authenticationerror/!=(_:_:).json b/docs/data/documentation/auth0/authenticationerror/!=(_:_:).json index 7d0cf611a..80fe4fed0 100644 --- a/docs/data/documentation/auth0/authenticationerror/!=(_:_:).json +++ b/docs/data/documentation/auth0/authenticationerror/!=(_:_:).json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/!=(_:_:)"},"sections":[],"abstract":[{"text":"Inherited from ","type":"text"},{"code":"Equatable.!=(_:_:)","type":"codeVoice"},{"text":".","type":"text"}],"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"!="},{"kind":"text","text":" "},{"kind":"text","text":"("},{"kind":"internalParam","text":"lhs"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":", "},{"kind":"internalParam","text":"rhs"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"platforms":["iOS"]}]}],"variants":[{"paths":["\/documentation\/auth0\/authenticationerror\/!=(_:_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"externalID":"s:SQsE2neoiySbx_xtFZ::SYNTHESIZED::s:5Auth019AuthenticationErrorV","title":"!=(_:_:)","modules":[{"name":"Auth0","relatedModules":["Swift"]}],"symbolKind":"op","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"role":"symbol","extendedModule":"Swift","roleHeading":"Operator"},"schemaVersion":{"minor":3,"patch":0,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/!=(_:_:)":{"role":"symbol","type":"topic","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/!=(_:_:)","title":"!=(_:_:)","url":"\/documentation\/auth0\/authenticationerror\/!=(_:_:)","kind":"symbol","abstract":[]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"lhs","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"rhs","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}]}],"kind":"declarations"}],"sections":[],"abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"Equatable.!=(_:_:)"},{"type":"text","text":"."}],"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/authenticationerror\/!=(_:_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"role":"symbol","title":"!=(_:_:)","modules":[{"relatedModules":["Swift"],"name":"Auth0"}],"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","text":"Self"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"externalID":"s:SQsE2neoiySbx_xtFZ::SYNTHESIZED::s:5Auth019AuthenticationErrorV","extendedModule":"Swift","roleHeading":"Operator","symbolKind":"op"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/!=(_:_:)","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/!=(_:_:)":{"kind":"symbol","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","text":"Self"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"title":"!=(_:_:)","type":"topic","role":"symbol","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/!=(_:_:)","url":"\/documentation\/auth0\/authenticationerror\/!=(_:_:)"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authenticationerror/==(_:_:).json b/docs/data/documentation/auth0/authenticationerror/==(_:_:).json index 73ad40061..4cb494121 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":"Conformance to ","type":"text"},{"code":"Equatable","type":"codeVoice"},{"text":".","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"==","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"lhs","kind":"internalParam"},{"text":": ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":", ","kind":"text"},{"text":"rhs","kind":"internalParam"},{"text":": ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"platforms":["iOS"]}]}],"metadata":{"fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"==","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":", ","kind":"text"},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"role":"symbol","externalID":"s:5Auth019AuthenticationErrorV2eeoiySbAC_ACtFZ","symbolKind":"op","extendedModule":"Auth0","modules":[{"name":"Auth0"}],"roleHeading":"Operator","title":"==(_:_:)"},"schemaVersion":{"minor":3,"major":0,"patch":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/==(_:_:)","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"sections":[],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/==(_:_:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/==(_:_:)","abstract":[{"type":"text","text":"Conformance to "},{"type":"codeVoice","code":"Equatable"},{"type":"text","text":"."}],"type":"topic","url":"\/documentation\/auth0\/authenticationerror\/==(_:_:)","title":"==(_:_:)","role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"==","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":", ","kind":"text"},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"kind":"symbol"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"metadata":{"extendedModule":"Auth0","symbolKind":"op","modules":[{"name":"Auth0"}],"title":"==(_:_:)","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"=="},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"externalID":"s:5Auth019AuthenticationErrorV2eeoiySbAC_ACtFZ","role":"symbol","roleHeading":"Operator"},"sections":[],"abstract":[{"type":"text","text":"Conformance to "},{"type":"codeVoice","code":"Equatable"},{"type":"text","text":"."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/==(_:_:)"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/==(_:_:)"},"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"=="},{"text":" ","kind":"text"},{"kind":"text","text":"("},{"text":"lhs","kind":"internalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","text":"AuthenticationError","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"},{"kind":"text","text":", "},{"kind":"internalParam","text":"rhs"},{"text":": ","kind":"text"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"},{"text":") -> ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/==(_:_:)":{"kind":"symbol","title":"==(_:_:)","role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"==","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/==(_:_:)","abstract":[{"type":"text","text":"Conformance to "},{"type":"codeVoice","code":"Equatable"},{"type":"text","text":"."}],"url":"\/documentation\/auth0\/authenticationerror\/==(_:_:)"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authenticationerror/auth0apierror-implementations.json b/docs/data/documentation/auth0/authenticationerror/auth0apierror-implementations.json index 6a122efad..bffa69226 100644 --- a/docs/data/documentation/auth0/authenticationerror/auth0apierror-implementations.json +++ b/docs/data/documentation/auth0/authenticationerror/auth0apierror-implementations.json @@ -1 +1 @@ -{"metadata":{"modules":[{"name":"Auth0"}],"title":"Auth0APIError Implementations","role":"collectionGroup","roleHeading":"API Collection"},"sections":[],"schemaVersion":{"minor":3,"patch":0,"major":0},"topicSections":[{"generated":true,"title":"Instance Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/cause","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isNetworkError"],"anchor":"Instance-Properties"}],"kind":"article","variants":[{"paths":["\/documentation\/auth0\/authenticationerror\/auth0apierror-implementations"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/Auth0APIError-Implementations","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/isNetworkError":{"title":"isNetworkError","role":"symbol","url":"\/documentation\/auth0\/authenticationerror\/isnetworkerror","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isNetworkError","abstract":[{"type":"text","text":"Whether the request failed due to network issues."}],"type":"topic","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isNetworkError","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"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 "},{"code":"nil","type":"codeVoice"},{"type":"text","text":"."}],"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:s5ErrorP","text":"Error","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/cause","title":"cause","kind":"symbol","role":"symbol","url":"\/documentation\/auth0\/authenticationerror\/cause"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"sections":[],"metadata":{"modules":[{"name":"Auth0"}],"role":"collectionGroup","roleHeading":"API Collection","title":"Auth0APIError Implementations"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/Auth0APIError-Implementations"},"kind":"article","topicSections":[{"generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/cause","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isNetworkError"],"title":"Instance Properties","anchor":"Instance-Properties"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/auth0apierror-implementations"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"schemaVersion":{"patch":0,"minor":3,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isNetworkError":{"type":"topic","title":"isNetworkError","url":"\/documentation\/auth0\/authenticationerror\/isnetworkerror","kind":"symbol","abstract":[{"type":"text","text":"Whether the request failed due to network issues."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isNetworkError","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isNetworkError"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/cause":{"type":"topic","title":"cause","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/cause","kind":"symbol","url":"\/documentation\/auth0\/authenticationerror\/cause","abstract":[{"text":"The underlying ","type":"text"},{"code":"Error","type":"codeVoice"},{"text":" value, if any. Defaults to ","type":"text"},{"code":"nil","type":"codeVoice"},{"text":".","type":"text"}],"role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:s5ErrorP","text":"Error","kind":"typeIdentifier"},{"text":"?","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"}}} \ 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 e2feb2a53..a8cebad84 100644 --- a/docs/data/documentation/auth0/authenticationerror/auth0error-implementations.json +++ b/docs/data/documentation/auth0/authenticationerror/auth0error-implementations.json @@ -1 +1 @@ -{"kind":"article","metadata":{"roleHeading":"API Collection","role":"collectionGroup","title":"Auth0Error Implementations","modules":[{"name":"Auth0"}]},"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/Auth0Error-Implementations","interfaceLanguage":"swift"},"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"]]},"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/errorDescription","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/localizedDescription"],"title":"Instance Properties","anchor":"Instance-Properties","generated":true}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/localizedDescription":{"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"localizedDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/localizedDescription","url":"\/documentation\/auth0\/authenticationerror\/localizeddescription","kind":"symbol","abstract":[{"text":"Description of the error.","type":"text"}],"title":"localizedDescription","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/errorDescription":{"url":"\/documentation\/auth0\/authenticationerror\/errordescription","title":"errorDescription","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/errorDescription","type":"topic","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"errorDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"Description of the error."}],"kind":"symbol"}}} \ No newline at end of file +{"variants":[{"paths":["\/documentation\/auth0\/authenticationerror\/auth0error-implementations"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"patch":0,"minor":3,"major":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"topicSections":[{"generated":true,"title":"Instance Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/errorDescription","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/localizedDescription"],"anchor":"Instance-Properties"}],"metadata":{"title":"Auth0Error Implementations","role":"collectionGroup","modules":[{"name":"Auth0"}],"roleHeading":"API Collection"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/Auth0Error-Implementations"},"kind":"article","references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/localizedDescription":{"url":"\/documentation\/auth0\/authenticationerror\/localizeddescription","abstract":[{"type":"text","text":"Description of the error."}],"title":"localizedDescription","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"localizedDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/localizedDescription","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/errorDescription":{"kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"errorDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"title":"errorDescription","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Description of the error."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/errorDescription","url":"\/documentation\/auth0\/authenticationerror\/errordescription"}}} \ 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 8b2bcd06d..d9c8a9a42 100644 --- a/docs/data/documentation/auth0/authenticationerror/cause.json +++ b/docs/data/documentation/auth0/authenticationerror/cause.json @@ -1 +1 @@ -{"sections":[],"metadata":{"externalID":"s:5Auth00A8APIErrorPAAE5causes5Error_pSgvp::SYNTHESIZED::s:5Auth019AuthenticationErrorV","symbolKind":"property","modules":[{"name":"Auth0"}],"extendedModule":"Auth0","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP","text":"Error"},{"kind":"text","text":"?"}],"role":"symbol","title":"cause","roleHeading":"Instance Property"},"kind":"symbol","primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"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":"? { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}]}],"kind":"declarations"}],"variants":[{"paths":["\/documentation\/auth0\/authenticationerror\/cause"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/cause","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"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 "},{"code":"nil","type":"codeVoice"},{"type":"text","text":"."}],"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:s5ErrorP","text":"Error","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/cause","title":"cause","kind":"symbol","role":"symbol","url":"\/documentation\/auth0\/authenticationerror\/cause"}}} \ No newline at end of file +{"variants":[{"paths":["\/documentation\/auth0\/authenticationerror\/cause"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"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":"? { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}]}],"kind":"declarations"}],"kind":"symbol","sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"role":"symbol","title":"cause","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP","text":"Error"},{"kind":"text","text":"?"}],"externalID":"s:5Auth00A8APIErrorPAAE5causes5Error_pSgvp::SYNTHESIZED::s:5Auth019AuthenticationErrorV","extendedModule":"Auth0","roleHeading":"Instance Property","symbolKind":"property"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/cause","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/cause":{"type":"topic","title":"cause","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/cause","kind":"symbol","url":"\/documentation\/auth0\/authenticationerror\/cause","abstract":[{"text":"The underlying ","type":"text"},{"code":"Error","type":"codeVoice"},{"text":" value, if any. Defaults to ","type":"text"},{"code":"nil","type":"codeVoice"},{"text":".","type":"text"}],"role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:s5ErrorP","text":"Error","kind":"typeIdentifier"},{"text":"?","kind":"text"}]}}} \ 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 751b2623c..ccaeba8ce 100644 --- a/docs/data/documentation/auth0/authenticationerror/code.json +++ b/docs/data/documentation/auth0/authenticationerror/code.json @@ -1 +1 @@ -{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/code"},"schemaVersion":{"minor":3,"major":0,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/code"]}],"abstract":[{"type":"text","text":"Error code."}],"kind":"symbol","sections":[],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"code"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"metadata":{"roleHeading":"Instance Property","role":"symbol","symbolKind":"property","externalID":"s:5Auth019AuthenticationErrorV4codeSSvp","title":"code","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"code"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/code":{"type":"topic","abstract":[{"type":"text","text":"Error code."}],"kind":"symbol","title":"code","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/code","url":"\/documentation\/auth0\/authenticationerror\/code","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"code","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"schemaVersion":{"minor":3,"patch":0,"major":0},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"code","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"sections":[],"abstract":[{"text":"Error code.","type":"text"}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/code"]}],"metadata":{"roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"role":"symbol","title":"code","externalID":"s:5Auth019AuthenticationErrorV4codeSSvp","symbolKind":"property","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"code","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/code","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/code":{"title":"code","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/code","role":"symbol","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"code","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"abstract":[{"text":"Error code.","type":"text"}],"url":"\/documentation\/auth0\/authenticationerror\/code"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"}}} \ 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 7f47490e3..38495a594 100644 --- a/docs/data/documentation/auth0/authenticationerror/debugdescription.json +++ b/docs/data/documentation/auth0/authenticationerror/debugdescription.json @@ -1 +1 @@ -{"kind":"symbol","metadata":{"role":"symbol","modules":[{"name":"Auth0"}],"title":"debugDescription","symbolKind":"property","externalID":"s:5Auth019AuthenticationErrorV16debugDescriptionSSvp","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"debugDescription","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"roleHeading":"Instance Property"},"schemaVersion":{"minor":3,"major":0,"patch":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/debugDescription"},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"debugDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"languages":["swift"]}],"kind":"declarations"},{"content":[{"text":"Discussion","anchor":"discussion","type":"heading","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"}],"type":"aside","style":"important","name":"Important"}],"kind":"content"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/debugdescription"]}],"abstract":[{"type":"text","text":"Description of the error."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/debugDescription":{"kind":"symbol","role":"symbol","type":"topic","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"debugDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"title":"debugDescription","abstract":[{"text":"Description of the error.","type":"text"}],"url":"\/documentation\/auth0\/authenticationerror\/debugdescription","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/debugDescription"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"debugDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]},{"kind":"content","content":[{"type":"heading","text":"Discussion","anchor":"discussion","level":2},{"type":"aside","name":"Important","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"},{"text":" only.","type":"text"}],"type":"paragraph"}]}]}],"sections":[],"abstract":[{"type":"text","text":"Description of the error."}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/debugdescription"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/debugDescription"},"metadata":{"role":"symbol","modules":[{"name":"Auth0"}],"title":"debugDescription","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"debugDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"externalID":"s:5Auth019AuthenticationErrorV16debugDescriptionSSvp","roleHeading":"Instance Property","symbolKind":"property"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/debugDescription":{"kind":"symbol","title":"debugDescription","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"debugDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/debugDescription","abstract":[{"text":"Description of the error.","type":"text"}],"url":"\/documentation\/auth0\/authenticationerror\/debugdescription"}}} \ 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 af276835c..d6f3c9407 100644 --- a/docs/data/documentation/auth0/authenticationerror/equatable-implementations.json +++ b/docs/data/documentation/auth0/authenticationerror/equatable-implementations.json @@ -1 +1 @@ -{"metadata":{"title":"Equatable Implementations","modules":[{"name":"Auth0"}],"roleHeading":"API Collection","role":"collectionGroup"},"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"article","sections":[],"topicSections":[{"title":"Operators","generated":true,"anchor":"Operators","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/!=(_:_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/==(_:_:)"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/Equatable-Implementations","interfaceLanguage":"swift"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/equatable-implementations"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/==(_:_:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/==(_:_:)","abstract":[{"type":"text","text":"Conformance to "},{"type":"codeVoice","code":"Equatable"},{"type":"text","text":"."}],"type":"topic","url":"\/documentation\/auth0\/authenticationerror\/==(_:_:)","title":"==(_:_:)","role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"==","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":", ","kind":"text"},{"text":"AuthenticationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019AuthenticationErrorV"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/!=(_:_:)":{"role":"symbol","type":"topic","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/!=(_:_:)","title":"!=(_:_:)","url":"\/documentation\/auth0\/authenticationerror\/!=(_:_:)","kind":"symbol","abstract":[]}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/equatable-implementations"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"topicSections":[{"title":"Operators","generated":true,"anchor":"Operators","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/!=(_:_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/==(_:_:)"]}],"metadata":{"title":"Equatable Implementations","modules":[{"name":"Auth0"}],"roleHeading":"API Collection","role":"collectionGroup"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/Equatable-Implementations","interfaceLanguage":"swift"},"kind":"article","references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/!=(_:_:)":{"kind":"symbol","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","text":"Self"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"title":"!=(_:_:)","type":"topic","role":"symbol","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/!=(_:_:)","url":"\/documentation\/auth0\/authenticationerror\/!=(_:_:)"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/==(_:_:)":{"kind":"symbol","title":"==(_:_:)","role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"==","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/==(_:_:)","abstract":[{"type":"text","text":"Conformance to "},{"type":"codeVoice","code":"Equatable"},{"type":"text","text":"."}],"url":"\/documentation\/auth0\/authenticationerror\/==(_:_:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ 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 75d68392e..c9636aaa5 100644 --- a/docs/data/documentation/auth0/authenticationerror/errordescription.json +++ b/docs/data/documentation/auth0/authenticationerror/errordescription.json @@ -1 +1 @@ -{"metadata":{"roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"title":"errorDescription","externalID":"s:5Auth00A5ErrorPAAE16errorDescriptionSSSgvp::SYNTHESIZED::s:5Auth019AuthenticationErrorV","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"errorDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"extendedModule":"Auth0","symbolKind":"property","role":"symbol"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/errorDescription"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"sections":[],"kind":"symbol","schemaVersion":{"major":0,"patch":0,"minor":3},"abstract":[{"type":"text","text":"Description of the error."}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"errorDescription"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"? { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}]}],"kind":"declarations"},{"content":[{"level":2,"anchor":"discussion","type":"heading","text":"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."}]}],"style":"important","name":"Important","type":"aside"}],"kind":"content"}],"variants":[{"paths":["\/documentation\/auth0\/authenticationerror\/errordescription"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/errorDescription":{"url":"\/documentation\/auth0\/authenticationerror\/errordescription","title":"errorDescription","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/errorDescription","type":"topic","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"errorDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"Description of the error."}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]}}} \ No newline at end of file +{"sections":[],"metadata":{"modules":[{"name":"Auth0"}],"externalID":"s:5Auth00A5ErrorPAAE16errorDescriptionSSSgvp::SYNTHESIZED::s:5Auth019AuthenticationErrorV","title":"errorDescription","extendedModule":"Auth0","roleHeading":"Instance Property","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"errorDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"role":"symbol","symbolKind":"property"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/errorDescription","interfaceLanguage":"swift"},"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/authenticationerror\/errordescription"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"schemaVersion":{"patch":0,"major":0,"minor":3},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"errorDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"? { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}]}],"kind":"declarations"},{"content":[{"anchor":"discussion","type":"heading","level":2,"text":"Discussion"},{"type":"aside","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"},{"text":" only.","type":"text"}],"type":"paragraph"}],"name":"Important"}],"kind":"content"}],"abstract":[{"type":"text","text":"Description of the error."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/errorDescription":{"kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"errorDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"title":"errorDescription","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Description of the error."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/errorDescription","url":"\/documentation\/auth0\/authenticationerror\/errordescription"}}} \ 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 974e9afb8..28dff5f18 100644 --- a/docs/data/documentation/auth0/authenticationerror/failurereason.json +++ b/docs/data/documentation/auth0/authenticationerror/failurereason.json @@ -1 +1 @@ -{"schemaVersion":{"minor":3,"patch":0,"major":0},"metadata":{"title":"failureReason","roleHeading":"Instance Property","modules":[{"relatedModules":["Foundation"],"name":"Auth0"}],"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"failureReason"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"externalID":"s:10Foundation14LocalizedErrorPAAE13failureReasonSSSgvp::SYNTHESIZED::s:5Auth019AuthenticationErrorV","extendedModule":"Foundation","platforms":[{"introducedAt":"8.0","deprecated":false,"unavailable":false,"beta":false,"name":"iOS"},{"introducedAt":"8.0","deprecated":false,"unavailable":false,"beta":false,"name":"iPadOS"},{"introducedAt":"8.0","deprecated":false,"unavailable":false,"beta":false,"name":"Mac Catalyst"},{"introducedAt":"10.10","deprecated":false,"unavailable":false,"beta":false,"name":"macOS"},{"introducedAt":"9.0","deprecated":false,"unavailable":false,"beta":false,"name":"tvOS"},{"introducedAt":"2.0","deprecated":false,"unavailable":false,"beta":false,"name":"watchOS"}],"symbolKind":"property"},"abstract":[{"text":"Inherited from ","type":"text"},{"code":"LocalizedError.failureReason","type":"codeVoice"},{"text":".","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"failureReason","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"? { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/failurereason"]}],"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/failureReason"},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/failureReason":{"title":"failureReason","kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"failureReason"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/failureReason","abstract":[],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror\/failurereason"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]}}} \ No newline at end of file +{"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/failureReason","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"failureReason","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"? { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/failurereason"]}],"kind":"symbol","metadata":{"platforms":[{"deprecated":false,"unavailable":false,"introducedAt":"8.0","beta":false,"name":"iOS"},{"deprecated":false,"unavailable":false,"introducedAt":"8.0","beta":false,"name":"iPadOS"},{"deprecated":false,"unavailable":false,"introducedAt":"8.0","beta":false,"name":"Mac Catalyst"},{"deprecated":false,"unavailable":false,"introducedAt":"10.10","beta":false,"name":"macOS"},{"deprecated":false,"unavailable":false,"introducedAt":"9.0","beta":false,"name":"tvOS"},{"deprecated":false,"unavailable":false,"introducedAt":"2.0","beta":false,"name":"watchOS"}],"symbolKind":"property","title":"failureReason","roleHeading":"Instance Property","extendedModule":"Foundation","externalID":"s:10Foundation14LocalizedErrorPAAE13failureReasonSSSgvp::SYNTHESIZED::s:5Auth019AuthenticationErrorV","modules":[{"relatedModules":["Foundation"],"name":"Auth0"}],"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"}],"role":"symbol"},"schemaVersion":{"minor":3,"major":0,"patch":0},"abstract":[{"text":"Inherited from ","type":"text"},{"type":"codeVoice","code":"LocalizedError.failureReason"},{"text":".","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/failureReason":{"title":"failureReason","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/failureReason","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"failureReason"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"abstract":[],"url":"\/documentation\/auth0\/authenticationerror\/failurereason"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"}}} \ 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 477f7d8b9..47c33d38e 100644 --- a/docs/data/documentation/auth0/authenticationerror/helpanchor.json +++ b/docs/data/documentation/auth0/authenticationerror/helpanchor.json @@ -1 +1 @@ -{"schemaVersion":{"minor":3,"major":0,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"helpAnchor","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"? { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"platforms":["iOS"]}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/helpAnchor"},"sections":[],"abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"LocalizedError.helpAnchor"},{"type":"text","text":"."}],"variants":[{"paths":["\/documentation\/auth0\/authenticationerror\/helpanchor"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"roleHeading":"Instance Property","symbolKind":"property","extendedModule":"Foundation","role":"symbol","externalID":"s:10Foundation14LocalizedErrorPAAE10helpAnchorSSSgvp::SYNTHESIZED::s:5Auth019AuthenticationErrorV","platforms":[{"name":"iOS","introducedAt":"8.0","deprecated":false,"unavailable":false,"beta":false},{"name":"iPadOS","introducedAt":"8.0","deprecated":false,"unavailable":false,"beta":false},{"name":"Mac Catalyst","introducedAt":"8.0","deprecated":false,"unavailable":false,"beta":false},{"name":"macOS","introducedAt":"10.10","deprecated":false,"unavailable":false,"beta":false},{"name":"tvOS","introducedAt":"9.0","deprecated":false,"unavailable":false,"beta":false},{"name":"watchOS","introducedAt":"2.0","deprecated":false,"unavailable":false,"beta":false}],"modules":[{"name":"Auth0","relatedModules":["Foundation"]}],"title":"helpAnchor","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"helpAnchor","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}]},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/helpAnchor":{"title":"helpAnchor","kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"helpAnchor"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/helpAnchor","abstract":[],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror\/helpanchor"}}} \ No newline at end of file +{"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/helpAnchor","interfaceLanguage":"swift"},"kind":"symbol","metadata":{"platforms":[{"deprecated":false,"unavailable":false,"beta":false,"name":"iOS","introducedAt":"8.0"},{"deprecated":false,"unavailable":false,"beta":false,"name":"iPadOS","introducedAt":"8.0"},{"deprecated":false,"unavailable":false,"beta":false,"name":"Mac Catalyst","introducedAt":"8.0"},{"deprecated":false,"unavailable":false,"beta":false,"name":"macOS","introducedAt":"10.10"},{"deprecated":false,"unavailable":false,"beta":false,"name":"tvOS","introducedAt":"9.0"},{"deprecated":false,"unavailable":false,"beta":false,"name":"watchOS","introducedAt":"2.0"}],"title":"helpAnchor","modules":[{"name":"Auth0","relatedModules":["Foundation"]}],"externalID":"s:10Foundation14LocalizedErrorPAAE10helpAnchorSSSgvp::SYNTHESIZED::s:5Auth019AuthenticationErrorV","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"helpAnchor","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"roleHeading":"Instance Property","extendedModule":"Foundation","symbolKind":"property"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/helpanchor"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"schemaVersion":{"patch":0,"minor":3,"major":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"helpAnchor","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"? { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}]}]}],"abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"LocalizedError.helpAnchor"},{"type":"text","text":"."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/helpAnchor":{"title":"helpAnchor","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/helpAnchor","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"helpAnchor"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}],"abstract":[],"url":"\/documentation\/auth0\/authenticationerror\/helpanchor"}}} \ 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 f7dd00b46..64cbecfc7 100644 --- a/docs/data/documentation/auth0/authenticationerror/info.json +++ b/docs/data/documentation/auth0/authenticationerror/info.json @@ -1 +1 @@ -{"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/info"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"abstract":[{"type":"text","text":"Raw error values."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"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"}],"platforms":["iOS"],"languages":["swift"]}]}],"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"fragments":[{"kind":"keyword","text":"let"},{"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"}],"symbolKind":"property","externalID":"s:5Auth019AuthenticationErrorV4infoSDySSypGvp","role":"symbol","roleHeading":"Instance Property","title":"info","modules":[{"name":"Auth0"}]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/info"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/info":{"url":"\/documentation\/auth0\/authenticationerror\/info","kind":"symbol","abstract":[{"type":"text","text":"Raw error values."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/info","title":"info","type":"topic","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"info","kind":"identifier"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"]","kind":"text"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"metadata":{"symbolKind":"property","title":"info","roleHeading":"Instance Property","externalID":"s:5Auth019AuthenticationErrorV4infoSDySSypGvp","modules":[{"name":"Auth0"}],"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"info","kind":"identifier"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"]","kind":"text"}],"role":"symbol"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/info"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/info","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"type":"text","text":"Raw error values."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"info","kind":"identifier"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"]","kind":"text"}]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/info":{"kind":"symbol","abstract":[{"type":"text","text":"Raw error values."}],"type":"topic","url":"\/documentation\/auth0\/authenticationerror\/info","title":"info","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"info"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/info"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"}}} \ 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 505ff73aa..a33478e77 100644 --- a/docs/data/documentation/auth0/authenticationerror/init(info:statuscode:).json +++ b/docs/data/documentation/auth0/authenticationerror/init(info:statuscode:).json @@ -1 +1 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/init(info:statusCode:)","interfaceLanguage":"swift"},"schemaVersion":{"major":0,"patch":0,"minor":3},"metadata":{"role":"symbol","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"info"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"statusCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"kind":"text","text":")"}],"title":"init(info:statusCode:)","symbolKind":"init","modules":[{"name":"Auth0"}],"externalID":"s:5Auth019AuthenticationErrorV4info10statusCodeACSDySSypG_Sitcfc","roleHeading":"Initializer"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"sections":[],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"info"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"statusCode"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"},{"kind":"text","text":")"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"info","content":[{"inlineContent":[{"text":"JSON response from Auth0.","type":"text"}],"type":"paragraph"}]},{"name":"statusCode","content":[{"inlineContent":[{"text":"HTTP status code of the response.","type":"text"}],"type":"paragraph"}]}]},{"kind":"content","content":[{"level":2,"text":"Return Value","type":"heading","anchor":"return-value"},{"inlineContent":[{"text":"A new ","type":"text"},{"type":"codeVoice","code":"AuthenticationError"},{"text":".","type":"text"}],"type":"paragraph"}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/init(info:statuscode:)"]}],"abstract":[{"text":"Creates an error from a JSON response.","type":"text"}],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/init(info:statusCode:)":{"type":"topic","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"info"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"statusCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"kind":"text","text":")"}],"role":"symbol","abstract":[{"text":"Creates an error from a JSON response.","type":"text"}],"url":"\/documentation\/auth0\/authenticationerror\/init(info:statuscode:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/init(info:statusCode:)","kind":"symbol","title":"init(info:statusCode:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"abstract":[{"type":"text","text":"Creates an error from a JSON response."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"init"},{"text":"(","kind":"text"},{"text":"info","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"], ","kind":"text"},{"text":"statusCode","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"text":")","kind":"text"}],"platforms":["iOS"]}]},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"text":"JSON response from Auth0.","type":"text"}],"type":"paragraph"}],"name":"info"},{"content":[{"inlineContent":[{"text":"HTTP status code of the response.","type":"text"}],"type":"paragraph"}],"name":"statusCode"}]},{"content":[{"anchor":"return-value","type":"heading","level":2,"text":"Return Value"},{"inlineContent":[{"text":"A new ","type":"text"},{"code":"AuthenticationError","type":"codeVoice"},{"type":"text","text":"."}],"type":"paragraph"}],"kind":"content"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/init(info:statuscode:)"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"metadata":{"modules":[{"name":"Auth0"}],"externalID":"s:5Auth019AuthenticationErrorV4info10statusCodeACSDySSypG_Sitcfc","title":"init(info:statusCode:)","fragments":[{"text":"init","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"info"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"statusCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"text":")","kind":"text"}],"roleHeading":"Initializer","role":"symbol","symbolKind":"init"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/init(info:statusCode:)"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/init(info:statusCode:)":{"url":"\/documentation\/auth0\/authenticationerror\/init(info:statuscode:)","abstract":[{"text":"Creates an error from a JSON response.","type":"text"}],"title":"init(info:statusCode:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"info"},{"kind":"text","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":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"kind":"text","text":")"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/init(info:statusCode:)","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"}}} \ 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 9d0758373..df571e4d7 100644 --- a/docs/data/documentation/auth0/authenticationerror/isaccessdenied.json +++ b/docs/data/documentation/auth0/authenticationerror/isaccessdenied.json @@ -1 +1 @@ -{"variants":[{"paths":["\/documentation\/auth0\/authenticationerror\/isaccessdenied"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isAccessDenied","interfaceLanguage":"swift"},"metadata":{"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isAccessDenied","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"roleHeading":"Instance Property","role":"symbol","title":"isAccessDenied","externalID":"s:5Auth019AuthenticationErrorV14isAccessDeniedSbvp","symbolKind":"property","modules":[{"name":"Auth0"}]},"kind":"symbol","schemaVersion":{"minor":3,"patch":0,"major":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isAccessDenied"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}]}]}],"sections":[],"abstract":[{"text":"When Auth0 denies access due to some misconfiguration or an error in an Action or Rule.","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isAccessDenied":{"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isAccessDenied"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"title":"isAccessDenied","kind":"symbol","type":"topic","abstract":[{"type":"text","text":"When Auth0 denies access due to some misconfiguration or an error in an Action or Rule."}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isAccessDenied","url":"\/documentation\/auth0\/authenticationerror\/isaccessdenied"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]}}} \ No newline at end of file +{"schemaVersion":{"patch":0,"major":0,"minor":3},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isAccessDenied"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"platforms":["iOS"]}]}],"sections":[],"abstract":[{"text":"When Auth0 denies access due to some misconfiguration or an error in an Action or Rule.","type":"text"}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/isaccessdenied"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isAccessDenied","interfaceLanguage":"swift"},"metadata":{"role":"symbol","title":"isAccessDenied","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isAccessDenied"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"externalID":"s:5Auth019AuthenticationErrorV14isAccessDeniedSbvp","roleHeading":"Instance Property","symbolKind":"property"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isAccessDenied":{"kind":"symbol","title":"isAccessDenied","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isAccessDenied"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isAccessDenied","abstract":[{"text":"When Auth0 denies access due to some misconfiguration or an error in an Action or Rule.","type":"text"}],"url":"\/documentation\/auth0\/authenticationerror\/isaccessdenied"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authenticationerror/isdpopnoncerequired.json b/docs/data/documentation/auth0/authenticationerror/isdpopnoncerequired.json index 7cc3dc74f..3e97fcf53 100644 --- a/docs/data/documentation/auth0/authenticationerror/isdpopnoncerequired.json +++ b/docs/data/documentation/auth0/authenticationerror/isdpopnoncerequired.json @@ -1 +1 @@ -{"metadata":{"title":"isDPoPNonceRequired","modules":[{"name":"Auth0"}],"externalID":"s:5Auth019AuthenticationErrorV19isDPoPNonceRequiredSbvp","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isDPoPNonceRequired","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"symbolKind":"property","roleHeading":"Instance Property"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isDPoPNonceRequired","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/isdpopnoncerequired"]}],"sections":[],"abstract":[{"text":"When a nonce must be included in the DPoP proof. The Authentication API client will retry the request ","type":"text"},{"inlineContent":[{"type":"text","text":"once"}],"type":"emphasis"},{"text":" ","type":"text"},{"text":"when a nonce is required by Auth0, but subsequent failures must be handled by the app.","type":"text"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isDPoPNonceRequired"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"languages":["swift"],"platforms":["iOS"]}]},{"kind":"content","content":[{"level":2,"anchor":"discussion","type":"heading","text":"Discussion"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The nonce is sent on the "},{"type":"codeVoice","code":"DPoP-Nonce"},{"type":"text","text":" header of the response. It is available in the "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/info","isActive":true},{"type":"text","text":" dictionary under"},{"type":"text","text":" "},{"type":"text","text":"the "},{"type":"codeVoice","code":"dpop_nonce"},{"type":"text","text":" key."}]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isDPoPNonceRequired":{"type":"topic","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isDPoPNonceRequired"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"url":"\/documentation\/auth0\/authenticationerror\/isdpopnoncerequired","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isDPoPNonceRequired","role":"symbol","abstract":[{"text":"When a nonce must be included in the DPoP proof. The Authentication API client will retry the request ","type":"text"},{"inlineContent":[{"type":"text","text":"once"}],"type":"emphasis"},{"text":" ","type":"text"},{"text":"when a nonce is required by Auth0, but subsequent failures must be handled by the app.","type":"text"}],"title":"isDPoPNonceRequired","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/info":{"url":"\/documentation\/auth0\/authenticationerror\/info","kind":"symbol","abstract":[{"type":"text","text":"Raw error values."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/info","title":"info","type":"topic","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"info","kind":"identifier"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"]","kind":"text"}],"role":"symbol"}}} \ No newline at end of file +{"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/isdpopnoncerequired"]}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"abstract":[{"type":"text","text":"When a nonce must be included in the DPoP proof. The Authentication API client will retry the request "},{"type":"emphasis","inlineContent":[{"type":"text","text":"once"}]},{"type":"text","text":" "},{"type":"text","text":"when a nonce is required by Auth0, but subsequent failures must be handled by the app."}],"schemaVersion":{"patch":0,"major":0,"minor":3},"metadata":{"roleHeading":"Instance Property","role":"symbol","title":"isDPoPNonceRequired","symbolKind":"property","externalID":"s:5Auth019AuthenticationErrorV19isDPoPNonceRequiredSbvp","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isDPoPNonceRequired"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}]},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isDPoPNonceRequired","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}]}]},{"kind":"content","content":[{"level":2,"type":"heading","anchor":"discussion","text":"Discussion"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The nonce is sent on the "},{"type":"codeVoice","code":"DPoP-Nonce"},{"type":"text","text":" header of the response. It is available in the "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/info","isActive":true},{"type":"text","text":" dictionary under"},{"type":"text","text":" "},{"type":"text","text":"the "},{"type":"codeVoice","code":"dpop_nonce"},{"type":"text","text":" key."}]}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isDPoPNonceRequired","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/info":{"kind":"symbol","abstract":[{"type":"text","text":"Raw error values."}],"type":"topic","url":"\/documentation\/auth0\/authenticationerror\/info","title":"info","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"info"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/info"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isDPoPNonceRequired":{"kind":"symbol","abstract":[{"type":"text","text":"When a nonce must be included in the DPoP proof. The Authentication API client will retry the request "},{"type":"emphasis","inlineContent":[{"type":"text","text":"once"}]},{"type":"text","text":" "},{"type":"text","text":"when a nonce is required by Auth0, but subsequent failures must be handled by the app."}],"type":"topic","url":"\/documentation\/auth0\/authenticationerror\/isdpopnoncerequired","title":"isDPoPNonceRequired","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isDPoPNonceRequired"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isDPoPNonceRequired"}}} \ 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 b00158382..fe6654aff 100644 --- a/docs/data/documentation/auth0/authenticationerror/isinvalidcredentials.json +++ b/docs/data/documentation/auth0/authenticationerror/isinvalidcredentials.json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isInvalidCredentials","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}]}],"sections":[],"variants":[{"paths":["\/documentation\/auth0\/authenticationerror\/isinvalidcredentials"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"minor":3,"major":0,"patch":0},"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isInvalidCredentials"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"metadata":{"modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isInvalidCredentials","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"externalID":"s:5Auth019AuthenticationErrorV20isInvalidCredentialsSbvp","symbolKind":"property","title":"isInvalidCredentials"},"abstract":[{"text":"When the username and\/or password used for authentication are invalid.","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isInvalidCredentials":{"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isInvalidCredentials","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isInvalidCredentials","type":"topic","abstract":[{"text":"When the username and\/or password used for authentication are invalid.","type":"text"}],"title":"isInvalidCredentials","kind":"symbol","role":"symbol","url":"\/documentation\/auth0\/authenticationerror\/isinvalidcredentials"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/isinvalidcredentials"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"abstract":[{"text":"When the username and\/or password used for authentication are invalid.","type":"text"}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isInvalidCredentials"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"platforms":["iOS"]}],"kind":"declarations"}],"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","metadata":{"symbolKind":"property","title":"isInvalidCredentials","externalID":"s:5Auth019AuthenticationErrorV20isInvalidCredentialsSbvp","roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isInvalidCredentials"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"role":"symbol"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isInvalidCredentials","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isInvalidCredentials":{"type":"topic","abstract":[{"text":"When the username and\/or password used for authentication are invalid.","type":"text"}],"title":"isInvalidCredentials","kind":"symbol","url":"\/documentation\/auth0\/authenticationerror\/isinvalidcredentials","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isInvalidCredentials"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isInvalidCredentials"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ 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 8b93eeb22..4ea79ee2b 100644 --- a/docs/data/documentation/auth0/authenticationerror/isinvalidrefreshtoken.json +++ b/docs/data/documentation/auth0/authenticationerror/isinvalidrefreshtoken.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:5Auth019AuthenticationErrorV21isInvalidRefreshTokenSbvp","symbolKind":"property","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isInvalidRefreshToken"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"modules":[{"name":"Auth0"}],"role":"symbol","roleHeading":"Instance Property","title":"isInvalidRefreshToken"},"abstract":[{"type":"text","text":"When the provided refresh token is invalid or expired."}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isInvalidRefreshToken","interfaceLanguage":"swift"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/isinvalidrefreshtoken"]}],"kind":"symbol","primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isInvalidRefreshToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}]}],"kind":"declarations"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isInvalidRefreshToken":{"url":"\/documentation\/auth0\/authenticationerror\/isinvalidrefreshtoken","role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isInvalidRefreshToken","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isInvalidRefreshToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"abstract":[{"type":"text","text":"When the provided refresh token is invalid or expired."}],"kind":"symbol","title":"isInvalidRefreshToken"}}} \ No newline at end of file +{"metadata":{"symbolKind":"property","title":"isInvalidRefreshToken","roleHeading":"Instance Property","externalID":"s:5Auth019AuthenticationErrorV21isInvalidRefreshTokenSbvp","modules":[{"name":"Auth0"}],"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isInvalidRefreshToken","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"role":"symbol"},"sections":[],"variants":[{"paths":["\/documentation\/auth0\/authenticationerror\/isinvalidrefreshtoken"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isInvalidRefreshToken","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"type":"text","text":"When the provided refresh token is invalid or expired."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isInvalidRefreshToken","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}]}]}],"schemaVersion":{"patch":0,"minor":3,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isInvalidRefreshToken":{"type":"topic","title":"isInvalidRefreshToken","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isInvalidRefreshToken","kind":"symbol","url":"\/documentation\/auth0\/authenticationerror\/isinvalidrefreshtoken","abstract":[{"type":"text","text":"When the provided refresh token is invalid or expired."}],"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isInvalidRefreshToken"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ 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 b2e6c5259..2d68f802d 100644 --- a/docs/data/documentation/auth0/authenticationerror/isloginrequired.json +++ b/docs/data/documentation/auth0/authenticationerror/isloginrequired.json @@ -1 +1 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isLoginRequired","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isLoginRequired","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"schemaVersion":{"patch":0,"major":0,"minor":3},"kind":"symbol","metadata":{"externalID":"s:5Auth019AuthenticationErrorV15isLoginRequiredSbvp","modules":[{"name":"Auth0"}],"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isLoginRequired","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"role":"symbol","roleHeading":"Instance Property","title":"isLoginRequired","symbolKind":"property"},"variants":[{"paths":["\/documentation\/auth0\/authenticationerror\/isloginrequired"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"type":"text","text":"When performing Web Auth login with "},{"type":"codeVoice","code":"prompt: \"none\""},{"type":"text","text":" and the Auth0 session has expired."}],"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isLoginRequired":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isLoginRequired","abstract":[{"type":"text","text":"When performing Web Auth login with "},{"type":"codeVoice","code":"prompt: \"none\""},{"type":"text","text":" and the Auth0 session has expired."}],"title":"isLoginRequired","url":"\/documentation\/auth0\/authenticationerror\/isloginrequired","kind":"symbol","type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isLoginRequired"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}]}}} \ No newline at end of file +{"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/isloginrequired"]}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"abstract":[{"type":"text","text":"When performing Web Auth login with "},{"code":"prompt: \"none\"","type":"codeVoice"},{"type":"text","text":" and the Auth0 session has expired."}],"schemaVersion":{"patch":0,"minor":3,"major":0},"metadata":{"roleHeading":"Instance Property","symbolKind":"property","role":"symbol","title":"isLoginRequired","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isLoginRequired"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"externalID":"s:5Auth019AuthenticationErrorV15isLoginRequiredSbvp","modules":[{"name":"Auth0"}]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"isLoginRequired"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"text":" { ","kind":"text"},{"kind":"keyword","text":"get"},{"text":" }","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isLoginRequired","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isLoginRequired":{"kind":"symbol","title":"isLoginRequired","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isLoginRequired"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isLoginRequired","abstract":[{"type":"text","text":"When performing Web Auth login with "},{"code":"prompt: \"none\"","type":"codeVoice"},{"type":"text","text":" and the Auth0 session has expired."}],"url":"\/documentation\/auth0\/authenticationerror\/isloginrequired"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ 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 f0f122b53..039f37619 100644 --- a/docs/data/documentation/auth0/authenticationerror/ismultifactorcodeinvalid.json +++ b/docs/data/documentation/auth0/authenticationerror/ismultifactorcodeinvalid.json @@ -1 +1 @@ -{"variants":[{"paths":["\/documentation\/auth0\/authenticationerror\/ismultifactorcodeinvalid"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"title":"isMultifactorCodeInvalid","role":"symbol","modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","symbolKind":"property","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isMultifactorCodeInvalid"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"externalID":"s:5Auth019AuthenticationErrorV24isMultifactorCodeInvalidSbvp"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorCodeInvalid"},"schemaVersion":{"minor":3,"major":0,"patch":0},"abstract":[{"text":"When the MFA code sent is invalid or expired.","type":"text"}],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isMultifactorCodeInvalid"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorCodeInvalid":{"type":"topic","abstract":[{"type":"text","text":"When the MFA code sent is invalid or expired."}],"role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isMultifactorCodeInvalid"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"url":"\/documentation\/auth0\/authenticationerror\/ismultifactorcodeinvalid","title":"isMultifactorCodeInvalid","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorCodeInvalid"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/ismultifactorcodeinvalid"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"abstract":[{"text":"When the MFA code sent is invalid or expired.","type":"text"}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isMultifactorCodeInvalid","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}]}],"kind":"declarations"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","sections":[],"metadata":{"role":"symbol","title":"isMultifactorCodeInvalid","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isMultifactorCodeInvalid"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"externalID":"s:5Auth019AuthenticationErrorV24isMultifactorCodeInvalidSbvp","roleHeading":"Instance Property","symbolKind":"property"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorCodeInvalid","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorCodeInvalid":{"title":"isMultifactorCodeInvalid","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorCodeInvalid","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isMultifactorCodeInvalid"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"abstract":[{"text":"When the MFA code sent is invalid or expired.","type":"text"}],"url":"\/documentation\/auth0\/authenticationerror\/ismultifactorcodeinvalid"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"}}} \ 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 df1982e96..26b92fd16 100644 --- a/docs/data/documentation/auth0/authenticationerror/ismultifactorenrollrequired.json +++ b/docs/data/documentation/auth0/authenticationerror/ismultifactorenrollrequired.json @@ -1 +1 @@ -{"abstract":[{"text":"When MFA is required and the user is not enrolled.","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isMultifactorEnrollRequired"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"languages":["swift"]}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/ismultifactorenrollrequired"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorEnrollRequired"},"sections":[],"metadata":{"roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isMultifactorEnrollRequired"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"externalID":"s:5Auth019AuthenticationErrorV27isMultifactorEnrollRequiredSbvp","symbolKind":"property","title":"isMultifactorEnrollRequired","role":"symbol"},"kind":"symbol","schemaVersion":{"major":0,"patch":0,"minor":3},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorEnrollRequired":{"role":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isMultifactorEnrollRequired"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"abstract":[{"text":"When MFA is required and the user is not enrolled.","type":"text"}],"url":"\/documentation\/auth0\/authenticationerror\/ismultifactorenrollrequired","title":"isMultifactorEnrollRequired","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorEnrollRequired"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]}}} \ No newline at end of file +{"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isMultifactorEnrollRequired","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]}],"variants":[{"paths":["\/documentation\/auth0\/authenticationerror\/ismultifactorenrollrequired"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"schemaVersion":{"minor":3,"major":0,"patch":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorEnrollRequired"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"abstract":[{"type":"text","text":"When MFA is required and the user is not enrolled."}],"metadata":{"role":"symbol","title":"isMultifactorEnrollRequired","modules":[{"name":"Auth0"}],"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isMultifactorEnrollRequired","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"externalID":"s:5Auth019AuthenticationErrorV27isMultifactorEnrollRequiredSbvp","roleHeading":"Instance Property","symbolKind":"property"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorEnrollRequired":{"type":"topic","title":"isMultifactorEnrollRequired","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorEnrollRequired","url":"\/documentation\/auth0\/authenticationerror\/ismultifactorenrollrequired","abstract":[{"type":"text","text":"When MFA is required and the user is not enrolled."}],"kind":"symbol","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"isMultifactorEnrollRequired"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"}}} \ 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 b14293915..99960eb08 100644 --- a/docs/data/documentation/auth0/authenticationerror/ismultifactorrequired.json +++ b/docs/data/documentation/auth0/authenticationerror/ismultifactorrequired.json @@ -1 +1 @@ -{"variants":[{"paths":["\/documentation\/auth0\/authenticationerror\/ismultifactorrequired"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired"},"metadata":{"title":"isMultifactorRequired","modules":[{"name":"Auth0"}],"externalID":"s:5Auth019AuthenticationErrorV21isMultifactorRequiredSbvp","role":"symbol","roleHeading":"Instance Property","symbolKind":"property","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isMultifactorRequired"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}]},"abstract":[{"type":"text","text":"When MFA is required to authenticate."}],"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":" "},{"kind":"identifier","text":"isMultifactorRequired"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"platforms":["iOS"],"languages":["swift"]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorRequired":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired","type":"topic","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isMultifactorRequired","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror\/ismultifactorrequired","abstract":[{"text":"When MFA is required to authenticate.","type":"text"}],"title":"isMultifactorRequired"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]}}} \ No newline at end of file +{"metadata":{"modules":[{"name":"Auth0"}],"title":"isMultifactorRequired","externalID":"s:5Auth019AuthenticationErrorV21isMultifactorRequiredSbvp","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"isMultifactorRequired","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"roleHeading":"Instance Property","symbolKind":"property"},"sections":[],"variants":[{"paths":["\/documentation\/auth0\/authenticationerror\/ismultifactorrequired"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired"},"kind":"symbol","abstract":[{"type":"text","text":"When MFA is required to authenticate."}],"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":" "},{"kind":"identifier","text":"isMultifactorRequired"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"platforms":["iOS"],"languages":["swift"]}]}],"schemaVersion":{"patch":0,"minor":3,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorRequired":{"type":"topic","title":"isMultifactorRequired","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorRequired","kind":"symbol","url":"\/documentation\/auth0\/authenticationerror\/ismultifactorrequired","abstract":[{"type":"text","text":"When MFA is required to authenticate."}],"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isMultifactorRequired"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}]}}} \ 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 4ac1740e5..c9fae7ba1 100644 --- a/docs/data/documentation/auth0/authenticationerror/ismultifactortokeninvalid.json +++ b/docs/data/documentation/auth0/authenticationerror/ismultifactortokeninvalid.json @@ -1 +1 @@ -{"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isMultifactorTokenInvalid"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/ismultifactortokeninvalid"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorTokenInvalid"},"schemaVersion":{"major":0,"patch":0,"minor":3},"metadata":{"title":"isMultifactorTokenInvalid","symbolKind":"property","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isMultifactorTokenInvalid","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"externalID":"s:5Auth019AuthenticationErrorV25isMultifactorTokenInvalidSbvp"},"abstract":[{"text":"When the MFA token is invalid or expired.","type":"text"}],"sections":[],"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":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorTokenInvalid":{"type":"topic","abstract":[{"type":"text","text":"When the MFA token is invalid or expired."}],"role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isMultifactorTokenInvalid"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"url":"\/documentation\/auth0\/authenticationerror\/ismultifactortokeninvalid","title":"isMultifactorTokenInvalid","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorTokenInvalid"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/ismultifactortokeninvalid"]}],"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"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isMultifactorTokenInvalid","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}]}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"kind":"symbol","sections":[],"metadata":{"externalID":"s:5Auth019AuthenticationErrorV25isMultifactorTokenInvalidSbvp","symbolKind":"property","title":"isMultifactorTokenInvalid","role":"symbol","roleHeading":"Instance Property","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isMultifactorTokenInvalid","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"modules":[{"name":"Auth0"}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorTokenInvalid"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isMultifactorTokenInvalid":{"kind":"symbol","title":"isMultifactorTokenInvalid","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isMultifactorTokenInvalid"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isMultifactorTokenInvalid","abstract":[{"text":"When the MFA token is invalid or expired.","type":"text"}],"url":"\/documentation\/auth0\/authenticationerror\/ismultifactortokeninvalid"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ 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 677db87a2..1d73e1cc3 100644 --- a/docs/data/documentation/auth0/authenticationerror/isnetworkerror.json +++ b/docs/data/documentation/auth0/authenticationerror/isnetworkerror.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"kind":"symbol","abstract":[{"text":"Whether the request failed due to network issues.","type":"text"}],"metadata":{"roleHeading":"Instance Property","extendedModule":"Auth0","role":"symbol","symbolKind":"property","title":"isNetworkError","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isNetworkError","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"modules":[{"name":"Auth0"}],"externalID":"s:5Auth00A8APIErrorPAAE14isNetworkErrorSbvp::SYNTHESIZED::s:5Auth019AuthenticationErrorV"},"sections":[],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isNetworkError"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}]}],"kind":"declarations"},{"content":[{"anchor":"discussion","text":"Discussion","type":"heading","level":2},{"inlineContent":[{"text":"Returns ","type":"text"},{"code":"true","type":"codeVoice"},{"text":" when the ","type":"text"},{"code":"URLError","type":"codeVoice"},{"text":" code is one of the following:","type":"text"}],"type":"paragraph"},{"items":[{"content":[{"inlineContent":[{"isActive":true,"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/datanotallowed"}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/notconnectedtointernet","isActive":true,"type":"reference"}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/networkconnectionlost","isActive":true}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/dnslookupfailed","isActive":true}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"reference","isActive":true,"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/cannotfindhost"}]}]},{"content":[{"type":"paragraph","inlineContent":[{"isActive":true,"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/cannotconnecttohost"}]}]},{"content":[{"type":"paragraph","inlineContent":[{"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/timedout","isActive":true,"type":"reference"}]}]},{"content":[{"type":"paragraph","inlineContent":[{"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/internationalroamingoff","type":"reference","isActive":true}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/callisactive","isActive":true}]}]}],"type":"unorderedList"},{"inlineContent":[{"text":"The underlying ","type":"text"},{"code":"URLError","type":"codeVoice"},{"text":" is available in the ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/cause","isActive":true,"type":"reference"},{"text":" property.","type":"text"}],"type":"paragraph"}],"kind":"content"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/isnetworkerror"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isNetworkError"},"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"https://developer.apple.com/documentation/foundation/urlerror/dnslookupfailed":{"titleInlineContent":[{"text":"dnsLookupFailed","type":"text"}],"type":"link","url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/dnslookupfailed","title":"dnsLookupFailed","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/dnslookupfailed"},"https://developer.apple.com/documentation/foundation/urlerror/networkconnectionlost":{"titleInlineContent":[{"type":"text","text":"networkConnectionLost"}],"type":"link","url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/networkconnectionlost","title":"networkConnectionLost","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/networkconnectionlost"},"https://developer.apple.com/documentation/foundation/urlerror/internationalroamingoff":{"titleInlineContent":[{"text":"internationalRoamingOff","type":"text"}],"type":"link","url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/internationalroamingoff","title":"internationalRoamingOff","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/internationalroamingoff"},"https://developer.apple.com/documentation/foundation/urlerror/cannotfindhost":{"titleInlineContent":[{"type":"text","text":"cannotFindHost"}],"type":"link","url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/cannotfindhost","title":"cannotFindHost","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/cannotfindhost"},"https://developer.apple.com/documentation/foundation/urlerror/callisactive":{"titleInlineContent":[{"text":"callIsActive","type":"text"}],"type":"link","url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/callisactive","title":"callIsActive","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/callisactive"},"https://developer.apple.com/documentation/foundation/urlerror/datanotallowed":{"titleInlineContent":[{"type":"text","text":"dataNotAllowed"}],"type":"link","url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/datanotallowed","title":"dataNotAllowed","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/datanotallowed"},"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 "},{"code":"nil","type":"codeVoice"},{"type":"text","text":"."}],"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:s5ErrorP","text":"Error","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/cause","title":"cause","kind":"symbol","role":"symbol","url":"\/documentation\/auth0\/authenticationerror\/cause"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isNetworkError":{"title":"isNetworkError","role":"symbol","url":"\/documentation\/auth0\/authenticationerror\/isnetworkerror","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isNetworkError","abstract":[{"type":"text","text":"Whether the request failed due to network issues."}],"type":"topic","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isNetworkError","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}]},"https://developer.apple.com/documentation/foundation/urlerror/timedout":{"titleInlineContent":[{"text":"timedOut","type":"text"}],"type":"link","url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/timedout","title":"timedOut","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/timedout"},"https://developer.apple.com/documentation/foundation/urlerror/notconnectedtointernet":{"titleInlineContent":[{"type":"text","text":"notConnectedToInternet"}],"type":"link","url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/notconnectedtointernet","title":"notConnectedToInternet","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/notconnectedtointernet"},"https://developer.apple.com/documentation/foundation/urlerror/cannotconnecttohost":{"titleInlineContent":[{"text":"cannotConnectToHost","type":"text"}],"type":"link","url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/cannotconnecttohost","title":"cannotConnectToHost","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/cannotconnecttohost"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]}}} \ No newline at end of file +{"abstract":[{"type":"text","text":"Whether the request failed due to network issues."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"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"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]},{"kind":"content","content":[{"type":"heading","text":"Discussion","anchor":"discussion","level":2},{"type":"paragraph","inlineContent":[{"text":"Returns ","type":"text"},{"code":"true","type":"codeVoice"},{"text":" when the ","type":"text"},{"code":"URLError","type":"codeVoice"},{"text":" code is one of the following:","type":"text"}]},{"type":"unorderedList","items":[{"content":[{"inlineContent":[{"type":"reference","isActive":true,"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/datanotallowed"}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"type":"reference","isActive":true,"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/notconnectedtointernet"}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"type":"reference","isActive":true,"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/networkconnectionlost"}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"type":"reference","isActive":true,"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/dnslookupfailed"}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"type":"reference","isActive":true,"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/cannotfindhost"}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"type":"reference","isActive":true,"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/cannotconnecttohost"}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"type":"reference","isActive":true,"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/timedout"}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"isActive":true,"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/internationalroamingoff"}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/callisactive","type":"reference","isActive":true}]}]}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"URLError"},{"type":"text","text":" is available in the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/cause"},{"type":"text","text":" property."}]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/isnetworkerror"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"metadata":{"modules":[{"name":"Auth0"}],"title":"isNetworkError","roleHeading":"Instance Property","symbolKind":"property","role":"symbol","extendedModule":"Auth0","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isNetworkError","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"externalID":"s:5Auth00A8APIErrorPAAE14isNetworkErrorSbvp::SYNTHESIZED::s:5Auth019AuthenticationErrorV"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isNetworkError"},"kind":"symbol","references":{"https://developer.apple.com/documentation/foundation/urlerror/networkconnectionlost":{"title":"networkConnectionLost","titleInlineContent":[{"type":"text","text":"networkConnectionLost"}],"type":"link","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/networkconnectionlost","url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/networkconnectionlost"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"},"https://developer.apple.com/documentation/foundation/urlerror/cannotconnecttohost":{"url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/cannotconnecttohost","type":"link","title":"cannotConnectToHost","titleInlineContent":[{"text":"cannotConnectToHost","type":"text"}],"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/cannotconnecttohost"},"https://developer.apple.com/documentation/foundation/urlerror/callisactive":{"type":"link","titleInlineContent":[{"type":"text","text":"callIsActive"}],"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/callisactive","title":"callIsActive","url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/callisactive"},"https://developer.apple.com/documentation/foundation/urlerror/cannotfindhost":{"title":"cannotFindHost","type":"link","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/cannotfindhost","titleInlineContent":[{"type":"text","text":"cannotFindHost"}],"url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/cannotfindhost"},"https://developer.apple.com/documentation/foundation/urlerror/internationalroamingoff":{"title":"internationalRoamingOff","type":"link","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/internationalroamingoff","titleInlineContent":[{"type":"text","text":"internationalRoamingOff"}],"url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/internationalroamingoff"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/cause":{"type":"topic","title":"cause","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/cause","kind":"symbol","url":"\/documentation\/auth0\/authenticationerror\/cause","abstract":[{"text":"The underlying ","type":"text"},{"code":"Error","type":"codeVoice"},{"text":" value, if any. Defaults to ","type":"text"},{"code":"nil","type":"codeVoice"},{"text":".","type":"text"}],"role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:s5ErrorP","text":"Error","kind":"typeIdentifier"},{"text":"?","kind":"text"}]},"https://developer.apple.com/documentation/foundation/urlerror/notconnectedtointernet":{"title":"notConnectedToInternet","type":"link","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/notconnectedtointernet","titleInlineContent":[{"type":"text","text":"notConnectedToInternet"}],"url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/notconnectedtointernet"},"https://developer.apple.com/documentation/foundation/urlerror/datanotallowed":{"title":"dataNotAllowed","type":"link","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/datanotallowed","titleInlineContent":[{"type":"text","text":"dataNotAllowed"}],"url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/datanotallowed"},"https://developer.apple.com/documentation/foundation/urlerror/timedout":{"title":"timedOut","type":"link","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/timedout","titleInlineContent":[{"type":"text","text":"timedOut"}],"url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/timedout"},"https://developer.apple.com/documentation/foundation/urlerror/dnslookupfailed":{"title":"dnsLookupFailed","type":"link","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/dnslookupfailed","titleInlineContent":[{"type":"text","text":"dnsLookupFailed"}],"url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/dnslookupfailed"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isNetworkError":{"type":"topic","title":"isNetworkError","url":"\/documentation\/auth0\/authenticationerror\/isnetworkerror","kind":"symbol","abstract":[{"type":"text","text":"Whether the request failed due to network issues."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isNetworkError","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isNetworkError"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}]}}} \ 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 b45d3cb05..3413c59a5 100644 --- a/docs/data/documentation/auth0/authenticationerror/ispasswordalreadyused.json +++ b/docs/data/documentation/auth0/authenticationerror/ispasswordalreadyused.json @@ -1 +1 @@ -{"schemaVersion":{"patch":0,"major":0,"minor":3},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/ispasswordalreadyused"]}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isPasswordAlreadyUsed","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}]}],"kind":"declarations"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isPasswordAlreadyUsed"},"sections":[],"metadata":{"modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","symbolKind":"property","title":"isPasswordAlreadyUsed","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isPasswordAlreadyUsed","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"role":"symbol","externalID":"s:5Auth019AuthenticationErrorV21isPasswordAlreadyUsedSbvp"},"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."},{"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."}],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/info":{"url":"\/documentation\/auth0\/authenticationerror\/info","kind":"symbol","abstract":[{"type":"text","text":"Raw error values."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/info","title":"info","type":"topic","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"info","kind":"identifier"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"]","kind":"text"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isPasswordAlreadyUsed":{"url":"\/documentation\/auth0\/authenticationerror\/ispasswordalreadyused","abstract":[{"text":"When the password used for signup was already used before. This is reported when the Password History feature","type":"text"},{"text":" ","type":"text"},{"text":"is enabled.","type":"text"},{"text":" ","type":"text"},{"text":"Additional information is available in the ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/info","type":"reference","isActive":true},{"text":" dictionary.","type":"text"}],"title":"isPasswordAlreadyUsed","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isPasswordAlreadyUsed","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isPasswordAlreadyUsed","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"metadata":{"symbolKind":"property","title":"isPasswordAlreadyUsed","externalID":"s:5Auth019AuthenticationErrorV21isPasswordAlreadyUsedSbvp","roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isPasswordAlreadyUsed"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"role":"symbol"},"sections":[],"variants":[{"paths":["\/documentation\/auth0\/authenticationerror\/ispasswordalreadyused"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isPasswordAlreadyUsed"},"kind":"symbol","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."},{"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."}],"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":" "},{"kind":"identifier","text":"isPasswordAlreadyUsed"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"languages":["swift"],"platforms":["iOS"]}]}],"schemaVersion":{"patch":0,"minor":3,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/info":{"kind":"symbol","abstract":[{"type":"text","text":"Raw error values."}],"type":"topic","url":"\/documentation\/auth0\/authenticationerror\/info","title":"info","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"info"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/info"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isPasswordAlreadyUsed":{"kind":"symbol","title":"isPasswordAlreadyUsed","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isPasswordAlreadyUsed"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isPasswordAlreadyUsed","abstract":[{"text":"When the password used for signup was already used before. This is reported when the Password History feature","type":"text"},{"text":" ","type":"text"},{"text":"is enabled.","type":"text"},{"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"},{"text":" dictionary.","type":"text"}],"url":"\/documentation\/auth0\/authenticationerror\/ispasswordalreadyused"}}} \ 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 c5cdf0d0a..a724a3984 100644 --- a/docs/data/documentation/auth0/authenticationerror/ispasswordleaked.json +++ b/docs/data/documentation/auth0/authenticationerror/ispasswordleaked.json @@ -1 +1 @@ -{"sections":[],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isPasswordLeaked"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}]}],"kind":"declarations"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isPasswordLeaked","interfaceLanguage":"swift"},"metadata":{"roleHeading":"Instance Property","symbolKind":"property","role":"symbol","externalID":"s:5Auth019AuthenticationErrorV16isPasswordLeakedSbvp","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isPasswordLeaked"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"title":"isPasswordLeaked"},"abstract":[{"type":"text","text":"When the password used was reported to be leaked."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/ispasswordleaked"]}],"kind":"symbol","schemaVersion":{"minor":3,"major":0,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isPasswordLeaked":{"url":"\/documentation\/auth0\/authenticationerror\/ispasswordleaked","type":"topic","title":"isPasswordLeaked","role":"symbol","kind":"symbol","abstract":[{"type":"text","text":"When the password used was reported to be leaked."}],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isPasswordLeaked"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isPasswordLeaked"}}} \ No newline at end of file +{"abstract":[{"text":"When the password used was reported to be leaked.","type":"text"}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isPasswordLeaked"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"platforms":["iOS"]}],"kind":"declarations"}],"variants":[{"paths":["\/documentation\/auth0\/authenticationerror\/ispasswordleaked"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"minor":3,"major":0,"patch":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"metadata":{"modules":[{"name":"Auth0"}],"symbolKind":"property","title":"isPasswordLeaked","roleHeading":"Instance Property","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isPasswordLeaked"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"externalID":"s:5Auth019AuthenticationErrorV16isPasswordLeakedSbvp"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isPasswordLeaked"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isPasswordLeaked":{"type":"topic","abstract":[{"text":"When the password used was reported to be leaked.","type":"text"}],"title":"isPasswordLeaked","kind":"symbol","url":"\/documentation\/auth0\/authenticationerror\/ispasswordleaked","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isPasswordLeaked"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isPasswordLeaked"}}} \ 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 31db51429..f275a0b16 100644 --- a/docs/data/documentation/auth0/authenticationerror/ispasswordnotstrongenough.json +++ b/docs/data/documentation/auth0/authenticationerror/ispasswordnotstrongenough.json @@ -1 +1 @@ -{"kind":"symbol","abstract":[{"text":"When the password used for signup does not match the strength requirements of the connection.","type":"text"},{"text":" ","type":"text"},{"text":"Additional information is available in the ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/info","type":"reference"},{"text":" dictionary.","type":"text"}],"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isPasswordNotStrongEnough"},"metadata":{"roleHeading":"Instance Property","title":"isPasswordNotStrongEnough","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isPasswordNotStrongEnough","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"externalID":"s:5Auth019AuthenticationErrorV25isPasswordNotStrongEnoughSbvp","symbolKind":"property","role":"symbol","modules":[{"name":"Auth0"}]},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isPasswordNotStrongEnough","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}]}],"kind":"declarations"}],"schemaVersion":{"minor":3,"patch":0,"major":0},"variants":[{"paths":["\/documentation\/auth0\/authenticationerror\/ispasswordnotstrongenough"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isPasswordNotStrongEnough":{"title":"isPasswordNotStrongEnough","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isPasswordNotStrongEnough","abstract":[{"type":"text","text":"When the password used for signup does not match the strength requirements of the connection."},{"type":"text","text":" "},{"type":"text","text":"Additional information is available in the "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/info","isActive":true},{"type":"text","text":" dictionary."}],"url":"\/documentation\/auth0\/authenticationerror\/ispasswordnotstrongenough","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isPasswordNotStrongEnough"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/info":{"url":"\/documentation\/auth0\/authenticationerror\/info","kind":"symbol","abstract":[{"type":"text","text":"Raw error values."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/info","title":"info","type":"topic","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"info","kind":"identifier"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"]","kind":"text"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"metadata":{"symbolKind":"property","roleHeading":"Instance Property","title":"isPasswordNotStrongEnough","externalID":"s:5Auth019AuthenticationErrorV25isPasswordNotStrongEnoughSbvp","modules":[{"name":"Auth0"}],"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isPasswordNotStrongEnough","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"role":"symbol"},"sections":[],"variants":[{"paths":["\/documentation\/auth0\/authenticationerror\/ispasswordnotstrongenough"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isPasswordNotStrongEnough","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"text":"When the password used for signup does not match the strength requirements of the connection.","type":"text"},{"text":" ","type":"text"},{"text":"Additional information is available in the ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/info","isActive":true,"type":"reference"},{"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"},{"text":" ","kind":"text"},{"text":"isPasswordNotStrongEnough","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"schemaVersion":{"patch":0,"major":0,"minor":3},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/info":{"kind":"symbol","abstract":[{"type":"text","text":"Raw error values."}],"type":"topic","url":"\/documentation\/auth0\/authenticationerror\/info","title":"info","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"info"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/info"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isPasswordNotStrongEnough":{"kind":"symbol","title":"isPasswordNotStrongEnough","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isPasswordNotStrongEnough"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isPasswordNotStrongEnough","abstract":[{"text":"When the password used for signup does not match the strength requirements of the connection.","type":"text"},{"text":" ","type":"text"},{"text":"Additional information is available in the ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/info","type":"reference"},{"text":" dictionary.","type":"text"}],"url":"\/documentation\/auth0\/authenticationerror\/ispasswordnotstrongenough"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ 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 617db8405..4b9c75dbf 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","schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"title":"isRefreshTokenDeleted","externalID":"s:5Auth019AuthenticationErrorV21isRefreshTokenDeletedSbvp","symbolKind":"property","modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isRefreshTokenDeleted","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}]},"abstract":[{"type":"text","text":"When the credentials renewal fails because the user was deleted."}],"primaryContentSections":[{"declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isRefreshTokenDeleted","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/isrefreshtokendeleted"]}],"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isRefreshTokenDeleted":{"title":"isRefreshTokenDeleted","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isRefreshTokenDeleted"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isRefreshTokenDeleted","url":"\/documentation\/auth0\/authenticationerror\/isrefreshtokendeleted","kind":"symbol","abstract":[{"type":"text","text":"When the credentials renewal fails because the user was deleted."}],"role":"symbol"}}} \ No newline at end of file +{"metadata":{"externalID":"s:5Auth019AuthenticationErrorV21isRefreshTokenDeletedSbvp","symbolKind":"property","title":"isRefreshTokenDeleted","roleHeading":"Instance Property","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isRefreshTokenDeleted"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"modules":[{"name":"Auth0"}]},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/isrefreshtokendeleted"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isRefreshTokenDeleted","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"type":"text","text":"When the credentials renewal fails because the user was deleted."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isRefreshTokenDeleted","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isRefreshTokenDeleted":{"kind":"symbol","title":"isRefreshTokenDeleted","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isRefreshTokenDeleted"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isRefreshTokenDeleted","abstract":[{"text":"When the credentials renewal fails because the user was deleted.","type":"text"}],"url":"\/documentation\/auth0\/authenticationerror\/isrefreshtokendeleted"}}} \ 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 8752a54ee..69b91e90f 100644 --- a/docs/data/documentation/auth0/authenticationerror/isruleerror.json +++ b/docs/data/documentation/auth0/authenticationerror/isruleerror.json @@ -1 +1 @@ -{"metadata":{"externalID":"s:5Auth019AuthenticationErrorV06isRuleC0Sbvp","roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"symbolKind":"property","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isRuleError","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"role":"symbol","title":"isRuleError"},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isRuleError","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isRuleError"},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"variants":[{"paths":["\/documentation\/auth0\/authenticationerror\/isruleerror"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"type":"text","text":"When an Auth0 rule returns an error."},{"type":"text","text":" "},{"type":"text","text":"The message returned by the rule is available in "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/localizedDescription","isActive":true},{"type":"text","text":"."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/localizedDescription":{"type":"topic","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"localizedDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/localizedDescription","role":"symbol","url":"\/documentation\/auth0\/auth0error\/localizeddescription","title":"localizedDescription","abstract":[{"text":"Description of the error.","type":"text"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isRuleError":{"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror\/isruleerror","title":"isRuleError","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isRuleError","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isRuleError","abstract":[{"type":"text","text":"When an Auth0 rule returns an error."},{"type":"text","text":" "},{"type":"text","text":"The message returned by the rule is available in "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/localizedDescription","type":"reference","isActive":true},{"type":"text","text":"."}]}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/isruleerror"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"abstract":[{"type":"text","text":"When an Auth0 rule returns an error."},{"type":"text","text":" "},{"type":"text","text":"The message returned by the rule is available in "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/localizedDescription","isActive":true},{"type":"text","text":"."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isRuleError","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}]}]}],"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"metadata":{"externalID":"s:5Auth019AuthenticationErrorV06isRuleC0Sbvp","symbolKind":"property","title":"isRuleError","roleHeading":"Instance Property","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isRuleError","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"modules":[{"name":"Auth0"}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isRuleError"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isRuleError":{"kind":"symbol","title":"isRuleError","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isRuleError"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isRuleError","abstract":[{"text":"When an Auth0 rule returns an error.","type":"text"},{"text":" ","type":"text"},{"text":"The message returned by the rule is available in ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/localizedDescription","type":"reference"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/authenticationerror\/isruleerror"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/localizedDescription":{"kind":"symbol","title":"localizedDescription","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"localizedDescription"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/localizedDescription","abstract":[{"type":"text","text":"Description of the error."}],"url":"\/documentation\/auth0\/auth0error\/localizeddescription"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ 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 b9f607fea..071ecaff0 100644 --- a/docs/data/documentation/auth0/authenticationerror/istoomanyattempts.json +++ b/docs/data/documentation/auth0/authenticationerror/istoomanyattempts.json @@ -1 +1 @@ -{"metadata":{"roleHeading":"Instance Property","role":"symbol","externalID":"s:5Auth019AuthenticationErrorV17isTooManyAttemptsSbvp","modules":[{"name":"Auth0"}],"title":"isTooManyAttempts","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isTooManyAttempts","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"symbolKind":"property"},"kind":"symbol","schemaVersion":{"minor":3,"patch":0,"major":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/istoomanyattempts"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isTooManyAttempts","interfaceLanguage":"swift"},"sections":[],"abstract":[{"type":"text","text":"When the user is blocked due to too many attempts to log in."}],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isTooManyAttempts"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isTooManyAttempts":{"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isTooManyAttempts"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"type":"topic","title":"isTooManyAttempts","url":"\/documentation\/auth0\/authenticationerror\/istoomanyattempts","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isTooManyAttempts","abstract":[{"type":"text","text":"When the user is blocked due to too many attempts to log in."}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"metadata":{"symbolKind":"property","title":"isTooManyAttempts","externalID":"s:5Auth019AuthenticationErrorV17isTooManyAttemptsSbvp","roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isTooManyAttempts","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"role":"symbol"},"sections":[],"variants":[{"paths":["\/documentation\/auth0\/authenticationerror\/istoomanyattempts"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isTooManyAttempts"},"kind":"symbol","abstract":[{"type":"text","text":"When the user is blocked due to too many attempts to log in."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isTooManyAttempts","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}]}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isTooManyAttempts":{"type":"topic","title":"isTooManyAttempts","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isTooManyAttempts","kind":"symbol","url":"\/documentation\/auth0\/authenticationerror\/istoomanyattempts","abstract":[{"type":"text","text":"When the user is blocked due to too many attempts to log in."}],"role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isTooManyAttempts","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"}}} \ 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 f7fda910d..afbf9055b 100644 --- a/docs/data/documentation/auth0/authenticationerror/isverificationrequired.json +++ b/docs/data/documentation/auth0/authenticationerror/isverificationrequired.json @@ -1 +1 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isVerificationRequired","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"When an additional verification step is required."}],"sections":[],"metadata":{"externalID":"s:5Auth019AuthenticationErrorV22isVerificationRequiredSbvp","symbolKind":"property","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isVerificationRequired"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"modules":[{"name":"Auth0"}],"title":"isVerificationRequired","roleHeading":"Instance Property"},"kind":"symbol","primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isVerificationRequired"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/isverificationrequired"]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isVerificationRequired":{"abstract":[{"type":"text","text":"When an additional verification step is required."}],"url":"\/documentation\/auth0\/authenticationerror\/isverificationrequired","type":"topic","title":"isVerificationRequired","kind":"symbol","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isVerificationRequired","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isVerificationRequired"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]}}} \ No newline at end of file +{"metadata":{"symbolKind":"property","title":"isVerificationRequired","externalID":"s:5Auth019AuthenticationErrorV22isVerificationRequiredSbvp","roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isVerificationRequired"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"role":"symbol"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/isverificationrequired"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isVerificationRequired","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"type":"text","text":"When an additional verification step is required."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isVerificationRequired"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/isVerificationRequired":{"kind":"symbol","title":"isVerificationRequired","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isVerificationRequired"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/isVerificationRequired","abstract":[{"text":"When an additional verification step is required.","type":"text"}],"url":"\/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 f93b2f280..cfff0b838 100644 --- a/docs/data/documentation/auth0/authenticationerror/localizeddescription.json +++ b/docs/data/documentation/auth0/authenticationerror/localizeddescription.json @@ -1 +1 @@ -{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/localizedDescription"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"sections":[],"abstract":[{"text":"Description of the error.","type":"text"}],"primaryContentSections":[{"declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"localizedDescription","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"},{"content":[{"type":"heading","level":2,"text":"Discussion","anchor":"discussion"},{"type":"aside","content":[{"type":"paragraph","inlineContent":[{"text":"You should avoid displaying the error description to the user, it’s meant for ","type":"text"},{"inlineContent":[{"type":"text","text":"debugging"}],"type":"strong"},{"text":" only.","type":"text"}]}],"name":"Important","style":"important"}],"kind":"content"}],"kind":"symbol","metadata":{"role":"symbol","roleHeading":"Instance Property","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"localizedDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"externalID":"s:5Auth00A5ErrorPAAE20localizedDescriptionSSvp::SYNTHESIZED::s:5Auth019AuthenticationErrorV","extendedModule":"Auth0","title":"localizedDescription","modules":[{"name":"Auth0"}],"symbolKind":"property"},"variants":[{"paths":["\/documentation\/auth0\/authenticationerror\/localizeddescription"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/localizedDescription":{"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"localizedDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/localizedDescription","url":"\/documentation\/auth0\/authenticationerror\/localizeddescription","kind":"symbol","abstract":[{"text":"Description of the error.","type":"text"}],"title":"localizedDescription","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"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"]]},"metadata":{"extendedModule":"Auth0","symbolKind":"property","modules":[{"name":"Auth0"}],"title":"localizedDescription","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"localizedDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"externalID":"s:5Auth00A5ErrorPAAE20localizedDescriptionSSvp::SYNTHESIZED::s:5Auth019AuthenticationErrorV","role":"symbol","roleHeading":"Instance Property"},"sections":[],"abstract":[{"type":"text","text":"Description of the error."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/localizeddescription"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/localizedDescription","interfaceLanguage":"swift"},"kind":"symbol","schemaVersion":{"patch":0,"minor":3,"major":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"localizedDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}]},{"kind":"content","content":[{"type":"heading","level":2,"anchor":"discussion","text":"Discussion"},{"style":"important","content":[{"inlineContent":[{"type":"text","text":"You should avoid displaying the error description to the user, it’s meant for "},{"type":"strong","inlineContent":[{"text":"debugging","type":"text"}]},{"type":"text","text":" only."}],"type":"paragraph"}],"type":"aside","name":"Important"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/localizedDescription":{"url":"\/documentation\/auth0\/authenticationerror\/localizeddescription","abstract":[{"type":"text","text":"Description of the error."}],"title":"localizedDescription","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"localizedDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/localizedDescription","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"}}} \ 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 492747fe1..97ef7fe23 100644 --- a/docs/data/documentation/auth0/authenticationerror/localizederror-implementations.json +++ b/docs/data/documentation/auth0/authenticationerror/localizederror-implementations.json @@ -1 +1 @@ -{"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"article","topicSections":[{"anchor":"Instance-Properties","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"],"generated":true}],"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"metadata":{"modules":[{"name":"Auth0"}],"roleHeading":"API Collection","title":"LocalizedError Implementations","role":"collectionGroup"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/LocalizedError-Implementations"},"variants":[{"paths":["\/documentation\/auth0\/authenticationerror\/localizederror-implementations"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/failureReason":{"title":"failureReason","kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"failureReason"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/failureReason","abstract":[],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror\/failurereason"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/helpAnchor":{"title":"helpAnchor","kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"helpAnchor"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/helpAnchor","abstract":[],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror\/helpanchor"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/recoverySuggestion":{"title":"recoverySuggestion","kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"recoverySuggestion"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/recoverySuggestion","abstract":[],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror\/recoverysuggestion"}}} \ No newline at end of file +{"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/LocalizedError-Implementations","interfaceLanguage":"swift"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/localizederror-implementations"]}],"kind":"article","metadata":{"title":"LocalizedError Implementations","modules":[{"name":"Auth0"}],"roleHeading":"API Collection","role":"collectionGroup"},"schemaVersion":{"major":0,"minor":3,"patch":0},"topicSections":[{"title":"Instance Properties","generated":true,"anchor":"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"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/helpAnchor":{"title":"helpAnchor","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/helpAnchor","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"helpAnchor"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}],"abstract":[],"url":"\/documentation\/auth0\/authenticationerror\/helpanchor"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/recoverySuggestion":{"title":"recoverySuggestion","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/recoverySuggestion","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"recoverySuggestion"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}],"abstract":[],"url":"\/documentation\/auth0\/authenticationerror\/recoverysuggestion"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/failureReason":{"title":"failureReason","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/failureReason","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"failureReason"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"abstract":[],"url":"\/documentation\/auth0\/authenticationerror\/failurereason"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authenticationerror/message.json b/docs/data/documentation/auth0/authenticationerror/message.json new file mode 100644 index 000000000..346110be8 --- /dev/null +++ b/docs/data/documentation/auth0/authenticationerror/message.json @@ -0,0 +1 @@ +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/message"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"message"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}]}]}],"sections":[],"schemaVersion":{"patch":0,"major":0,"minor":3},"kind":"symbol","metadata":{"externalID":"s:5Auth019AuthenticationErrorV7messageSSvp","extendedModule":"Auth0","symbolKind":"property","title":"message","role":"symbol","roleHeading":"Instance Property","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"message","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"modules":[{"name":"Auth0"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/message","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/message":{"kind":"symbol","title":"message","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"message"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/message","abstract":[],"url":"\/documentation\/auth0\/authenticationerror\/message"}}} \ 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 c6ece6bde..c05af2ba9 100644 --- a/docs/data/documentation/auth0/authenticationerror/recoverysuggestion.json +++ b/docs/data/documentation/auth0/authenticationerror/recoverysuggestion.json @@ -1 +1 @@ -{"sections":[],"abstract":[{"text":"Inherited from ","type":"text"},{"code":"LocalizedError.recoverySuggestion","type":"codeVoice"},{"text":".","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"recoverySuggestion"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"? { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"languages":["swift"]}]}],"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/authenticationerror\/recoverysuggestion"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"metadata":{"externalID":"s:10Foundation14LocalizedErrorPAAE18recoverySuggestionSSSgvp::SYNTHESIZED::s:5Auth019AuthenticationErrorV","platforms":[{"name":"iOS","introducedAt":"8.0","unavailable":false,"deprecated":false,"beta":false},{"name":"iPadOS","introducedAt":"8.0","unavailable":false,"deprecated":false,"beta":false},{"name":"Mac Catalyst","introducedAt":"8.0","unavailable":false,"deprecated":false,"beta":false},{"name":"macOS","introducedAt":"10.10","unavailable":false,"deprecated":false,"beta":false},{"name":"tvOS","introducedAt":"9.0","unavailable":false,"deprecated":false,"beta":false},{"name":"watchOS","introducedAt":"2.0","unavailable":false,"deprecated":false,"beta":false}],"extendedModule":"Foundation","title":"recoverySuggestion","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"recoverySuggestion"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}],"modules":[{"name":"Auth0","relatedModules":["Foundation"]}],"role":"symbol","symbolKind":"property","roleHeading":"Instance Property"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/recoverySuggestion"},"schemaVersion":{"minor":3,"patch":0,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/recoverySuggestion":{"title":"recoverySuggestion","kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"recoverySuggestion"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/recoverySuggestion","abstract":[],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationerror\/recoverysuggestion"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"recoverySuggestion","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"? { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}]}]}],"sections":[],"abstract":[{"type":"text","text":"Inherited from "},{"code":"LocalizedError.recoverySuggestion","type":"codeVoice"},{"type":"text","text":"."}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/recoverysuggestion"]}],"metadata":{"role":"symbol","title":"recoverySuggestion","modules":[{"name":"Auth0","relatedModules":["Foundation"]}],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"recoverySuggestion"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"externalID":"s:10Foundation14LocalizedErrorPAAE18recoverySuggestionSSSgvp::SYNTHESIZED::s:5Auth019AuthenticationErrorV","extendedModule":"Foundation","roleHeading":"Instance Property","platforms":[{"beta":false,"introducedAt":"8.0","deprecated":false,"name":"iOS","unavailable":false},{"beta":false,"introducedAt":"8.0","deprecated":false,"name":"iPadOS","unavailable":false},{"beta":false,"introducedAt":"8.0","deprecated":false,"name":"Mac Catalyst","unavailable":false},{"beta":false,"introducedAt":"10.10","deprecated":false,"name":"macOS","unavailable":false},{"beta":false,"introducedAt":"9.0","deprecated":false,"name":"tvOS","unavailable":false},{"beta":false,"introducedAt":"2.0","deprecated":false,"name":"watchOS","unavailable":false}],"symbolKind":"property"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/recoverySuggestion","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/recoverySuggestion":{"title":"recoverySuggestion","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/recoverySuggestion","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"recoverySuggestion"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}],"abstract":[],"url":"\/documentation\/auth0\/authenticationerror\/recoverysuggestion"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authenticationerror/statuscode.json b/docs/data/documentation/auth0/authenticationerror/statuscode.json index f3927e863..dd2dcec0c 100644 --- a/docs/data/documentation/auth0/authenticationerror/statuscode.json +++ b/docs/data/documentation/auth0/authenticationerror/statuscode.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"statusCode"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"}],"languages":["swift"],"platforms":["iOS"]}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/statusCode","interfaceLanguage":"swift"},"schemaVersion":{"minor":3,"major":0,"patch":0},"sections":[],"metadata":{"symbolKind":"property","modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","role":"symbol","title":"statusCode","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"statusCode"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"}],"externalID":"s:5Auth019AuthenticationErrorV10statusCodeSivp"},"abstract":[{"type":"text","text":"HTTP status code of the response."}],"variants":[{"paths":["\/documentation\/auth0\/authenticationerror\/statuscode"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/statusCode":{"type":"topic","abstract":[{"type":"text","text":"HTTP status code of the response."}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"statusCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/statusCode","kind":"symbol","url":"\/documentation\/auth0\/authenticationerror\/statuscode","title":"statusCode","role":"symbol"}}} \ No newline at end of file +{"abstract":[{"type":"text","text":"HTTP status code of the response."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"statusCode","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Int","preciseIdentifier":"s:Si","kind":"typeIdentifier"}],"languages":["swift"],"platforms":["iOS"]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationerror\/statuscode"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"]]},"metadata":{"modules":[{"name":"Auth0"}],"symbolKind":"property","roleHeading":"Instance Property","title":"statusCode","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"statusCode","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Int","preciseIdentifier":"s:Si","kind":"typeIdentifier"}],"externalID":"s:5Auth019AuthenticationErrorV10statusCodeSivp"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/statusCode"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError/statusCode":{"kind":"symbol","title":"statusCode","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"statusCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError\/statusCode","abstract":[{"text":"HTTP status code of the response.","type":"text"}],"url":"\/documentation\/auth0\/authenticationerror\/statuscode"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authenticationmethod.json b/docs/data/documentation/auth0/authenticationmethod.json index ce59d45b1..b4aad0702 100644 --- a/docs/data/documentation/auth0/authenticationmethod.json +++ b/docs/data/documentation/auth0/authenticationmethod.json @@ -1 +1 @@ -{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationmethod"]}],"metadata":{"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationMethod"}],"title":"AuthenticationMethod","modules":[{"name":"Auth0"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationMethod"}],"externalID":"s:5Auth020AuthenticationMethodV","role":"symbol","roleHeading":"Structure","symbolKind":"struct"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"kind":"symbol","topicSections":[{"generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/init(from:)"],"anchor":"Initializers","title":"Initializers"},{"generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/confirmed","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/createdAt","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/credentialBackedUp","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/credentialDeviceType","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/id","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/identityUserId","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/keyId","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/lastPasswordReset","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/name","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/phoneNumber","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/preferredAuthenticationMethod","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/publicKey","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/transports","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/type","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/usage","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/userAgent","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/userHandle"],"anchor":"Instance-Properties","title":"Instance Properties"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod","interfaceLanguage":"swift"},"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"relationshipsSections":[{"kind":"relationships","type":"conformsTo","identifiers":["doc:\/\/com.auth0.Auth0\/Se"],"title":"Conforms To"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationMethod"}]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationMethod","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod","navigatorTitle":[{"text":"AuthenticationMethod","kind":"identifier"}],"abstract":[],"title":"AuthenticationMethod","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/authenticationmethod"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod/transports":{"url":"\/documentation\/auth0\/authenticationmethod\/transports","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"transports"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"]?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/transports","type":"topic","title":"transports","abstract":[{"type":"text","text":"The transports used by clients to communicate with the authenticator"}],"role":"symbol","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod/credentialDeviceType":{"role":"symbol","title":"credentialDeviceType","abstract":[{"type":"text","text":"Enum: “multi_device” “single_device”"}],"url":"\/documentation\/auth0\/authenticationmethod\/credentialdevicetype","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/credentialDeviceType","type":"topic","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"credentialDeviceType"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod/preferredAuthenticationMethod":{"title":"preferredAuthenticationMethod","url":"\/documentation\/auth0\/authenticationmethod\/preferredauthenticationmethod","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/preferredAuthenticationMethod","role":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"preferredAuthenticationMethod"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"The preferred communication method via phone (sms or voice)."}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod/phoneNumber":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/phoneNumber","role":"symbol","title":"phoneNumber","url":"\/documentation\/auth0\/authenticationmethod\/phonenumber","kind":"symbol","abstract":[{"type":"text","text":"The destination phone number used to send verification codes via text and voice."}],"type":"topic","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"phoneNumber","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod/createdAt":{"type":"topic","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"createdAt","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"kind":"symbol","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/createdAt","abstract":[{"type":"text","text":"The date and time when the authentication method was created"}],"title":"createdAt","url":"\/documentation\/auth0\/authenticationmethod\/createdat"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod/init(from:)":{"title":"init(from:)","url":"\/documentation\/auth0\/authenticationmethod\/init(from:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": any "},{"kind":"typeIdentifier","text":"Decoder","preciseIdentifier":"s:s7DecoderP"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/init(from:)","type":"topic","abstract":[],"kind":"symbol","role":"symbol"},"doc://com.auth0.Auth0/Se":{"identifier":"doc:\/\/com.auth0.Auth0\/Se","title":"Swift.Decodable","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod/userHandle":{"title":"userHandle","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/userHandle","kind":"symbol","url":"\/documentation\/auth0\/authenticationmethod\/userhandle","role":"symbol","abstract":[{"type":"text","text":"The user handle of the user identity"}],"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"userHandle","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod/id":{"title":"id","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/id","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"id","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"kind":"symbol","abstract":[{"type":"text","text":"The ID of the user identity linked with the authentication method"}],"url":"\/documentation\/auth0\/authenticationmethod\/id","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod/name":{"type":"topic","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"name"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"title":"name","kind":"symbol","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/name","abstract":[{"text":"The friendly name of the authentication method","type":"text"}],"url":"\/documentation\/auth0\/authenticationmethod\/name"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod/confirmed":{"type":"topic","title":"confirmed","url":"\/documentation\/auth0\/authenticationmethod\/confirmed","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/confirmed","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"confirmed"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":"?"}],"role":"symbol","kind":"symbol","abstract":[{"type":"text","text":"The authentication method status"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod/lastPasswordReset":{"title":"lastPasswordReset","role":"symbol","url":"\/documentation\/auth0\/authenticationmethod\/lastpasswordreset","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/lastPasswordReset","abstract":[{"type":"text","text":"The date of the last password reset"}],"type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"lastPasswordReset"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod/publicKey":{"url":"\/documentation\/auth0\/authenticationmethod\/publickey","title":"publicKey","kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"publicKey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"The public key"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/publicKey","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod/credentialBackedUp":{"role":"symbol","kind":"symbol","title":"credentialBackedUp","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/credentialBackedUp","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"credentialBackedUp","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"type":"topic","abstract":[{"type":"text","text":"Whether the credential was backed up"}],"url":"\/documentation\/auth0\/authenticationmethod\/credentialbackedup"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod/type":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/type","url":"\/documentation\/auth0\/authenticationmethod\/type","kind":"symbol","title":"type","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"type","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"role":"symbol","abstract":[{"type":"text","text":"Authentication method type (factor)"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod/usage":{"kind":"symbol","abstract":[{"type":"text","text":"Primary and\/or secondary factor"}],"title":"usage","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"usage"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"]"}],"type":"topic","url":"\/documentation\/auth0\/authenticationmethod\/usage","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/usage"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod/userAgent":{"kind":"symbol","abstract":[{"type":"text","text":"The user-agent of the browser used to create the passkey"}],"title":"userAgent","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationmethod\/useragent","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/userAgent","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"userAgent","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod/identityUserId":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/identityUserId","abstract":[{"type":"text","text":"The ID of the user identity linked with the authentication method"}],"title":"identityUserId","url":"\/documentation\/auth0\/authenticationmethod\/identityuserid","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"identityUserId","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod/keyId":{"abstract":[{"text":"The ID of the credential","type":"text"}],"role":"symbol","url":"\/documentation\/auth0\/authenticationmethod\/keyid","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/keyId","kind":"symbol","title":"keyId","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"type":"topic"}}} \ No newline at end of file +{"variants":[{"paths":["\/documentation\/auth0\/authenticationmethod"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"topicSections":[{"title":"Initializers","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/init(from:)"],"anchor":"Initializers","generated":true},{"title":"Instance Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/confirmed","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/createdAt","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/credentialBackedUp","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/credentialDeviceType","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/id","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/identityUserId","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/keyId","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/lastPasswordReset","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/name","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/phoneNumber","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/preferredAuthenticationMethod","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/publicKey","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/transports","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/type","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/usage","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/userAgent","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/userHandle"],"anchor":"Instance-Properties","generated":true}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationMethod","kind":"identifier"}]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","sections":[],"relationshipsSections":[{"type":"conformsTo","kind":"relationships","title":"Conforms To","identifiers":["doc:\/\/com.auth0.Auth0\/Se"]}],"metadata":{"externalID":"s:5Auth020AuthenticationMethodV","symbolKind":"struct","title":"AuthenticationMethod","roleHeading":"Structure","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationMethod","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationMethod"}],"modules":[{"name":"Auth0"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod/publicKey":{"url":"\/documentation\/auth0\/authenticationmethod\/publickey","abstract":[{"type":"text","text":"The public key"}],"title":"publicKey","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"publicKey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/publicKey","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod/preferredAuthenticationMethod":{"kind":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"preferredAuthenticationMethod","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"title":"preferredAuthenticationMethod","type":"topic","role":"symbol","abstract":[{"text":"The preferred communication method via phone (sms or voice).","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/preferredAuthenticationMethod","url":"\/documentation\/auth0\/authenticationmethod\/preferredauthenticationmethod"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod/phoneNumber":{"type":"topic","title":"phoneNumber","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/phoneNumber","kind":"symbol","url":"\/documentation\/auth0\/authenticationmethod\/phonenumber","abstract":[{"text":"The destination phone number used to send verification codes via text and voice.","type":"text"}],"role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"phoneNumber"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod/type":{"kind":"symbol","title":"type","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"type","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/type","abstract":[{"text":"Authentication method type (factor)","type":"text"}],"url":"\/documentation\/auth0\/authenticationmethod\/type"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod/identityUserId":{"url":"\/documentation\/auth0\/authenticationmethod\/identityuserid","title":"identityUserId","abstract":[{"type":"text","text":"The ID of the user identity linked with the authentication method"}],"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"identityUserId","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/identityUserId","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod/createdAt":{"type":"topic","abstract":[{"type":"text","text":"The date and time when the authentication method was created"}],"title":"createdAt","url":"\/documentation\/auth0\/authenticationmethod\/createdat","kind":"symbol","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"createdAt","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/createdAt"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod/id":{"type":"topic","abstract":[{"type":"text","text":"The ID of the user identity linked with the authentication method"}],"title":"id","url":"\/documentation\/auth0\/authenticationmethod\/id","kind":"symbol","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"id","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/id"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod/transports":{"url":"\/documentation\/auth0\/authenticationmethod\/transports","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"transports"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"]?"}],"title":"transports","type":"topic","role":"symbol","abstract":[{"text":"The transports used by clients to communicate with the authenticator","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/transports","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod/keyId":{"type":"topic","abstract":[{"type":"text","text":"The ID of the credential"}],"title":"keyId","url":"\/documentation\/auth0\/authenticationmethod\/keyid","kind":"symbol","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"keyId","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/keyId"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod/userAgent":{"type":"topic","title":"userAgent","url":"\/documentation\/auth0\/authenticationmethod\/useragent","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/userAgent","abstract":[{"text":"The user-agent of the browser used to create the passkey","type":"text"}],"role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"userAgent","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod/usage":{"type":"topic","abstract":[{"type":"text","text":"Primary and\/or secondary factor"}],"title":"usage","url":"\/documentation\/auth0\/authenticationmethod\/usage","kind":"symbol","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"usage","kind":"identifier"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"]","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/usage"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod/credentialBackedUp":{"type":"topic","title":"credentialBackedUp","url":"\/documentation\/auth0\/authenticationmethod\/credentialbackedup","kind":"symbol","abstract":[{"type":"text","text":"Whether the credential was backed up"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/credentialBackedUp","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"credentialBackedUp"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":"?"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod/lastPasswordReset":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/lastPasswordReset","kind":"symbol","title":"lastPasswordReset","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"lastPasswordReset","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"role":"symbol","url":"\/documentation\/auth0\/authenticationmethod\/lastpasswordreset","abstract":[{"text":"The date of the last password reset","type":"text"}],"type":"topic"},"doc://com.auth0.Auth0/Se":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/Se","title":"Swift.Decodable"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod/name":{"type":"topic","abstract":[{"type":"text","text":"The friendly name of the authentication method"}],"title":"name","kind":"symbol","url":"\/documentation\/auth0\/authenticationmethod\/name","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"name"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/name"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod":{"role":"symbol","title":"AuthenticationMethod","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationMethod"}],"navigatorTitle":[{"text":"AuthenticationMethod","kind":"identifier"}],"abstract":[],"kind":"symbol","url":"\/documentation\/auth0\/authenticationmethod","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod/init(from:)":{"type":"topic","title":"init(from:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/init(from:)","kind":"symbol","abstract":[],"url":"\/documentation\/auth0\/authenticationmethod\/init(from:)","role":"symbol","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": any "},{"preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier","text":"Decoder"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod/confirmed":{"title":"confirmed","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/confirmed","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"confirmed"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"The authentication method status"}],"url":"\/documentation\/auth0\/authenticationmethod\/confirmed"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod/credentialDeviceType":{"kind":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"credentialDeviceType","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"title":"credentialDeviceType","type":"topic","role":"symbol","abstract":[{"text":"Enum: “multi_device” “single_device”","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/credentialDeviceType","url":"\/documentation\/auth0\/authenticationmethod\/credentialdevicetype"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod/userHandle":{"kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"userHandle"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}],"title":"userHandle","type":"topic","role":"symbol","abstract":[{"text":"The user handle of the user identity","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/userHandle","url":"\/documentation\/auth0\/authenticationmethod\/userhandle"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authenticationmethod/confirmed.json b/docs/data/documentation/auth0/authenticationmethod/confirmed.json index fd792541f..83802c04f 100644 --- a/docs/data/documentation/auth0/authenticationmethod/confirmed.json +++ b/docs/data/documentation/auth0/authenticationmethod/confirmed.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod"]]},"metadata":{"role":"symbol","modules":[{"name":"Auth0"}],"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"confirmed","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"symbolKind":"property","externalID":"s:5Auth020AuthenticationMethodV9confirmedSbSgvp","roleHeading":"Instance Property","title":"confirmed"},"abstract":[{"text":"The authentication method status","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"confirmed","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/confirmed"},"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/authenticationmethod\/confirmed"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod/confirmed":{"type":"topic","title":"confirmed","url":"\/documentation\/auth0\/authenticationmethod\/confirmed","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/confirmed","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"confirmed"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":"?"}],"role":"symbol","kind":"symbol","abstract":[{"type":"text","text":"The authentication method status"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationMethod","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod","navigatorTitle":[{"text":"AuthenticationMethod","kind":"identifier"}],"abstract":[],"title":"AuthenticationMethod","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/authenticationmethod"}}} \ No newline at end of file +{"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/confirmed","interfaceLanguage":"swift"},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"confirmed","kind":"identifier"},{"kind":"text","text":": "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"kind":"text","text":"?"}]}],"kind":"declarations"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationmethod\/confirmed"]}],"kind":"symbol","metadata":{"role":"symbol","modules":[{"name":"Auth0"}],"title":"confirmed","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"confirmed","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":"?"}],"externalID":"s:5Auth020AuthenticationMethodV9confirmedSbSgvp","roleHeading":"Instance Property","symbolKind":"property"},"schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"type":"text","text":"The authentication method status"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod":{"role":"symbol","title":"AuthenticationMethod","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationMethod"}],"navigatorTitle":[{"text":"AuthenticationMethod","kind":"identifier"}],"abstract":[],"kind":"symbol","url":"\/documentation\/auth0\/authenticationmethod","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod/confirmed":{"title":"confirmed","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/confirmed","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"confirmed"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"The authentication method status"}],"url":"\/documentation\/auth0\/authenticationmethod\/confirmed"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authenticationmethod/createdat.json b/docs/data/documentation/auth0/authenticationmethod/createdat.json index 0638364e4..008bc1aad 100644 --- a/docs/data/documentation/auth0/authenticationmethod/createdat.json +++ b/docs/data/documentation/auth0/authenticationmethod/createdat.json @@ -1 +1 @@ -{"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/createdAt"},"kind":"symbol","metadata":{"title":"createdAt","roleHeading":"Instance Property","externalID":"s:5Auth020AuthenticationMethodV9createdAtSSvp","modules":[{"name":"Auth0"}],"role":"symbol","symbolKind":"property","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"createdAt","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}]},"schemaVersion":{"patch":0,"major":0,"minor":3},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod"]]},"abstract":[{"text":"The date and time when the authentication method was created","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"createdAt","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"platforms":["iOS"],"languages":["swift"]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationmethod\/createdat"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod/createdAt":{"type":"topic","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"createdAt","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"kind":"symbol","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/createdAt","abstract":[{"type":"text","text":"The date and time when the authentication method was created"}],"title":"createdAt","url":"\/documentation\/auth0\/authenticationmethod\/createdat"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationMethod","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod","navigatorTitle":[{"text":"AuthenticationMethod","kind":"identifier"}],"abstract":[],"title":"AuthenticationMethod","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/authenticationmethod"}}} \ No newline at end of file +{"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/createdAt","interfaceLanguage":"swift"},"kind":"symbol","metadata":{"externalID":"s:5Auth020AuthenticationMethodV9createdAtSSvp","modules":[{"name":"Auth0"}],"title":"createdAt","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"createdAt"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"roleHeading":"Instance Property","role":"symbol","symbolKind":"property"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationmethod\/createdat"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod"]]},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"createdAt"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}]}],"kind":"declarations"}],"abstract":[{"type":"text","text":"The date and time when the authentication method was created"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod":{"role":"symbol","title":"AuthenticationMethod","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationMethod"}],"navigatorTitle":[{"text":"AuthenticationMethod","kind":"identifier"}],"abstract":[],"kind":"symbol","url":"\/documentation\/auth0\/authenticationmethod","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod/createdAt":{"type":"topic","abstract":[{"type":"text","text":"The date and time when the authentication method was created"}],"title":"createdAt","url":"\/documentation\/auth0\/authenticationmethod\/createdat","kind":"symbol","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"createdAt","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/createdAt"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authenticationmethod/credentialbackedup.json b/docs/data/documentation/auth0/authenticationmethod/credentialbackedup.json index 041c53408..2e13a0f39 100644 --- a/docs/data/documentation/auth0/authenticationmethod/credentialbackedup.json +++ b/docs/data/documentation/auth0/authenticationmethod/credentialbackedup.json @@ -1 +1 @@ -{"sections":[],"schemaVersion":{"patch":0,"minor":3,"major":0},"abstract":[{"type":"text","text":"Whether the credential was backed up"}],"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/credentialBackedUp"},"metadata":{"title":"credentialBackedUp","symbolKind":"property","externalID":"s:5Auth020AuthenticationMethodV18credentialBackedUpSbSgvp","role":"symbol","modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"credentialBackedUp"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":"?"}]},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"credentialBackedUp"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"},{"kind":"text","text":"?"}],"platforms":["iOS"]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationmethod\/credentialbackedup"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod/credentialBackedUp":{"role":"symbol","kind":"symbol","title":"credentialBackedUp","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/credentialBackedUp","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"credentialBackedUp","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"type":"topic","abstract":[{"type":"text","text":"Whether the credential was backed up"}],"url":"\/documentation\/auth0\/authenticationmethod\/credentialbackedup"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationMethod","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod","navigatorTitle":[{"text":"AuthenticationMethod","kind":"identifier"}],"abstract":[],"title":"AuthenticationMethod","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/authenticationmethod"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"metadata":{"symbolKind":"property","roleHeading":"Instance Property","externalID":"s:5Auth020AuthenticationMethodV18credentialBackedUpSbSgvp","title":"credentialBackedUp","modules":[{"name":"Auth0"}],"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"credentialBackedUp","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"role":"symbol"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationmethod\/credentialbackedup"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/credentialBackedUp","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"type":"text","text":"Whether the credential was backed up"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"credentialBackedUp","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}]}],"schemaVersion":{"patch":0,"minor":3,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod/credentialBackedUp":{"type":"topic","title":"credentialBackedUp","url":"\/documentation\/auth0\/authenticationmethod\/credentialbackedup","kind":"symbol","abstract":[{"type":"text","text":"Whether the credential was backed up"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/credentialBackedUp","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"credentialBackedUp"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":"?"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod":{"role":"symbol","title":"AuthenticationMethod","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationMethod"}],"navigatorTitle":[{"text":"AuthenticationMethod","kind":"identifier"}],"abstract":[],"kind":"symbol","url":"\/documentation\/auth0\/authenticationmethod","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authenticationmethod/credentialdevicetype.json b/docs/data/documentation/auth0/authenticationmethod/credentialdevicetype.json index c08de1761..cd38df56b 100644 --- a/docs/data/documentation/auth0/authenticationmethod/credentialdevicetype.json +++ b/docs/data/documentation/auth0/authenticationmethod/credentialdevicetype.json @@ -1 +1 @@ -{"schemaVersion":{"patch":0,"minor":3,"major":0},"sections":[],"variants":[{"paths":["\/documentation\/auth0\/authenticationmethod\/credentialdevicetype"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"credentialDeviceType","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"languages":["swift"]}],"kind":"declarations"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/credentialDeviceType"},"metadata":{"role":"symbol","externalID":"s:5Auth020AuthenticationMethodV20credentialDeviceTypeSSSgvp","roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"credentialDeviceType"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}],"title":"credentialDeviceType","symbolKind":"property"},"abstract":[{"type":"text","text":"Enum: “multi_device” “single_device”"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationMethod","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod","navigatorTitle":[{"text":"AuthenticationMethod","kind":"identifier"}],"abstract":[],"title":"AuthenticationMethod","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/authenticationmethod"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod/credentialDeviceType":{"role":"symbol","title":"credentialDeviceType","abstract":[{"type":"text","text":"Enum: “multi_device” “single_device”"}],"url":"\/documentation\/auth0\/authenticationmethod\/credentialdevicetype","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/credentialDeviceType","type":"topic","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"credentialDeviceType"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"sections":[],"variants":[{"paths":["\/documentation\/auth0\/authenticationmethod\/credentialdevicetype"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod"]]},"abstract":[{"type":"text","text":"Enum: “multi_device” “single_device”"}],"metadata":{"symbolKind":"property","modules":[{"name":"Auth0"}],"title":"credentialDeviceType","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"credentialDeviceType"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"externalID":"s:5Auth020AuthenticationMethodV20credentialDeviceTypeSSSgvp","role":"symbol","roleHeading":"Instance Property"},"schemaVersion":{"minor":3,"patch":0,"major":0},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"credentialDeviceType"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/credentialDeviceType","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod/credentialDeviceType":{"kind":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"credentialDeviceType","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"title":"credentialDeviceType","type":"topic","role":"symbol","abstract":[{"text":"Enum: “multi_device” “single_device”","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/credentialDeviceType","url":"\/documentation\/auth0\/authenticationmethod\/credentialdevicetype"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod":{"role":"symbol","title":"AuthenticationMethod","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationMethod"}],"navigatorTitle":[{"text":"AuthenticationMethod","kind":"identifier"}],"abstract":[],"kind":"symbol","url":"\/documentation\/auth0\/authenticationmethod","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authenticationmethod/id.json b/docs/data/documentation/auth0/authenticationmethod/id.json index bdeadbc40..14382e7bf 100644 --- a/docs/data/documentation/auth0/authenticationmethod/id.json +++ b/docs/data/documentation/auth0/authenticationmethod/id.json @@ -1 +1 @@ -{"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"id","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"platforms":["iOS"]}],"kind":"declarations"}],"sections":[],"abstract":[{"type":"text","text":"The ID of the user identity linked with the authentication method"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod"]]},"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationmethod\/id"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/id","interfaceLanguage":"swift"},"metadata":{"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"id","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"title":"id","role":"symbol","symbolKind":"property","externalID":"s:5Auth020AuthenticationMethodV2idSSvp"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod/id":{"title":"id","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/id","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"id","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"kind":"symbol","abstract":[{"type":"text","text":"The ID of the user identity linked with the authentication method"}],"url":"\/documentation\/auth0\/authenticationmethod\/id","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationMethod","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod","navigatorTitle":[{"text":"AuthenticationMethod","kind":"identifier"}],"abstract":[],"title":"AuthenticationMethod","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/authenticationmethod"}}} \ No newline at end of file +{"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"id"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}]}],"kind":"declarations"}],"sections":[],"abstract":[{"type":"text","text":"The ID of the user identity linked with the authentication method"}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationmethod\/id"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/id","interfaceLanguage":"swift"},"metadata":{"role":"symbol","title":"id","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"id"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"externalID":"s:5Auth020AuthenticationMethodV2idSSvp","roleHeading":"Instance Property","symbolKind":"property"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod/id":{"type":"topic","abstract":[{"type":"text","text":"The ID of the user identity linked with the authentication method"}],"title":"id","url":"\/documentation\/auth0\/authenticationmethod\/id","kind":"symbol","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"id","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/id"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod":{"role":"symbol","title":"AuthenticationMethod","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationMethod"}],"navigatorTitle":[{"text":"AuthenticationMethod","kind":"identifier"}],"abstract":[],"kind":"symbol","url":"\/documentation\/auth0\/authenticationmethod","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authenticationmethod/identityuserid.json b/docs/data/documentation/auth0/authenticationmethod/identityuserid.json index ded809ffc..46b348100 100644 --- a/docs/data/documentation/auth0/authenticationmethod/identityuserid.json +++ b/docs/data/documentation/auth0/authenticationmethod/identityuserid.json @@ -1 +1 @@ -{"metadata":{"externalID":"s:5Auth020AuthenticationMethodV14identityUserIdSSSgvp","roleHeading":"Instance Property","role":"symbol","title":"identityUserId","symbolKind":"property","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"identityUserId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}]},"abstract":[{"type":"text","text":"The ID of the user identity linked with the authentication method"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/identityUserId"},"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod"]]},"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"identityUserId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationmethod\/identityuserid"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationMethod","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod","navigatorTitle":[{"text":"AuthenticationMethod","kind":"identifier"}],"abstract":[],"title":"AuthenticationMethod","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/authenticationmethod"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod/identityUserId":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/identityUserId","abstract":[{"type":"text","text":"The ID of the user identity linked with the authentication method"}],"title":"identityUserId","url":"\/documentation\/auth0\/authenticationmethod\/identityuserid","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"identityUserId","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"type":"topic"}}} \ No newline at end of file +{"sections":[],"metadata":{"symbolKind":"property","modules":[{"name":"Auth0"}],"title":"identityUserId","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"identityUserId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"externalID":"s:5Auth020AuthenticationMethodV14identityUserIdSSSgvp","role":"symbol","roleHeading":"Instance Property"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/identityUserId"},"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationmethod\/identityuserid"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod"]]},"schemaVersion":{"patch":0,"minor":3,"major":0},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"identityUserId","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"abstract":[{"text":"The ID of the user identity linked with the authentication method","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod/identityUserId":{"url":"\/documentation\/auth0\/authenticationmethod\/identityuserid","title":"identityUserId","abstract":[{"type":"text","text":"The ID of the user identity linked with the authentication method"}],"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"identityUserId","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/identityUserId","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod":{"role":"symbol","title":"AuthenticationMethod","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationMethod"}],"navigatorTitle":[{"text":"AuthenticationMethod","kind":"identifier"}],"abstract":[],"kind":"symbol","url":"\/documentation\/auth0\/authenticationmethod","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authenticationmethod/init(from:).json b/docs/data/documentation/auth0/authenticationmethod/init(from:).json index 9f4b474d0..fb29aa8b1 100644 --- a/docs/data/documentation/auth0/authenticationmethod/init(from:).json +++ b/docs/data/documentation/auth0/authenticationmethod/init(from:).json @@ -1 +1 @@ -{"kind":"symbol","schemaVersion":{"major":0,"patch":0,"minor":3},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationmethod\/init(from:)"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"init","kind":"keyword"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"decoder","kind":"internalParam"},{"text":": any ","kind":"text"},{"text":"Decoder","kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"languages":["swift"]}]}],"abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"Decodable.init(from:)"},{"type":"text","text":"."}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/init(from:)","interfaceLanguage":"swift"},"metadata":{"role":"symbol","modules":[{"name":"Auth0"}],"fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": any "},{"preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier","text":"Decoder"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"title":"init(from:)","roleHeading":"Initializer","externalID":"s:5Auth020AuthenticationMethodV4fromACs7Decoder_p_tKcfc","symbolKind":"init"},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod/init(from:)":{"title":"init(from:)","url":"\/documentation\/auth0\/authenticationmethod\/init(from:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": any "},{"kind":"typeIdentifier","text":"Decoder","preciseIdentifier":"s:s7DecoderP"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/init(from:)","type":"topic","abstract":[],"kind":"symbol","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationMethod","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod","navigatorTitle":[{"text":"AuthenticationMethod","kind":"identifier"}],"abstract":[],"title":"AuthenticationMethod","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/authenticationmethod"}}} \ No newline at end of file +{"metadata":{"symbolKind":"init","roleHeading":"Initializer","title":"init(from:)","externalID":"s:5Auth020AuthenticationMethodV4fromACs7Decoder_p_tKcfc","modules":[{"name":"Auth0"}],"fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":": any ","kind":"text"},{"preciseIdentifier":"s:s7DecoderP","text":"Decoder","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"role":"symbol"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationmethod\/init(from:)"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/init(from:)"},"kind":"symbol","abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"Decodable.init(from:)"},{"type":"text","text":"."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"init","kind":"keyword"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"decoder","kind":"internalParam"},{"text":": any ","kind":"text"},{"preciseIdentifier":"s:s7DecoderP","text":"Decoder","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"languages":["swift"],"platforms":["iOS"]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod/init(from:)":{"type":"topic","title":"init(from:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/init(from:)","kind":"symbol","abstract":[],"url":"\/documentation\/auth0\/authenticationmethod\/init(from:)","role":"symbol","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": any "},{"preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier","text":"Decoder"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod":{"role":"symbol","title":"AuthenticationMethod","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationMethod"}],"navigatorTitle":[{"text":"AuthenticationMethod","kind":"identifier"}],"abstract":[],"kind":"symbol","url":"\/documentation\/auth0\/authenticationmethod","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authenticationmethod/keyid.json b/docs/data/documentation/auth0/authenticationmethod/keyid.json index 6829c14db..a50567bce 100644 --- a/docs/data/documentation/auth0/authenticationmethod/keyid.json +++ b/docs/data/documentation/auth0/authenticationmethod/keyid.json @@ -1 +1 @@ -{"abstract":[{"type":"text","text":"The ID of the credential"}],"metadata":{"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyId"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}],"role":"symbol","roleHeading":"Instance Property","externalID":"s:5Auth020AuthenticationMethodV5keyIdSSSgvp","modules":[{"name":"Auth0"}],"symbolKind":"property","title":"keyId"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/keyId","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"platforms":["iOS"],"languages":["swift"]}]}],"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationmethod\/keyid"]}],"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod/keyId":{"abstract":[{"text":"The ID of the credential","type":"text"}],"role":"symbol","url":"\/documentation\/auth0\/authenticationmethod\/keyid","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/keyId","kind":"symbol","title":"keyId","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationMethod","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod","navigatorTitle":[{"text":"AuthenticationMethod","kind":"identifier"}],"abstract":[],"title":"AuthenticationMethod","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/authenticationmethod"}}} \ No newline at end of file +{"kind":"symbol","primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"platforms":["iOS"]}],"kind":"declarations"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationmethod\/keyid"]}],"sections":[],"schemaVersion":{"minor":3,"patch":0,"major":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/keyId"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod"]]},"abstract":[{"text":"The ID of the credential","type":"text"}],"metadata":{"roleHeading":"Instance Property","symbolKind":"property","role":"symbol","title":"keyId","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"externalID":"s:5Auth020AuthenticationMethodV5keyIdSSSgvp","modules":[{"name":"Auth0"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod":{"role":"symbol","title":"AuthenticationMethod","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationMethod"}],"navigatorTitle":[{"text":"AuthenticationMethod","kind":"identifier"}],"abstract":[],"kind":"symbol","url":"\/documentation\/auth0\/authenticationmethod","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod/keyId":{"type":"topic","abstract":[{"type":"text","text":"The ID of the credential"}],"title":"keyId","url":"\/documentation\/auth0\/authenticationmethod\/keyid","kind":"symbol","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"keyId","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/keyId"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authenticationmethod/lastpasswordreset.json b/docs/data/documentation/auth0/authenticationmethod/lastpasswordreset.json index 3d180af61..8c1f56bf0 100644 --- a/docs/data/documentation/auth0/authenticationmethod/lastpasswordreset.json +++ b/docs/data/documentation/auth0/authenticationmethod/lastpasswordreset.json @@ -1 +1 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/lastPasswordReset","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\/AuthenticationMethod"]]},"variants":[{"paths":["\/documentation\/auth0\/authenticationmethod\/lastpasswordreset"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"type":"text","text":"The date of the last password reset"}],"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"lastPasswordReset","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"platforms":["iOS"]}]}],"metadata":{"role":"symbol","modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","title":"lastPasswordReset","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"lastPasswordReset"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}],"symbolKind":"property","externalID":"s:5Auth020AuthenticationMethodV17lastPasswordResetSSSgvp"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod/lastPasswordReset":{"title":"lastPasswordReset","role":"symbol","url":"\/documentation\/auth0\/authenticationmethod\/lastpasswordreset","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/lastPasswordReset","abstract":[{"type":"text","text":"The date of the last password reset"}],"type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"lastPasswordReset"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationMethod","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod","navigatorTitle":[{"text":"AuthenticationMethod","kind":"identifier"}],"abstract":[],"title":"AuthenticationMethod","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/authenticationmethod"}}} \ No newline at end of file +{"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationmethod\/lastpasswordreset"]}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod"]]},"abstract":[{"text":"The date of the last password reset","type":"text"}],"metadata":{"role":"symbol","modules":[{"name":"Auth0"}],"title":"lastPasswordReset","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"lastPasswordReset"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"externalID":"s:5Auth020AuthenticationMethodV17lastPasswordResetSSSgvp","roleHeading":"Instance Property","symbolKind":"property"},"schemaVersion":{"major":0,"patch":0,"minor":3},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"lastPasswordReset","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/lastPasswordReset","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod/lastPasswordReset":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/lastPasswordReset","kind":"symbol","title":"lastPasswordReset","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"lastPasswordReset","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"role":"symbol","url":"\/documentation\/auth0\/authenticationmethod\/lastpasswordreset","abstract":[{"text":"The date of the last password reset","type":"text"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod":{"role":"symbol","title":"AuthenticationMethod","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationMethod"}],"navigatorTitle":[{"text":"AuthenticationMethod","kind":"identifier"}],"abstract":[],"kind":"symbol","url":"\/documentation\/auth0\/authenticationmethod","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authenticationmethod/name.json b/docs/data/documentation/auth0/authenticationmethod/name.json index ca8a9e567..43b58affc 100644 --- a/docs/data/documentation/auth0/authenticationmethod/name.json +++ b/docs/data/documentation/auth0/authenticationmethod/name.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod"]]},"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/name"},"abstract":[{"type":"text","text":"The friendly name of the authentication method"}],"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationmethod\/name"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"name","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"languages":["swift"]}]}],"metadata":{"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"name","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"role":"symbol","externalID":"s:5Auth020AuthenticationMethodV4nameSSSgvp","symbolKind":"property","title":"name","roleHeading":"Instance Property","modules":[{"name":"Auth0"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationMethod","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod","navigatorTitle":[{"text":"AuthenticationMethod","kind":"identifier"}],"abstract":[],"title":"AuthenticationMethod","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/authenticationmethod"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod/name":{"type":"topic","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"name"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"title":"name","kind":"symbol","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/name","abstract":[{"text":"The friendly name of the authentication method","type":"text"}],"url":"\/documentation\/auth0\/authenticationmethod\/name"}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationmethod\/name"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod"]]},"abstract":[{"type":"text","text":"The friendly name of the authentication method"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"name"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}]}]}],"sections":[],"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"externalID":"s:5Auth020AuthenticationMethodV4nameSSSgvp","symbolKind":"property","title":"name","roleHeading":"Instance Property","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"name"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"modules":[{"name":"Auth0"}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/name"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod":{"role":"symbol","title":"AuthenticationMethod","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationMethod"}],"navigatorTitle":[{"text":"AuthenticationMethod","kind":"identifier"}],"abstract":[],"kind":"symbol","url":"\/documentation\/auth0\/authenticationmethod","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod/name":{"type":"topic","abstract":[{"type":"text","text":"The friendly name of the authentication method"}],"title":"name","kind":"symbol","url":"\/documentation\/auth0\/authenticationmethod\/name","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"name"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/name"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authenticationmethod/phonenumber.json b/docs/data/documentation/auth0/authenticationmethod/phonenumber.json index e847ae8a8..de70fa0b3 100644 --- a/docs/data/documentation/auth0/authenticationmethod/phonenumber.json +++ b/docs/data/documentation/auth0/authenticationmethod/phonenumber.json @@ -1 +1 @@ -{"primaryContentSections":[{"declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"phoneNumber","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/phoneNumber","interfaceLanguage":"swift"},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod"]]},"abstract":[{"type":"text","text":"The destination phone number used to send verification codes via text and voice."}],"variants":[{"paths":["\/documentation\/auth0\/authenticationmethod\/phonenumber"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"metadata":{"symbolKind":"property","modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","role":"symbol","title":"phoneNumber","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"phoneNumber","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"externalID":"s:5Auth020AuthenticationMethodV11phoneNumberSSSgvp"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod/phoneNumber":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/phoneNumber","role":"symbol","title":"phoneNumber","url":"\/documentation\/auth0\/authenticationmethod\/phonenumber","kind":"symbol","abstract":[{"type":"text","text":"The destination phone number used to send verification codes via text and voice."}],"type":"topic","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"phoneNumber","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationMethod","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod","navigatorTitle":[{"text":"AuthenticationMethod","kind":"identifier"}],"abstract":[],"title":"AuthenticationMethod","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/authenticationmethod"}}} \ No newline at end of file +{"metadata":{"externalID":"s:5Auth020AuthenticationMethodV11phoneNumberSSSgvp","modules":[{"name":"Auth0"}],"title":"phoneNumber","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"phoneNumber","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"roleHeading":"Instance Property","role":"symbol","symbolKind":"property"},"sections":[],"variants":[{"paths":["\/documentation\/auth0\/authenticationmethod\/phonenumber"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/phoneNumber","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"text":"The destination phone number used to send verification codes via text and voice.","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"phoneNumber","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"platforms":["iOS"]}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod":{"role":"symbol","title":"AuthenticationMethod","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationMethod"}],"navigatorTitle":[{"text":"AuthenticationMethod","kind":"identifier"}],"abstract":[],"kind":"symbol","url":"\/documentation\/auth0\/authenticationmethod","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod/phoneNumber":{"type":"topic","title":"phoneNumber","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/phoneNumber","kind":"symbol","url":"\/documentation\/auth0\/authenticationmethod\/phonenumber","abstract":[{"text":"The destination phone number used to send verification codes via text and voice.","type":"text"}],"role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"phoneNumber"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authenticationmethod/preferredauthenticationmethod.json b/docs/data/documentation/auth0/authenticationmethod/preferredauthenticationmethod.json index 848098737..56c6b13f5 100644 --- a/docs/data/documentation/auth0/authenticationmethod/preferredauthenticationmethod.json +++ b/docs/data/documentation/auth0/authenticationmethod/preferredauthenticationmethod.json @@ -1 +1 @@ -{"schemaVersion":{"major":0,"patch":0,"minor":3},"abstract":[{"text":"The preferred communication method via phone (sms or voice).","type":"text"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/preferredAuthenticationMethod","interfaceLanguage":"swift"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationmethod\/preferredauthenticationmethod"]}],"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"preferredAuthenticationMethod","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}]}]}],"metadata":{"modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"preferredAuthenticationMethod"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"symbolKind":"property","title":"preferredAuthenticationMethod","roleHeading":"Instance Property","role":"symbol","externalID":"s:5Auth020AuthenticationMethodV09preferredbC0SSSgvp"},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod/preferredAuthenticationMethod":{"title":"preferredAuthenticationMethod","url":"\/documentation\/auth0\/authenticationmethod\/preferredauthenticationmethod","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/preferredAuthenticationMethod","role":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"preferredAuthenticationMethod"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"The preferred communication method via phone (sms or voice)."}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationMethod","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod","navigatorTitle":[{"text":"AuthenticationMethod","kind":"identifier"}],"abstract":[],"title":"AuthenticationMethod","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/authenticationmethod"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod"]]},"metadata":{"modules":[{"name":"Auth0"}],"symbolKind":"property","roleHeading":"Instance Property","title":"preferredAuthenticationMethod","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"preferredAuthenticationMethod","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"externalID":"s:5Auth020AuthenticationMethodV09preferredbC0SSSgvp"},"sections":[],"abstract":[{"type":"text","text":"The preferred communication method via phone (sms or voice)."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationmethod\/preferredauthenticationmethod"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/preferredAuthenticationMethod","interfaceLanguage":"swift"},"kind":"symbol","schemaVersion":{"minor":3,"patch":0,"major":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"preferredAuthenticationMethod","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"platforms":["iOS"]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod":{"role":"symbol","title":"AuthenticationMethod","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationMethod"}],"navigatorTitle":[{"text":"AuthenticationMethod","kind":"identifier"}],"abstract":[],"kind":"symbol","url":"\/documentation\/auth0\/authenticationmethod","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod/preferredAuthenticationMethod":{"kind":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"preferredAuthenticationMethod","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"title":"preferredAuthenticationMethod","type":"topic","role":"symbol","abstract":[{"text":"The preferred communication method via phone (sms or voice).","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/preferredAuthenticationMethod","url":"\/documentation\/auth0\/authenticationmethod\/preferredauthenticationmethod"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authenticationmethod/publickey.json b/docs/data/documentation/auth0/authenticationmethod/publickey.json index 4efeef5a5..debdce834 100644 --- a/docs/data/documentation/auth0/authenticationmethod/publickey.json +++ b/docs/data/documentation/auth0/authenticationmethod/publickey.json @@ -1 +1 @@ -{"schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/publicKey","interfaceLanguage":"swift"},"sections":[],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"publicKey","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}]}],"metadata":{"modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"publicKey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"externalID":"s:5Auth020AuthenticationMethodV9publicKeySSSgvp","roleHeading":"Instance Property","symbolKind":"property","title":"publicKey","role":"symbol"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationmethod\/publickey"]}],"abstract":[{"type":"text","text":"The public key"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod/publicKey":{"url":"\/documentation\/auth0\/authenticationmethod\/publickey","title":"publicKey","kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"publicKey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"The public key"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/publicKey","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationMethod","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod","navigatorTitle":[{"text":"AuthenticationMethod","kind":"identifier"}],"abstract":[],"title":"AuthenticationMethod","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/authenticationmethod"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod"]]},"metadata":{"symbolKind":"property","modules":[{"name":"Auth0"}],"title":"publicKey","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"publicKey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"externalID":"s:5Auth020AuthenticationMethodV9publicKeySSSgvp","role":"symbol","roleHeading":"Instance Property"},"sections":[],"abstract":[{"type":"text","text":"The public key"}],"variants":[{"paths":["\/documentation\/auth0\/authenticationmethod\/publickey"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/publicKey","interfaceLanguage":"swift"},"kind":"symbol","schemaVersion":{"patch":0,"major":0,"minor":3},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"publicKey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod/publicKey":{"url":"\/documentation\/auth0\/authenticationmethod\/publickey","abstract":[{"type":"text","text":"The public key"}],"title":"publicKey","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"publicKey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/publicKey","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod":{"role":"symbol","title":"AuthenticationMethod","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationMethod"}],"navigatorTitle":[{"text":"AuthenticationMethod","kind":"identifier"}],"abstract":[],"kind":"symbol","url":"\/documentation\/auth0\/authenticationmethod","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authenticationmethod/transports.json b/docs/data/documentation/auth0/authenticationmethod/transports.json index 2a4fe98e7..01eb99cbd 100644 --- a/docs/data/documentation/auth0/authenticationmethod/transports.json +++ b/docs/data/documentation/auth0/authenticationmethod/transports.json @@ -1 +1 @@ -{"abstract":[{"type":"text","text":"The transports used by clients to communicate with the authenticator"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod"]]},"schemaVersion":{"minor":3,"major":0,"patch":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/transports","interfaceLanguage":"swift"},"sections":[],"metadata":{"title":"transports","externalID":"s:5Auth020AuthenticationMethodV10transportsSaySSGSgvp","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"transports"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"]?"}],"symbolKind":"property","modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","role":"symbol"},"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationmethod\/transports"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"transports"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"]?"}],"languages":["swift"]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationMethod","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod","navigatorTitle":[{"text":"AuthenticationMethod","kind":"identifier"}],"abstract":[],"title":"AuthenticationMethod","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/authenticationmethod"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod/transports":{"url":"\/documentation\/auth0\/authenticationmethod\/transports","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"transports"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"]?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/transports","type":"topic","title":"transports","abstract":[{"type":"text","text":"The transports used by clients to communicate with the authenticator"}],"role":"symbol","kind":"symbol"}}} \ No newline at end of file +{"abstract":[{"type":"text","text":"The transports used by clients to communicate with the authenticator"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"transports","kind":"identifier"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"]?"}],"platforms":["iOS"]}]}],"variants":[{"paths":["\/documentation\/auth0\/authenticationmethod\/transports"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod"]]},"metadata":{"modules":[{"name":"Auth0"}],"title":"transports","roleHeading":"Instance Property","symbolKind":"property","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"transports"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"]?"}],"externalID":"s:5Auth020AuthenticationMethodV10transportsSaySSGSgvp"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/transports","interfaceLanguage":"swift"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod":{"role":"symbol","title":"AuthenticationMethod","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationMethod"}],"navigatorTitle":[{"text":"AuthenticationMethod","kind":"identifier"}],"abstract":[],"kind":"symbol","url":"\/documentation\/auth0\/authenticationmethod","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod/transports":{"url":"\/documentation\/auth0\/authenticationmethod\/transports","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"transports"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"]?"}],"title":"transports","type":"topic","role":"symbol","abstract":[{"text":"The transports used by clients to communicate with the authenticator","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/transports","kind":"symbol"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authenticationmethod/type.json b/docs/data/documentation/auth0/authenticationmethod/type.json index 522d7cf1e..a2a848f1a 100644 --- a/docs/data/documentation/auth0/authenticationmethod/type.json +++ b/docs/data/documentation/auth0/authenticationmethod/type.json @@ -1 +1 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/type","interfaceLanguage":"swift"},"sections":[],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod"]]},"abstract":[{"text":"Authentication method type (factor)","type":"text"}],"metadata":{"title":"type","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"type","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"symbolKind":"property","externalID":"s:5Auth020AuthenticationMethodV4typeSSSgvp","modules":[{"name":"Auth0"}],"roleHeading":"Instance Property"},"variants":[{"paths":["\/documentation\/auth0\/authenticationmethod\/type"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"type","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationMethod","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod","navigatorTitle":[{"text":"AuthenticationMethod","kind":"identifier"}],"abstract":[],"title":"AuthenticationMethod","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/authenticationmethod"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod/type":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/type","url":"\/documentation\/auth0\/authenticationmethod\/type","kind":"symbol","title":"type","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"type","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"role":"symbol","abstract":[{"type":"text","text":"Authentication method type (factor)"}]}}} \ No newline at end of file +{"kind":"symbol","primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"type"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"platforms":["iOS"]}],"kind":"declarations"}],"variants":[{"paths":["\/documentation\/auth0\/authenticationmethod\/type"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/type","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod"]]},"abstract":[{"text":"Authentication method type (factor)","type":"text"}],"metadata":{"roleHeading":"Instance Property","symbolKind":"property","role":"symbol","title":"type","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"type"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"externalID":"s:5Auth020AuthenticationMethodV4typeSSSgvp","modules":[{"name":"Auth0"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod":{"role":"symbol","title":"AuthenticationMethod","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationMethod"}],"navigatorTitle":[{"text":"AuthenticationMethod","kind":"identifier"}],"abstract":[],"kind":"symbol","url":"\/documentation\/auth0\/authenticationmethod","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod/type":{"kind":"symbol","title":"type","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"type","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/type","abstract":[{"text":"Authentication method type (factor)","type":"text"}],"url":"\/documentation\/auth0\/authenticationmethod\/type"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authenticationmethod/usage.json b/docs/data/documentation/auth0/authenticationmethod/usage.json index 7390965a9..b9d918b39 100644 --- a/docs/data/documentation/auth0/authenticationmethod/usage.json +++ b/docs/data/documentation/auth0/authenticationmethod/usage.json @@ -1 +1 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/usage","interfaceLanguage":"swift"},"metadata":{"externalID":"s:5Auth020AuthenticationMethodV5usageSaySSGvp","role":"symbol","modules":[{"name":"Auth0"}],"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"usage","kind":"identifier"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"]","kind":"text"}],"roleHeading":"Instance Property","title":"usage","symbolKind":"property"},"abstract":[{"text":"Primary and\/or secondary factor","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod"]]},"schemaVersion":{"minor":3,"major":0,"patch":0},"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"usage"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"]"}],"platforms":["iOS"]}],"kind":"declarations"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationmethod\/usage"]}],"sections":[],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationMethod","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod","navigatorTitle":[{"text":"AuthenticationMethod","kind":"identifier"}],"abstract":[],"title":"AuthenticationMethod","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/authenticationmethod"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod/usage":{"kind":"symbol","abstract":[{"type":"text","text":"Primary and\/or secondary factor"}],"title":"usage","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"usage"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"]"}],"type":"topic","url":"\/documentation\/auth0\/authenticationmethod\/usage","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/usage"}}} \ No newline at end of file +{"schemaVersion":{"patch":0,"minor":3,"major":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"usage","kind":"identifier"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"]","kind":"text"}],"platforms":["iOS"]}]}],"sections":[],"abstract":[{"text":"Primary and\/or secondary factor","type":"text"}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationmethod\/usage"]}],"metadata":{"externalID":"s:5Auth020AuthenticationMethodV5usageSaySSGvp","symbolKind":"property","title":"usage","roleHeading":"Instance Property","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"usage"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"]"}],"modules":[{"name":"Auth0"}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/usage"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod/usage":{"type":"topic","abstract":[{"type":"text","text":"Primary and\/or secondary factor"}],"title":"usage","url":"\/documentation\/auth0\/authenticationmethod\/usage","kind":"symbol","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"usage","kind":"identifier"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"]","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/usage"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod":{"role":"symbol","title":"AuthenticationMethod","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationMethod"}],"navigatorTitle":[{"text":"AuthenticationMethod","kind":"identifier"}],"abstract":[],"kind":"symbol","url":"\/documentation\/auth0\/authenticationmethod","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authenticationmethod/useragent.json b/docs/data/documentation/auth0/authenticationmethod/useragent.json index 1cd26c8d6..c43aee13b 100644 --- a/docs/data/documentation/auth0/authenticationmethod/useragent.json +++ b/docs/data/documentation/auth0/authenticationmethod/useragent.json @@ -1 +1 @@ -{"sections":[],"abstract":[{"type":"text","text":"The user-agent of the browser used to create the passkey"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationmethod\/useragent"]}],"schemaVersion":{"major":0,"patch":0,"minor":3},"metadata":{"role":"symbol","title":"userAgent","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"userAgent"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"symbolKind":"property","roleHeading":"Instance Property","externalID":"s:5Auth020AuthenticationMethodV9userAgentSSSgvp","modules":[{"name":"Auth0"}]},"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/userAgent"},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"userAgent","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}]}],"kind":"declarations"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod/userAgent":{"kind":"symbol","abstract":[{"type":"text","text":"The user-agent of the browser used to create the passkey"}],"title":"userAgent","role":"symbol","type":"topic","url":"\/documentation\/auth0\/authenticationmethod\/useragent","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/userAgent","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"userAgent","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationMethod","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod","navigatorTitle":[{"text":"AuthenticationMethod","kind":"identifier"}],"abstract":[],"title":"AuthenticationMethod","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/authenticationmethod"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/userAgent","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"userAgent","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"platforms":["iOS"],"languages":["swift"]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationmethod\/useragent"]}],"kind":"symbol","metadata":{"modules":[{"name":"Auth0"}],"title":"userAgent","externalID":"s:5Auth020AuthenticationMethodV9userAgentSSSgvp","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"userAgent"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"symbolKind":"property","roleHeading":"Instance Property"},"schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"text":"The user-agent of the browser used to create the passkey","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod/userAgent":{"type":"topic","title":"userAgent","url":"\/documentation\/auth0\/authenticationmethod\/useragent","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/userAgent","abstract":[{"text":"The user-agent of the browser used to create the passkey","type":"text"}],"role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"userAgent","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod":{"role":"symbol","title":"AuthenticationMethod","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationMethod"}],"navigatorTitle":[{"text":"AuthenticationMethod","kind":"identifier"}],"abstract":[],"kind":"symbol","url":"\/documentation\/auth0\/authenticationmethod","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authenticationmethod/userhandle.json b/docs/data/documentation/auth0/authenticationmethod/userhandle.json index e629c9ef1..1446ae140 100644 --- a/docs/data/documentation/auth0/authenticationmethod/userhandle.json +++ b/docs/data/documentation/auth0/authenticationmethod/userhandle.json @@ -1 +1 @@ -{"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"metadata":{"symbolKind":"property","role":"symbol","externalID":"s:5Auth020AuthenticationMethodV10userHandleSSSgvp","title":"userHandle","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"userHandle"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}],"roleHeading":"Instance Property"},"abstract":[{"text":"The user handle of the user identity","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"userHandle"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}]}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationmethod\/userhandle"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/userHandle"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationMethod","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod","navigatorTitle":[{"text":"AuthenticationMethod","kind":"identifier"}],"abstract":[],"title":"AuthenticationMethod","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/authenticationmethod"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod/userHandle":{"title":"userHandle","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/userHandle","kind":"symbol","url":"\/documentation\/auth0\/authenticationmethod\/userhandle","role":"symbol","abstract":[{"type":"text","text":"The user handle of the user identity"}],"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"userHandle","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"type":"topic"}}} \ No newline at end of file +{"schemaVersion":{"minor":3,"patch":0,"major":0},"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"userHandle"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"platforms":["iOS"]}],"kind":"declarations"}],"sections":[],"abstract":[{"text":"The user handle of the user identity","type":"text"}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationmethod\/userhandle"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/userHandle","interfaceLanguage":"swift"},"metadata":{"role":"symbol","modules":[{"name":"Auth0"}],"title":"userHandle","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"userHandle"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"externalID":"s:5Auth020AuthenticationMethodV10userHandleSSSgvp","roleHeading":"Instance Property","symbolKind":"property"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod/userHandle":{"kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"userHandle"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}],"title":"userHandle","type":"topic","role":"symbol","abstract":[{"text":"The user handle of the user identity","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod\/userHandle","url":"\/documentation\/auth0\/authenticationmethod\/userhandle"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod":{"role":"symbol","title":"AuthenticationMethod","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationMethod"}],"navigatorTitle":[{"text":"AuthenticationMethod","kind":"identifier"}],"abstract":[],"kind":"symbol","url":"\/documentation\/auth0\/authenticationmethod","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authenticationmethods.json b/docs/data/documentation/auth0/authenticationmethods.json index e57ccf104..dae692fdf 100644 --- a/docs/data/documentation/auth0/authenticationmethods.json +++ b/docs/data/documentation/auth0/authenticationmethods.json @@ -1 +1 @@ -{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethods"},"kind":"symbol","schemaVersion":{"minor":3,"major":0,"patch":0},"abstract":[{"type":"text","text":"List of authentication methods belonging to the authenticated user."}],"sections":[],"metadata":{"role":"symbol","symbolKind":"struct","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationMethods","kind":"identifier"}],"title":"AuthenticationMethods","modules":[{"name":"Auth0"}],"externalID":"s:5Auth021AuthenticationMethodsV","navigatorTitle":[{"kind":"identifier","text":"AuthenticationMethods"}],"roleHeading":"Structure"},"relationshipsSections":[{"kind":"relationships","identifiers":["doc:\/\/com.auth0.Auth0\/Se"],"title":"Conforms To","type":"conformsTo"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationMethods","kind":"identifier"}]}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethods\/init(from:)"],"anchor":"Initializers","title":"Initializers","generated":true},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethods\/authenticationMethods"],"anchor":"Instance-Properties","title":"Instance Properties","generated":true}],"variants":[{"paths":["\/documentation\/auth0\/authenticationmethods"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethods/authenticationMethods":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethods\/authenticationMethods","abstract":[],"role":"symbol","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticationMethods"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth020AuthenticationMethodV","text":"AuthenticationMethod"},{"kind":"text","text":"]"}],"title":"authenticationMethods","url":"\/documentation\/auth0\/authenticationmethods\/authenticationmethods"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethods/init(from:)":{"url":"\/documentation\/auth0\/authenticationmethods\/init(from:)","title":"init(from:)","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":": any ","kind":"text"},{"text":"Decoder","kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"abstract":[],"kind":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethods\/init(from:)","role":"symbol"},"doc://com.auth0.Auth0/Se":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/Se","title":"Swift.Decodable"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethods":{"title":"AuthenticationMethods","navigatorTitle":[{"text":"AuthenticationMethods","kind":"identifier"}],"role":"symbol","abstract":[{"type":"text","text":"List of authentication methods belonging to the authenticated user."}],"url":"\/documentation\/auth0\/authenticationmethods","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationMethods","kind":"identifier"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethods"}}} \ No newline at end of file +{"topicSections":[{"title":"Initializers","generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethods\/init(from:)"],"anchor":"Initializers"},{"title":"Instance Properties","generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethods\/authenticationMethods"],"anchor":"Instance-Properties"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"relationshipsSections":[{"title":"Conforms To","type":"conformsTo","kind":"relationships","identifiers":["doc:\/\/com.auth0.Auth0\/Se"]}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationMethods"}]}],"kind":"declarations"}],"sections":[],"abstract":[{"type":"text","text":"List of authentication methods belonging to the authenticated user."}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationmethods"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethods","interfaceLanguage":"swift"},"metadata":{"role":"symbol","title":"AuthenticationMethods","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationMethods"}],"externalID":"s:5Auth021AuthenticationMethodsV","navigatorTitle":[{"kind":"identifier","text":"AuthenticationMethods"}],"roleHeading":"Structure","symbolKind":"struct"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethods/init(from:)":{"kind":"symbol","title":"init(from:)","role":"symbol","fragments":[{"kind":"identifier","text":"init"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"from"},{"text":": any ","kind":"text"},{"preciseIdentifier":"s:s7DecoderP","text":"Decoder","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"kind":"keyword","text":"throws"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethods\/init(from:)","abstract":[],"url":"\/documentation\/auth0\/authenticationmethods\/init(from:)"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethods":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethods","type":"topic","title":"AuthenticationMethods","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationMethods"}],"abstract":[{"type":"text","text":"List of authentication methods belonging to the authenticated user."}],"url":"\/documentation\/auth0\/authenticationmethods","navigatorTitle":[{"kind":"identifier","text":"AuthenticationMethods"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethods/authenticationMethods":{"url":"\/documentation\/auth0\/authenticationmethods\/authenticationmethods","title":"authenticationMethods","abstract":[],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticationMethods"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:5Auth020AuthenticationMethodV","kind":"typeIdentifier","text":"AuthenticationMethod"},{"kind":"text","text":"]"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethods\/authenticationMethods","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/Se":{"title":"Swift.Decodable","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/Se"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authenticationmethods/authenticationmethods.json b/docs/data/documentation/auth0/authenticationmethods/authenticationmethods.json index 32909de35..f2b03d799 100644 --- a/docs/data/documentation/auth0/authenticationmethods/authenticationmethods.json +++ b/docs/data/documentation/auth0/authenticationmethods/authenticationmethods.json @@ -1 +1 @@ -{"schemaVersion":{"minor":3,"patch":0,"major":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethods"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authenticationMethods","kind":"identifier"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:5Auth020AuthenticationMethodV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod","text":"AuthenticationMethod","kind":"typeIdentifier"},{"text":"]","kind":"text"}]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationmethods\/authenticationmethods"]}],"metadata":{"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticationMethods"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"AuthenticationMethod","preciseIdentifier":"s:5Auth020AuthenticationMethodV"},{"kind":"text","text":"]"}],"role":"symbol","title":"authenticationMethods","externalID":"s:5Auth021AuthenticationMethodsV014authenticationC0SayAA0B6MethodVGvp","roleHeading":"Instance Property","symbolKind":"property","modules":[{"name":"Auth0"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethods\/authenticationMethods","interfaceLanguage":"swift"},"kind":"symbol","sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethods":{"title":"AuthenticationMethods","navigatorTitle":[{"text":"AuthenticationMethods","kind":"identifier"}],"role":"symbol","abstract":[{"type":"text","text":"List of authentication methods belonging to the authenticated user."}],"url":"\/documentation\/auth0\/authenticationmethods","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationMethods","kind":"identifier"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethods"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationMethod","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod","navigatorTitle":[{"text":"AuthenticationMethod","kind":"identifier"}],"abstract":[],"title":"AuthenticationMethod","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/authenticationmethod"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethods/authenticationMethods":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethods\/authenticationMethods","abstract":[],"role":"symbol","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticationMethods"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth020AuthenticationMethodV","text":"AuthenticationMethod"},{"kind":"text","text":"]"}],"title":"authenticationMethods","url":"\/documentation\/auth0\/authenticationmethods\/authenticationmethods"}}} \ No newline at end of file +{"metadata":{"symbolKind":"property","title":"authenticationMethods","externalID":"s:5Auth021AuthenticationMethodsV014authenticationC0SayAA0B6MethodVGvp","roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticationMethods"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth020AuthenticationMethodV","text":"AuthenticationMethod"},{"kind":"text","text":"]"}],"role":"symbol"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationmethods\/authenticationmethods"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethods\/authenticationMethods"},"kind":"symbol","primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authenticationMethods","kind":"identifier"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:5Auth020AuthenticationMethodV","text":"AuthenticationMethod","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod"},{"text":"]","kind":"text"}]}],"kind":"declarations"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethods"]]},"schemaVersion":{"patch":0,"minor":3,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethods/authenticationMethods":{"url":"\/documentation\/auth0\/authenticationmethods\/authenticationmethods","title":"authenticationMethods","abstract":[],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticationMethods"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:5Auth020AuthenticationMethodV","kind":"typeIdentifier","text":"AuthenticationMethod"},{"kind":"text","text":"]"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethods\/authenticationMethods","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod":{"role":"symbol","title":"AuthenticationMethod","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationMethod"}],"navigatorTitle":[{"text":"AuthenticationMethod","kind":"identifier"}],"abstract":[],"kind":"symbol","url":"\/documentation\/auth0\/authenticationmethod","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethods":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethods","type":"topic","title":"AuthenticationMethods","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationMethods"}],"abstract":[{"type":"text","text":"List of authentication methods belonging to the authenticated user."}],"url":"\/documentation\/auth0\/authenticationmethods","navigatorTitle":[{"kind":"identifier","text":"AuthenticationMethods"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authenticationmethods/init(from:).json b/docs/data/documentation/auth0/authenticationmethods/init(from:).json index 05c0d42f5..264d80c2b 100644 --- a/docs/data/documentation/auth0/authenticationmethods/init(from:).json +++ b/docs/data/documentation/auth0/authenticationmethods/init(from:).json @@ -1 +1 @@ -{"abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"Decodable.init(from:)"},{"type":"text","text":"."}],"schemaVersion":{"minor":3,"patch":0,"major":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationmethods\/init(from:)"]}],"kind":"symbol","metadata":{"modules":[{"name":"Auth0"}],"title":"init(from:)","roleHeading":"Initializer","externalID":"s:5Auth021AuthenticationMethodsV4fromACs7Decoder_p_tKcfc","role":"symbol","symbolKind":"init","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":": any ","kind":"text"},{"preciseIdentifier":"s:s7DecoderP","text":"Decoder","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}]},"sections":[],"primaryContentSections":[{"declarations":[{"tokens":[{"text":"init","kind":"keyword"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"decoder","kind":"internalParam"},{"text":": any ","kind":"text"},{"text":"Decoder","kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethods"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethods\/init(from:)","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethods/init(from:)":{"url":"\/documentation\/auth0\/authenticationmethods\/init(from:)","title":"init(from:)","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":": any ","kind":"text"},{"text":"Decoder","kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"abstract":[],"kind":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethods\/init(from:)","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethods":{"title":"AuthenticationMethods","navigatorTitle":[{"text":"AuthenticationMethods","kind":"identifier"}],"role":"symbol","abstract":[{"type":"text","text":"List of authentication methods belonging to the authenticated user."}],"url":"\/documentation\/auth0\/authenticationmethods","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationMethods","kind":"identifier"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethods"}}} \ No newline at end of file +{"sections":[],"metadata":{"externalID":"s:5Auth021AuthenticationMethodsV4fromACs7Decoder_p_tKcfc","modules":[{"name":"Auth0"}],"title":"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"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"roleHeading":"Initializer","role":"symbol","symbolKind":"init"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethods\/init(from:)","interfaceLanguage":"swift"},"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationmethods\/init(from:)"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethods"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"init","kind":"keyword"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":" ","kind":"text"},{"kind":"internalParam","text":"decoder"},{"kind":"text","text":": any "},{"preciseIdentifier":"s:s7DecoderP","text":"Decoder","kind":"typeIdentifier"},{"kind":"text","text":") "},{"text":"throws","kind":"keyword"}],"platforms":["iOS"],"languages":["swift"]}]}],"abstract":[{"type":"text","text":"Inherited from "},{"code":"Decodable.init(from:)","type":"codeVoice"},{"type":"text","text":"."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethods":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethods","type":"topic","title":"AuthenticationMethods","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationMethods"}],"abstract":[{"type":"text","text":"List of authentication methods belonging to the authenticated user."}],"url":"\/documentation\/auth0\/authenticationmethods","navigatorTitle":[{"kind":"identifier","text":"AuthenticationMethods"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethods/init(from:)":{"kind":"symbol","title":"init(from:)","role":"symbol","fragments":[{"kind":"identifier","text":"init"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"from"},{"text":": any ","kind":"text"},{"preciseIdentifier":"s:s7DecoderP","text":"Decoder","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"kind":"keyword","text":"throws"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethods\/init(from:)","abstract":[],"url":"\/documentation\/auth0\/authenticationmethods\/init(from:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authenticationresult.json b/docs/data/documentation/auth0/authenticationresult.json index d30519b24..17645aa68 100644 --- a/docs/data/documentation/auth0/authenticationresult.json +++ b/docs/data/documentation/auth0/authenticationresult.json @@ -1 +1 @@ -{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationResult"},"abstract":[{"type":"codeVoice","code":"Result"},{"type":"text","text":" wrapper for Authentication API operations."}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationResult","kind":"identifier"},{"text":"<","kind":"text"},{"text":"T","kind":"genericParameter"},{"text":"> = ","kind":"text"},{"preciseIdentifier":"s:s6ResultO","text":"Result","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth020AuthenticationResulta1Txmfp","text":"T","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth019AuthenticationErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","text":"AuthenticationError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"languages":["swift"]}],"kind":"declarations"}],"metadata":{"title":"AuthenticationResult","modules":[{"name":"Auth0"}],"navigatorTitle":[{"text":"AuthenticationResult","kind":"identifier"}],"role":"symbol","symbolKind":"typealias","roleHeading":"Type Alias","externalID":"s:5Auth020AuthenticationResulta","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationResult"}]},"schemaVersion":{"minor":3,"major":0,"patch":0},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"sections":[],"variants":[{"paths":["\/documentation\/auth0\/authenticationresult"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationResult":{"type":"topic","kind":"symbol","navigatorTitle":[{"text":"AuthenticationResult","kind":"identifier"}],"url":"\/documentation\/auth0\/authenticationresult","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationResult","kind":"identifier"}],"abstract":[{"code":"Result","type":"codeVoice"},{"type":"text","text":" wrapper for Authentication API operations."}],"title":"AuthenticationResult","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationResult","role":"symbol"}}} \ No newline at end of file +{"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationResult","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationResult","kind":"identifier"},{"text":"<","kind":"text"},{"text":"T","kind":"genericParameter"},{"text":"> = ","kind":"text"},{"text":"Result","preciseIdentifier":"s:s6ResultO","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"T","preciseIdentifier":"s:5Auth020AuthenticationResulta1Txmfp","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"AuthenticationError","preciseIdentifier":"s:5Auth019AuthenticationErrorV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"},{"text":">","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationresult"]}],"kind":"symbol","metadata":{"modules":[{"name":"Auth0"}],"title":"AuthenticationResult","externalID":"s:5Auth020AuthenticationResulta","role":"symbol","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationResult","kind":"identifier"}],"roleHeading":"Type Alias","symbolKind":"typealias","navigatorTitle":[{"kind":"identifier","text":"AuthenticationResult"}]},"schemaVersion":{"patch":0,"major":0,"minor":3},"abstract":[{"code":"Result","type":"codeVoice"},{"text":" wrapper for Authentication API operations.","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationResult":{"title":"AuthenticationResult","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationResult","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationResult"}],"abstract":[{"type":"codeVoice","code":"Result"},{"type":"text","text":" wrapper for Authentication API operations."}],"url":"\/documentation\/auth0\/authenticationresult","navigatorTitle":[{"kind":"identifier","text":"AuthenticationResult"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authenticationservices.json b/docs/data/documentation/auth0/authenticationservices.json index b207829b7..c90f49947 100644 --- a/docs/data/documentation/auth0/authenticationservices.json +++ b/docs/data/documentation/auth0/authenticationservices.json @@ -1 +1 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationServices","interfaceLanguage":"swift"},"schemaVersion":{"major":0,"patch":0,"minor":3},"sections":[],"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/authenticationservices"],"traits":[{"interfaceLanguage":"swift"}]}],"topicSections":[{"title":"Extended Enumerations","anchor":"Extended-Enumerations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationServices\/ASAuthorizationPublicKeyCredentialAttachment"],"generated":true}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"metadata":{"roleHeading":"Extended Module","modules":[{"name":"Auth0"}],"title":"AuthenticationServices","role":"collection","symbolKind":"extension","externalID":"s:m:s:e:c:objc(cs)ASAuthorizationPlatformPublicKeyCredentialAssertions:5Auth012LoginPasskeyP"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationServices":{"abstract":[],"url":"\/documentation\/auth0\/authenticationservices","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationServices","kind":"symbol","title":"AuthenticationServices","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationServices/ASAuthorizationPublicKeyCredentialAttachment":{"abstract":[],"fragments":[{"kind":"keyword","text":"extension"},{"kind":"text","text":" "},{"kind":"identifier","text":"ASAuthorizationPublicKeyCredentialAttachment","preciseIdentifier":"c:@E@ASAuthorizationPublicKeyCredentialAttachment"}],"url":"\/documentation\/auth0\/authenticationservices\/asauthorizationpublickeycredentialattachment","navigatorTitle":[{"kind":"identifier","text":"ASAuthorizationPublicKeyCredentialAttachment"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationServices\/ASAuthorizationPublicKeyCredentialAttachment","kind":"symbol","title":"ASAuthorizationPublicKeyCredentialAttachment","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"topicSections":[{"title":"Extended Enumerations","generated":true,"anchor":"Extended-Enumerations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationServices\/ASAuthorizationPublicKeyCredentialAttachment"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationservices"]}],"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationServices","interfaceLanguage":"swift"},"metadata":{"externalID":"s:m:s:e:c:objc(cs)ASAuthorizationPlatformPublicKeyCredentialAssertions:5Auth012LoginPasskeyP","title":"AuthenticationServices","modules":[{"name":"Auth0"}],"roleHeading":"Extended Module","symbolKind":"extension","role":"collection"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationServices":{"title":"AuthenticationServices","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationServices","role":"collection","kind":"symbol","abstract":[],"url":"\/documentation\/auth0\/authenticationservices"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationServices/ASAuthorizationPublicKeyCredentialAttachment":{"title":"ASAuthorizationPublicKeyCredentialAttachment","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationServices\/ASAuthorizationPublicKeyCredentialAttachment","type":"topic","role":"symbol","kind":"symbol","fragments":[{"text":"extension","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ASAuthorizationPublicKeyCredentialAttachment","preciseIdentifier":"c:@E@ASAuthorizationPublicKeyCredentialAttachment","kind":"identifier"}],"abstract":[],"url":"\/documentation\/auth0\/authenticationservices\/asauthorizationpublickeycredentialattachment","navigatorTitle":[{"text":"ASAuthorizationPublicKeyCredentialAttachment","kind":"identifier"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authenticationservices/asauthorizationpublickeycredentialattachment.json b/docs/data/documentation/auth0/authenticationservices/asauthorizationpublickeycredentialattachment.json index 3d1c71e6e..50cc1d35b 100644 --- a/docs/data/documentation/auth0/authenticationservices/asauthorizationpublickeycredentialattachment.json +++ b/docs/data/documentation/auth0/authenticationservices/asauthorizationpublickeycredentialattachment.json @@ -1 +1 @@ -{"topicSections":[{"anchor":"Instance-Properties","title":"Instance Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationServices\/ASAuthorizationPublicKeyCredentialAttachment\/stringValue"],"generated":true}],"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationServices"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"extension","kind":"keyword"},{"text":" ","kind":"text"},{"preciseIdentifier":"c:@E@ASAuthorizationPublicKeyCredentialAttachment","text":"ASAuthorizationPublicKeyCredentialAttachment","kind":"typeIdentifier"}],"platforms":["iOS"]}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationServices\/ASAuthorizationPublicKeyCredentialAttachment","interfaceLanguage":"swift"},"metadata":{"extendedModule":"AuthenticationServices","title":"ASAuthorizationPublicKeyCredentialAttachment","roleHeading":"Extended Enumeration","symbolKind":"extension","fragments":[{"kind":"keyword","text":"extension"},{"kind":"text","text":" "},{"preciseIdentifier":"c:@E@ASAuthorizationPublicKeyCredentialAttachment","kind":"identifier","text":"ASAuthorizationPublicKeyCredentialAttachment"}],"externalID":"s:e:s:So44ASAuthorizationPublicKeyCredentialAttachmentV5Auth0E11stringValueSSSgvp","navigatorTitle":[{"kind":"identifier","text":"ASAuthorizationPublicKeyCredentialAttachment"}],"modules":[{"relatedModules":["AuthenticationServices"],"name":"Auth0"}],"role":"symbol"},"schemaVersion":{"patch":0,"major":0,"minor":3},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationservices\/asauthorizationpublickeycredentialattachment"]}],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationServices":{"abstract":[],"url":"\/documentation\/auth0\/authenticationservices","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationServices","kind":"symbol","title":"AuthenticationServices","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationServices/ASAuthorizationPublicKeyCredentialAttachment/stringValue":{"abstract":[],"url":"\/documentation\/auth0\/authenticationservices\/asauthorizationpublickeycredentialattachment\/stringvalue","kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"stringValue"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationServices\/ASAuthorizationPublicKeyCredentialAttachment\/stringValue","title":"stringValue"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationServices/ASAuthorizationPublicKeyCredentialAttachment":{"abstract":[],"fragments":[{"kind":"keyword","text":"extension"},{"kind":"text","text":" "},{"kind":"identifier","text":"ASAuthorizationPublicKeyCredentialAttachment","preciseIdentifier":"c:@E@ASAuthorizationPublicKeyCredentialAttachment"}],"url":"\/documentation\/auth0\/authenticationservices\/asauthorizationpublickeycredentialattachment","navigatorTitle":[{"kind":"identifier","text":"ASAuthorizationPublicKeyCredentialAttachment"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationServices\/ASAuthorizationPublicKeyCredentialAttachment","kind":"symbol","title":"ASAuthorizationPublicKeyCredentialAttachment","type":"topic"}}} \ No newline at end of file +{"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationServices\/ASAuthorizationPublicKeyCredentialAttachment","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"extension","kind":"keyword"},{"text":" ","kind":"text"},{"preciseIdentifier":"c:@E@ASAuthorizationPublicKeyCredentialAttachment","text":"ASAuthorizationPublicKeyCredentialAttachment","kind":"typeIdentifier"}]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationservices\/asauthorizationpublickeycredentialattachment"]}],"kind":"symbol","metadata":{"extendedModule":"AuthenticationServices","symbolKind":"extension","modules":[{"relatedModules":["AuthenticationServices"],"name":"Auth0"}],"title":"ASAuthorizationPublicKeyCredentialAttachment","navigatorTitle":[{"text":"ASAuthorizationPublicKeyCredentialAttachment","kind":"identifier"}],"fragments":[{"text":"extension","kind":"keyword"},{"text":" ","kind":"text"},{"preciseIdentifier":"c:@E@ASAuthorizationPublicKeyCredentialAttachment","text":"ASAuthorizationPublicKeyCredentialAttachment","kind":"identifier"}],"externalID":"s:e:s:So44ASAuthorizationPublicKeyCredentialAttachmentV5Auth0E11stringValueSSSgvp","role":"symbol","roleHeading":"Extended Enumeration"},"schemaVersion":{"patch":0,"minor":3,"major":0},"topicSections":[{"anchor":"Instance-Properties","title":"Instance Properties","generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationServices\/ASAuthorizationPublicKeyCredentialAttachment\/stringValue"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationServices"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationServices/ASAuthorizationPublicKeyCredentialAttachment":{"title":"ASAuthorizationPublicKeyCredentialAttachment","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationServices\/ASAuthorizationPublicKeyCredentialAttachment","type":"topic","role":"symbol","kind":"symbol","fragments":[{"text":"extension","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ASAuthorizationPublicKeyCredentialAttachment","preciseIdentifier":"c:@E@ASAuthorizationPublicKeyCredentialAttachment","kind":"identifier"}],"abstract":[],"url":"\/documentation\/auth0\/authenticationservices\/asauthorizationpublickeycredentialattachment","navigatorTitle":[{"text":"ASAuthorizationPublicKeyCredentialAttachment","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationServices/ASAuthorizationPublicKeyCredentialAttachment/stringValue":{"role":"symbol","title":"stringValue","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"stringValue","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"abstract":[],"kind":"symbol","url":"\/documentation\/auth0\/authenticationservices\/asauthorizationpublickeycredentialattachment\/stringvalue","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationServices\/ASAuthorizationPublicKeyCredentialAttachment\/stringValue","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationServices":{"title":"AuthenticationServices","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationServices","role":"collection","kind":"symbol","abstract":[],"url":"\/documentation\/auth0\/authenticationservices"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/authenticationservices/asauthorizationpublickeycredentialattachment/stringvalue.json b/docs/data/documentation/auth0/authenticationservices/asauthorizationpublickeycredentialattachment/stringvalue.json index 29d66f5ba..7152370f4 100644 --- a/docs/data/documentation/auth0/authenticationservices/asauthorizationpublickeycredentialattachment/stringvalue.json +++ b/docs/data/documentation/auth0/authenticationservices/asauthorizationpublickeycredentialattachment/stringvalue.json @@ -1 +1 @@ -{"metadata":{"externalID":"s:So44ASAuthorizationPublicKeyCredentialAttachmentV5Auth0E11stringValueSSSgvp","title":"stringValue","roleHeading":"Instance Property","platforms":[{"deprecated":false,"unavailable":false,"beta":false,"name":"iOS","introducedAt":"16.6"},{"deprecated":false,"unavailable":false,"beta":false,"name":"iPadOS","introducedAt":"16.6"},{"deprecated":false,"unavailable":false,"beta":false,"name":"Mac Catalyst","introducedAt":"16.6"},{"deprecated":false,"unavailable":false,"beta":false,"name":"macOS","introducedAt":"13.5"},{"deprecated":false,"unavailable":false,"beta":false,"name":"visionOS","introducedAt":"1.0"}],"extendedModule":"AuthenticationServices","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"stringValue","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"symbolKind":"property","modules":[{"name":"Auth0","relatedModules":["AuthenticationServices"]}],"role":"symbol"},"schemaVersion":{"patch":0,"minor":3,"major":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationServices\/ASAuthorizationPublicKeyCredentialAttachment\/stringValue"},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"stringValue"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"? { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"platforms":["iOS"],"languages":["swift"]}]}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationServices","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationServices\/ASAuthorizationPublicKeyCredentialAttachment"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/authenticationservices\/asauthorizationpublickeycredentialattachment\/stringvalue"]}],"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationServices/ASAuthorizationPublicKeyCredentialAttachment/stringValue":{"abstract":[],"url":"\/documentation\/auth0\/authenticationservices\/asauthorizationpublickeycredentialattachment\/stringvalue","kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"stringValue"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationServices\/ASAuthorizationPublicKeyCredentialAttachment\/stringValue","title":"stringValue"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationServices":{"abstract":[],"url":"\/documentation\/auth0\/authenticationservices","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationServices","kind":"symbol","title":"AuthenticationServices","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationServices/ASAuthorizationPublicKeyCredentialAttachment":{"abstract":[],"fragments":[{"kind":"keyword","text":"extension"},{"kind":"text","text":" "},{"kind":"identifier","text":"ASAuthorizationPublicKeyCredentialAttachment","preciseIdentifier":"c:@E@ASAuthorizationPublicKeyCredentialAttachment"}],"url":"\/documentation\/auth0\/authenticationservices\/asauthorizationpublickeycredentialattachment","navigatorTitle":[{"kind":"identifier","text":"ASAuthorizationPublicKeyCredentialAttachment"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationServices\/ASAuthorizationPublicKeyCredentialAttachment","kind":"symbol","title":"ASAuthorizationPublicKeyCredentialAttachment","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"metadata":{"externalID":"s:So44ASAuthorizationPublicKeyCredentialAttachmentV5Auth0E11stringValueSSSgvp","extendedModule":"AuthenticationServices","platforms":[{"name":"iOS","deprecated":false,"introducedAt":"16.6","beta":false,"unavailable":false},{"name":"iPadOS","deprecated":false,"introducedAt":"16.6","beta":false,"unavailable":false},{"name":"Mac Catalyst","deprecated":false,"introducedAt":"16.6","beta":false,"unavailable":false},{"unavailable":false,"beta":false,"introducedAt":"13.5","name":"macOS","deprecated":false},{"unavailable":false,"beta":false,"introducedAt":"1.0","name":"visionOS","deprecated":false}],"symbolKind":"property","title":"stringValue","roleHeading":"Instance Property","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"stringValue"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"modules":[{"name":"Auth0","relatedModules":["AuthenticationServices"]}]},"sections":[],"variants":[{"paths":["\/documentation\/auth0\/authenticationservices\/asauthorizationpublickeycredentialattachment\/stringvalue"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationServices\/ASAuthorizationPublicKeyCredentialAttachment\/stringValue","interfaceLanguage":"swift"},"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"stringValue"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"? { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}]}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationServices","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationServices\/ASAuthorizationPublicKeyCredentialAttachment"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationServices":{"title":"AuthenticationServices","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationServices","role":"collection","kind":"symbol","abstract":[],"url":"\/documentation\/auth0\/authenticationservices"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationServices/ASAuthorizationPublicKeyCredentialAttachment/stringValue":{"role":"symbol","title":"stringValue","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"stringValue","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"abstract":[],"kind":"symbol","url":"\/documentation\/auth0\/authenticationservices\/asauthorizationpublickeycredentialattachment\/stringvalue","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationServices\/ASAuthorizationPublicKeyCredentialAttachment\/stringValue","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationServices/ASAuthorizationPublicKeyCredentialAttachment":{"title":"ASAuthorizationPublicKeyCredentialAttachment","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationServices\/ASAuthorizationPublicKeyCredentialAttachment","type":"topic","role":"symbol","kind":"symbol","fragments":[{"text":"extension","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ASAuthorizationPublicKeyCredentialAttachment","preciseIdentifier":"c:@E@ASAuthorizationPublicKeyCredentialAttachment","kind":"identifier"}],"abstract":[],"url":"\/documentation\/auth0\/authenticationservices\/asauthorizationpublickeycredentialattachment","navigatorTitle":[{"text":"ASAuthorizationPublicKeyCredentialAttachment","kind":"identifier"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/biometricpolicy.json b/docs/data/documentation/auth0/biometricpolicy.json new file mode 100644 index 000000000..8f7289152 --- /dev/null +++ b/docs/data/documentation/auth0/biometricpolicy.json @@ -0,0 +1 @@ +{"topicSections":[{"title":"Enumeration Cases","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/BiometricPolicy\/always","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/BiometricPolicy\/appLifecycle(timeoutInSeconds:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/BiometricPolicy\/default","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/BiometricPolicy\/session(timeoutInSeconds:)"],"anchor":"Enumeration-Cases","generated":true}],"schemaVersion":{"minor":3,"patch":0,"major":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"BiometricPolicy","kind":"identifier"}],"platforms":["iOS"]}]}],"sections":[],"abstract":[{"text":"Defines the policy for when a biometric prompt should be shown when using the Credentials Manager.","type":"text"}],"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/biometricpolicy"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/BiometricPolicy","interfaceLanguage":"swift"},"metadata":{"symbolKind":"enum","roleHeading":"Enumeration","externalID":"s:5Auth015BiometricPolicyO","title":"BiometricPolicy","modules":[{"name":"Auth0"}],"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"BiometricPolicy","kind":"identifier"}],"role":"symbol","navigatorTitle":[{"text":"BiometricPolicy","kind":"identifier"}]},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/BiometricPolicy/session(timeoutInSeconds:)":{"kind":"symbol","abstract":[{"type":"text","text":"A biometric prompt will be shown only once within the specified timeout period."},{"type":"text","text":" "},{"type":"text","text":"Creates a new LAContext for each authentication when the session has expired."}],"type":"topic","url":"\/documentation\/auth0\/biometricpolicy\/session(timeoutinseconds:)","title":"BiometricPolicy.session(timeoutInSeconds:)","role":"symbol","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"session","kind":"identifier"},{"text":"(","kind":"text"},{"text":"timeoutInSeconds","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"text":")","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/BiometricPolicy\/session(timeoutInSeconds:)"},"doc://com.auth0.Auth0/documentation/Auth0/BiometricPolicy/always":{"role":"symbol","title":"BiometricPolicy.always","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"always"}],"abstract":[{"text":"A biometric prompt will be shown for every call to ","type":"text"},{"code":"credentials()","type":"codeVoice"},{"text":".","type":"text"},{"text":" ","type":"text"},{"text":"Creates a new LAContext for each authentication to ensure a fresh prompt.","type":"text"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/BiometricPolicy\/always","url":"\/documentation\/auth0\/biometricpolicy\/always","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/BiometricPolicy/appLifecycle(timeoutInSeconds:)":{"kind":"symbol","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"appLifecycle","kind":"identifier"},{"text":"(","kind":"text"},{"text":"timeoutInSeconds","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"text":")","kind":"text"}],"title":"BiometricPolicy.appLifecycle(timeoutInSeconds:)","type":"topic","role":"symbol","abstract":[{"text":"A biometric prompt will be shown only once while the app is in the foreground.","type":"text"},{"text":" ","type":"text"},{"text":"Creates a new LAContext for each authentication when the session has expired.","type":"text"},{"text":" ","type":"text"},{"text":"The session is invalidated by calling ","type":"text"},{"type":"codeVoice","code":"clearBiometricSession()"},{"text":" or after the default timeout.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/BiometricPolicy\/appLifecycle(timeoutInSeconds:)","url":"\/documentation\/auth0\/biometricpolicy\/applifecycle(timeoutinseconds:)"},"doc://com.auth0.Auth0/documentation/Auth0/BiometricPolicy/default":{"type":"topic","title":"BiometricPolicy.default","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/BiometricPolicy\/default","kind":"symbol","url":"\/documentation\/auth0\/biometricpolicy\/default","abstract":[{"type":"text","text":"Default behavior. Uses the same LAContext instance, allowing the system to manage biometric prompts."},{"type":"text","text":" "},{"type":"text","text":"The system may skip the prompt if biometric authentication was recently successful."}],"role":"symbol","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"`default`"}]},"doc://com.auth0.Auth0/documentation/Auth0/BiometricPolicy":{"kind":"symbol","abstract":[{"text":"Defines the policy for when a biometric prompt should be shown when using the Credentials Manager.","type":"text"}],"type":"topic","url":"\/documentation\/auth0\/biometricpolicy","title":"BiometricPolicy","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"BiometricPolicy","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/BiometricPolicy","navigatorTitle":[{"text":"BiometricPolicy","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/biometricpolicy/always.json b/docs/data/documentation/auth0/biometricpolicy/always.json new file mode 100644 index 000000000..b55aed38f --- /dev/null +++ b/docs/data/documentation/auth0/biometricpolicy/always.json @@ -0,0 +1 @@ +{"metadata":{"symbolKind":"case","roleHeading":"Case","externalID":"s:5Auth015BiometricPolicyO6alwaysyA2CmF","title":"BiometricPolicy.always","modules":[{"name":"Auth0"}],"fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"always","kind":"identifier"}],"role":"symbol"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/biometricpolicy\/always"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/BiometricPolicy\/always","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"type":"text","text":"A biometric prompt will be shown for every call to "},{"type":"codeVoice","code":"credentials()"},{"type":"text","text":"."},{"type":"text","text":" "},{"type":"text","text":"Creates a new LAContext for each authentication to ensure a fresh prompt."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/BiometricPolicy"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"always","kind":"identifier"}]}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/BiometricPolicy":{"kind":"symbol","abstract":[{"text":"Defines the policy for when a biometric prompt should be shown when using the Credentials Manager.","type":"text"}],"type":"topic","url":"\/documentation\/auth0\/biometricpolicy","title":"BiometricPolicy","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"BiometricPolicy","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/BiometricPolicy","navigatorTitle":[{"text":"BiometricPolicy","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/BiometricPolicy/always":{"role":"symbol","title":"BiometricPolicy.always","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"always"}],"abstract":[{"text":"A biometric prompt will be shown for every call to ","type":"text"},{"code":"credentials()","type":"codeVoice"},{"text":".","type":"text"},{"text":" ","type":"text"},{"text":"Creates a new LAContext for each authentication to ensure a fresh prompt.","type":"text"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/BiometricPolicy\/always","url":"\/documentation\/auth0\/biometricpolicy\/always","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/biometricpolicy/applifecycle(timeoutinseconds:).json b/docs/data/documentation/auth0/biometricpolicy/applifecycle(timeoutinseconds:).json new file mode 100644 index 000000000..d52a1b3e3 --- /dev/null +++ b/docs/data/documentation/auth0/biometricpolicy/applifecycle(timeoutinseconds:).json @@ -0,0 +1 @@ +{"abstract":[{"text":"A biometric prompt will be shown only once while the app is in the foreground.","type":"text"},{"text":" ","type":"text"},{"text":"Creates a new LAContext for each authentication when the session has expired.","type":"text"},{"text":" ","type":"text"},{"text":"The session is invalidated by calling ","type":"text"},{"type":"codeVoice","code":"clearBiometricSession()"},{"text":" or after the default timeout.","type":"text"}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"appLifecycle"},{"kind":"text","text":"("},{"kind":"externalParam","text":"timeoutInSeconds"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"},{"kind":"text","text":" = 3600)"}],"platforms":["iOS"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"text":"The duration for which the session remains valid. Defaults to 3600 seconds (1 hour).","type":"text"}],"type":"paragraph"}],"name":"timeoutInSeconds"}]}],"variants":[{"paths":["\/documentation\/auth0\/biometricpolicy\/applifecycle(timeoutinseconds:)"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"minor":3,"major":0,"patch":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/BiometricPolicy"]]},"metadata":{"modules":[{"name":"Auth0"}],"symbolKind":"case","title":"BiometricPolicy.appLifecycle(timeoutInSeconds:)","roleHeading":"Case","role":"symbol","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"appLifecycle"},{"kind":"text","text":"("},{"kind":"externalParam","text":"timeoutInSeconds"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"},{"kind":"text","text":")"}],"externalID":"s:5Auth015BiometricPolicyO12appLifecycleyACSi_tcACmF"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/BiometricPolicy\/appLifecycle(timeoutInSeconds:)"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/BiometricPolicy/appLifecycle(timeoutInSeconds:)":{"kind":"symbol","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"appLifecycle","kind":"identifier"},{"text":"(","kind":"text"},{"text":"timeoutInSeconds","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"text":")","kind":"text"}],"title":"BiometricPolicy.appLifecycle(timeoutInSeconds:)","type":"topic","role":"symbol","abstract":[{"text":"A biometric prompt will be shown only once while the app is in the foreground.","type":"text"},{"text":" ","type":"text"},{"text":"Creates a new LAContext for each authentication when the session has expired.","type":"text"},{"text":" ","type":"text"},{"text":"The session is invalidated by calling ","type":"text"},{"type":"codeVoice","code":"clearBiometricSession()"},{"text":" or after the default timeout.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/BiometricPolicy\/appLifecycle(timeoutInSeconds:)","url":"\/documentation\/auth0\/biometricpolicy\/applifecycle(timeoutinseconds:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/BiometricPolicy":{"kind":"symbol","abstract":[{"text":"Defines the policy for when a biometric prompt should be shown when using the Credentials Manager.","type":"text"}],"type":"topic","url":"\/documentation\/auth0\/biometricpolicy","title":"BiometricPolicy","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"BiometricPolicy","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/BiometricPolicy","navigatorTitle":[{"text":"BiometricPolicy","kind":"identifier"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/biometricpolicy/default.json b/docs/data/documentation/auth0/biometricpolicy/default.json new file mode 100644 index 000000000..de7db93db --- /dev/null +++ b/docs/data/documentation/auth0/biometricpolicy/default.json @@ -0,0 +1 @@ +{"metadata":{"symbolKind":"case","roleHeading":"Case","title":"BiometricPolicy.default","externalID":"s:5Auth015BiometricPolicyO7defaultyA2CmF","modules":[{"name":"Auth0"}],"fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"`default`","kind":"identifier"}],"role":"symbol"},"sections":[],"variants":[{"paths":["\/documentation\/auth0\/biometricpolicy\/default"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/BiometricPolicy\/default","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"type":"text","text":"Default behavior. Uses the same LAContext instance, allowing the system to manage biometric prompts."},{"type":"text","text":" "},{"type":"text","text":"The system may skip the prompt if biometric authentication was recently successful."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/BiometricPolicy"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"`default`","kind":"identifier"}]}]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/BiometricPolicy":{"kind":"symbol","abstract":[{"text":"Defines the policy for when a biometric prompt should be shown when using the Credentials Manager.","type":"text"}],"type":"topic","url":"\/documentation\/auth0\/biometricpolicy","title":"BiometricPolicy","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"BiometricPolicy","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/BiometricPolicy","navigatorTitle":[{"text":"BiometricPolicy","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/BiometricPolicy/default":{"type":"topic","title":"BiometricPolicy.default","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/BiometricPolicy\/default","kind":"symbol","url":"\/documentation\/auth0\/biometricpolicy\/default","abstract":[{"type":"text","text":"Default behavior. Uses the same LAContext instance, allowing the system to manage biometric prompts."},{"type":"text","text":" "},{"type":"text","text":"The system may skip the prompt if biometric authentication was recently successful."}],"role":"symbol","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"`default`"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/biometricpolicy/session(timeoutinseconds:).json b/docs/data/documentation/auth0/biometricpolicy/session(timeoutinseconds:).json new file mode 100644 index 000000000..f959e128a --- /dev/null +++ b/docs/data/documentation/auth0/biometricpolicy/session(timeoutinseconds:).json @@ -0,0 +1 @@ +{"sections":[],"variants":[{"paths":["\/documentation\/auth0\/biometricpolicy\/session(timeoutinseconds:)"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/BiometricPolicy"]]},"abstract":[{"text":"A biometric prompt will be shown only once within the specified timeout period.","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"Creates a new LAContext for each authentication when the session has expired."}],"metadata":{"externalID":"s:5Auth015BiometricPolicyO7sessionyACSi_tcACmF","modules":[{"name":"Auth0"}],"role":"symbol","roleHeading":"Case","symbolKind":"case","title":"BiometricPolicy.session(timeoutInSeconds:)","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"text":"session","kind":"identifier"},{"text":"(","kind":"text"},{"text":"timeoutInSeconds","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"kind":"text","text":")"}]},"schemaVersion":{"patch":0,"major":0,"minor":3},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"session"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"timeoutInSeconds"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"text":")","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}]},{"kind":"parameters","parameters":[{"name":"timeoutInSeconds","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The duration for which the session remains valid."}]}]}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/BiometricPolicy\/session(timeoutInSeconds:)","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/BiometricPolicy":{"kind":"symbol","abstract":[{"text":"Defines the policy for when a biometric prompt should be shown when using the Credentials Manager.","type":"text"}],"type":"topic","url":"\/documentation\/auth0\/biometricpolicy","title":"BiometricPolicy","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"BiometricPolicy","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/BiometricPolicy","navigatorTitle":[{"text":"BiometricPolicy","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/BiometricPolicy/session(timeoutInSeconds:)":{"kind":"symbol","abstract":[{"type":"text","text":"A biometric prompt will be shown only once within the specified timeout period."},{"type":"text","text":" "},{"type":"text","text":"Creates a new LAContext for each authentication when the session has expired."}],"type":"topic","url":"\/documentation\/auth0\/biometricpolicy\/session(timeoutinseconds:)","title":"BiometricPolicy.session(timeoutInSeconds:)","role":"symbol","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"session","kind":"identifier"},{"text":"(","kind":"text"},{"text":"timeoutInSeconds","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"text":")","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/BiometricPolicy\/session(timeoutInSeconds:)"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/challenge.json b/docs/data/documentation/auth0/challenge.json index bcaf12b8a..3dcad0b12 100644 --- a/docs/data/documentation/auth0/challenge.json +++ b/docs/data/documentation/auth0/challenge.json @@ -1 +1 @@ -{"metadata":{"title":"Challenge","navigatorTitle":[{"text":"Challenge","kind":"identifier"}],"modules":[{"name":"Auth0"}],"symbolKind":"struct","externalID":"s:5Auth09ChallengeV","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Challenge","kind":"identifier"}],"roleHeading":"Structure"},"schemaVersion":{"minor":3,"major":0,"patch":0},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Challenge"}]}],"kind":"declarations"}],"abstract":[{"text":"A multi-factor challenge.","type":"text"}],"topicSections":[{"generated":true,"title":"Initializers","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/init(from:)"],"anchor":"Initializers"},{"generated":true,"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"],"anchor":"Instance-Properties"}],"relationshipsSections":[{"title":"Conforms To","identifiers":["doc:\/\/com.auth0.Auth0\/Se","doc:\/\/com.auth0.Auth0\/SE","doc:\/\/com.auth0.Auth0\/s8SendableP","doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP"],"type":"conformsTo","kind":"relationships"}],"kind":"symbol","sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge","interfaceLanguage":"swift"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/challenge"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Challenge/init(from:)":{"title":"init(from:)","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/init(from:)","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":": any ","kind":"text"},{"preciseIdentifier":"s:s7DecoderP","text":"Decoder","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"abstract":[],"kind":"symbol","role":"symbol","url":"\/documentation\/auth0\/challenge\/init(from:)"},"doc://com.auth0.Auth0/documentation/Auth0/Challenge/oobCode":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/oobCode","role":"symbol","url":"\/documentation\/auth0\/challenge\/oobcode","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"oobCode","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"abstract":[{"text":"Out-of-band (OOB) code.","type":"text"}],"kind":"symbol","title":"oobCode","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Challenge/bindingMethod":{"role":"symbol","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":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/bindingMethod","url":"\/documentation\/auth0\/challenge\/bindingmethod","title":"bindingMethod","type":"topic","kind":"symbol","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"},{"type":"text","text":" "},{"type":"codeVoice","code":"binding_code"},{"type":"text","text":" and send it as part of the request."}]},"doc://com.auth0.Auth0/s16SendableMetatypeP":{"title":"Swift.SendableMetatype","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP"},"doc://com.auth0.Auth0/Se":{"title":"Swift.Decodable","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/Se"},"doc://com.auth0.Auth0/s8SendableP":{"title":"Swift.Sendable","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s8SendableP"},"doc://com.auth0.Auth0/SE":{"title":"Swift.Encodable","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/SE"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Challenge":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Challenge","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge","title":"Challenge","url":"\/documentation\/auth0\/challenge","navigatorTitle":[{"text":"Challenge","kind":"identifier"}],"type":"topic","kind":"symbol","abstract":[{"type":"text","text":"A multi-factor challenge."}]},"doc://com.auth0.Auth0/documentation/Auth0/Challenge/challengeType":{"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"challengeType"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/challengeType","title":"challengeType","type":"topic","role":"symbol","abstract":[{"text":"How the user will get the challenge and prove possession.","type":"text"}],"url":"\/documentation\/auth0\/challenge\/challengetype","kind":"symbol"}}} \ No newline at end of file +{"abstract":[{"type":"text","text":"A multi-factor challenge."}],"relationshipsSections":[{"type":"conformsTo","identifiers":["doc:\/\/com.auth0.Auth0\/Se","doc:\/\/com.auth0.Auth0\/SE","doc:\/\/com.auth0.Auth0\/s8SendableP","doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP"],"kind":"relationships","title":"Conforms To"}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Challenge","kind":"identifier"}]}],"kind":"declarations"}],"variants":[{"paths":["\/documentation\/auth0\/challenge"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/init(from:)"],"generated":true,"title":"Initializers","anchor":"Initializers"},{"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"],"generated":true,"title":"Instance Properties","anchor":"Instance-Properties"}],"metadata":{"navigatorTitle":[{"kind":"identifier","text":"Challenge"}],"modules":[{"name":"Auth0"}],"title":"Challenge","roleHeading":"Structure","symbolKind":"struct","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Challenge","kind":"identifier"}],"externalID":"s:5Auth09ChallengeV"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/Challenge/bindingMethod":{"kind":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"bindingMethod","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"title":"bindingMethod","type":"topic","role":"symbol","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"},{"type":"text","text":" "},{"type":"codeVoice","code":"binding_code"},{"type":"text","text":" and send it as part of the request."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/bindingMethod","url":"\/documentation\/auth0\/challenge\/bindingmethod"},"doc://com.auth0.Auth0/documentation/Auth0/Challenge/oobCode":{"kind":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"oobCode","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"title":"oobCode","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Out-of-band (OOB) code."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/oobCode","url":"\/documentation\/auth0\/challenge\/oobcode"},"doc://com.auth0.Auth0/documentation/Auth0/Challenge/challengeType":{"kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"challengeType"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"title":"challengeType","type":"topic","role":"symbol","abstract":[{"type":"text","text":"How the user will get the challenge and prove possession."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/challengeType","url":"\/documentation\/auth0\/challenge\/challengetype"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/s8SendableP":{"title":"Swift.Sendable","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s8SendableP"},"doc://com.auth0.Auth0/SE":{"title":"Swift.Encodable","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/SE"},"doc://com.auth0.Auth0/documentation/Auth0/Challenge/init(from:)":{"kind":"symbol","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": any "},{"preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier","text":"Decoder"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"title":"init(from:)","type":"topic","role":"symbol","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/init(from:)","url":"\/documentation\/auth0\/challenge\/init(from:)"},"doc://com.auth0.Auth0/s16SendableMetatypeP":{"title":"Swift.SendableMetatype","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP"},"doc://com.auth0.Auth0/Se":{"title":"Swift.Decodable","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/Se"},"doc://com.auth0.Auth0/documentation/Auth0/Challenge":{"title":"Challenge","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Challenge"}],"abstract":[{"text":"A multi-factor challenge.","type":"text"}],"url":"\/documentation\/auth0\/challenge","navigatorTitle":[{"kind":"identifier","text":"Challenge"}]}}} \ 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 ee1e6774f..f91c55f9a 100644 --- a/docs/data/documentation/auth0/challenge/bindingmethod.json +++ b/docs/data/documentation/auth0/challenge/bindingmethod.json @@ -1 +1 @@ -{"variants":[{"paths":["\/documentation\/auth0\/challenge\/bindingmethod"],"traits":[{"interfaceLanguage":"swift"}]}],"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\/bindingMethod"},"metadata":{"title":"bindingMethod","role":"symbol","externalID":"s:5Auth09ChallengeV13bindingMethodSSSgvp","modules":[{"name":"Auth0"}],"symbolKind":"property","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"bindingMethod","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"roleHeading":"Instance Property"},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"bindingMethod"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"languages":["swift"]}],"kind":"declarations"}],"schemaVersion":{"patch":0,"minor":3,"major":0},"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"},{"type":"text","text":" "},{"type":"codeVoice","code":"binding_code"},{"type":"text","text":" and send it as part of the request."}],"sections":[],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/Challenge/bindingMethod":{"role":"symbol","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":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/bindingMethod","url":"\/documentation\/auth0\/challenge\/bindingmethod","title":"bindingMethod","type":"topic","kind":"symbol","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"},{"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":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Challenge":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Challenge","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge","title":"Challenge","url":"\/documentation\/auth0\/challenge","navigatorTitle":[{"text":"Challenge","kind":"identifier"}],"type":"topic","kind":"symbol","abstract":[{"type":"text","text":"A multi-factor challenge."}]}}} \ No newline at end of file +{"variants":[{"paths":["\/documentation\/auth0\/challenge\/bindingmethod"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge"]]},"abstract":[{"text":"When the challenge response includes a ","type":"text"},{"code":"prompt","type":"codeVoice"},{"text":" binding method, your app needs to prompt the user for the","type":"text"},{"text":" ","type":"text"},{"code":"binding_code","type":"codeVoice"},{"text":" and send it as part of the request.","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"bindingMethod"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"platforms":["iOS"]}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"kind":"symbol","sections":[],"metadata":{"externalID":"s:5Auth09ChallengeV13bindingMethodSSSgvp","symbolKind":"property","title":"bindingMethod","roleHeading":"Instance Property","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"bindingMethod"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"modules":[{"name":"Auth0"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/bindingMethod","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Challenge/bindingMethod":{"kind":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"bindingMethod","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"title":"bindingMethod","type":"topic","role":"symbol","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"},{"type":"text","text":" "},{"type":"codeVoice","code":"binding_code"},{"type":"text","text":" and send it as part of the request."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/bindingMethod","url":"\/documentation\/auth0\/challenge\/bindingmethod"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Challenge":{"title":"Challenge","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Challenge"}],"abstract":[{"text":"A multi-factor challenge.","type":"text"}],"url":"\/documentation\/auth0\/challenge","navigatorTitle":[{"kind":"identifier","text":"Challenge"}]}}} \ 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 e11bf3db5..56e7e60e3 100644 --- a/docs/data/documentation/auth0/challenge/challengetype.json +++ b/docs/data/documentation/auth0/challenge/challengetype.json @@ -1 +1 @@ -{"schemaVersion":{"patch":0,"major":0,"minor":3},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge"]]},"metadata":{"modules":[{"name":"Auth0"}],"title":"challengeType","symbolKind":"property","roleHeading":"Instance Property","externalID":"s:5Auth09ChallengeV13challengeTypeSSvp","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"challengeType","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}]},"variants":[{"paths":["\/documentation\/auth0\/challenge\/challengetype"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/challengeType"},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"challengeType"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"sections":[],"abstract":[{"text":"How the user will get the challenge and prove possession.","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Challenge/challengeType":{"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"challengeType"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/challengeType","title":"challengeType","type":"topic","role":"symbol","abstract":[{"text":"How the user will get the challenge and prove possession.","type":"text"}],"url":"\/documentation\/auth0\/challenge\/challengetype","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Challenge":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Challenge","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge","title":"Challenge","url":"\/documentation\/auth0\/challenge","navigatorTitle":[{"text":"Challenge","kind":"identifier"}],"type":"topic","kind":"symbol","abstract":[{"type":"text","text":"A multi-factor challenge."}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge"]]},"metadata":{"symbolKind":"property","modules":[{"name":"Auth0"}],"title":"challengeType","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"challengeType"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"externalID":"s:5Auth09ChallengeV13challengeTypeSSvp","role":"symbol","roleHeading":"Instance Property"},"sections":[],"abstract":[{"type":"text","text":"How the user will get the challenge and prove possession."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/challenge\/challengetype"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/challengeType","interfaceLanguage":"swift"},"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"challengeType"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}]}],"kind":"declarations"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Challenge/challengeType":{"kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"challengeType"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"title":"challengeType","type":"topic","role":"symbol","abstract":[{"type":"text","text":"How the user will get the challenge and prove possession."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/challengeType","url":"\/documentation\/auth0\/challenge\/challengetype"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Challenge":{"title":"Challenge","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Challenge"}],"abstract":[{"text":"A multi-factor challenge.","type":"text"}],"url":"\/documentation\/auth0\/challenge","navigatorTitle":[{"kind":"identifier","text":"Challenge"}]}}} \ 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 1542e028a..8eb3f7611 100644 --- a/docs/data/documentation/auth0/challenge/init(from:).json +++ b/docs/data/documentation/auth0/challenge/init(from:).json @@ -1 +1 @@ -{"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":" "},{"kind":"internalParam","text":"decoder"},{"kind":"text","text":": any "},{"preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier","text":"Decoder"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"languages":["swift"]}]}],"abstract":[{"text":"Inherited from ","type":"text"},{"type":"codeVoice","code":"Decodable.init(from:)"},{"text":".","type":"text"}],"sections":[],"schemaVersion":{"minor":3,"patch":0,"major":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/challenge\/init(from:)"]}],"metadata":{"fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":": any ","kind":"text"},{"text":"Decoder","kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"role":"symbol","modules":[{"name":"Auth0"}],"title":"init(from:)","symbolKind":"init","roleHeading":"Initializer","externalID":"s:5Auth09ChallengeV4fromACs7Decoder_p_tKcfc"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/init(from:)"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Challenge":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Challenge","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge","title":"Challenge","url":"\/documentation\/auth0\/challenge","navigatorTitle":[{"text":"Challenge","kind":"identifier"}],"type":"topic","kind":"symbol","abstract":[{"type":"text","text":"A multi-factor challenge."}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Challenge/init(from:)":{"title":"init(from:)","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/init(from:)","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":": any ","kind":"text"},{"preciseIdentifier":"s:s7DecoderP","text":"Decoder","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"abstract":[],"kind":"symbol","role":"symbol","url":"\/documentation\/auth0\/challenge\/init(from:)"}}} \ No newline at end of file +{"schemaVersion":{"minor":3,"patch":0,"major":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"init","kind":"keyword"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"decoder","kind":"internalParam"},{"text":": any ","kind":"text"},{"preciseIdentifier":"s:s7DecoderP","text":"Decoder","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"platforms":["iOS"]}]}],"sections":[],"abstract":[{"text":"Inherited from ","type":"text"},{"code":"Decodable.init(from:)","type":"codeVoice"},{"text":".","type":"text"}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/challenge\/init(from:)"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/init(from:)"},"metadata":{"role":"symbol","modules":[{"name":"Auth0"}],"title":"init(from:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": any "},{"kind":"typeIdentifier","text":"Decoder","preciseIdentifier":"s:s7DecoderP"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"externalID":"s:5Auth09ChallengeV4fromACs7Decoder_p_tKcfc","roleHeading":"Initializer","symbolKind":"init"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Challenge/init(from:)":{"kind":"symbol","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": any "},{"preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier","text":"Decoder"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"title":"init(from:)","type":"topic","role":"symbol","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/init(from:)","url":"\/documentation\/auth0\/challenge\/init(from:)"},"doc://com.auth0.Auth0/documentation/Auth0/Challenge":{"title":"Challenge","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Challenge"}],"abstract":[{"text":"A multi-factor challenge.","type":"text"}],"url":"\/documentation\/auth0\/challenge","navigatorTitle":[{"kind":"identifier","text":"Challenge"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ 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 c9dda37a1..3b972662c 100644 --- a/docs/data/documentation/auth0/challenge/oobcode.json +++ b/docs/data/documentation/auth0/challenge/oobcode.json @@ -1 +1 @@ -{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/oobCode"},"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"oobCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"languages":["swift"]}]}],"abstract":[{"text":"Out-of-band (OOB) code.","type":"text"}],"schemaVersion":{"patch":0,"minor":3,"major":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge"]]},"metadata":{"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"oobCode"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}],"roleHeading":"Instance Property","externalID":"s:5Auth09ChallengeV7oobCodeSSSgvp","modules":[{"name":"Auth0"}],"symbolKind":"property","title":"oobCode","role":"symbol"},"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/challenge\/oobcode"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Challenge":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Challenge","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge","title":"Challenge","url":"\/documentation\/auth0\/challenge","navigatorTitle":[{"text":"Challenge","kind":"identifier"}],"type":"topic","kind":"symbol","abstract":[{"type":"text","text":"A multi-factor challenge."}]},"doc://com.auth0.Auth0/documentation/Auth0/Challenge/oobCode":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/oobCode","role":"symbol","url":"\/documentation\/auth0\/challenge\/oobcode","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"oobCode","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"abstract":[{"text":"Out-of-band (OOB) code.","type":"text"}],"kind":"symbol","title":"oobCode","type":"topic"}}} \ No newline at end of file +{"abstract":[{"text":"Out-of-band (OOB) code.","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"oobCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"languages":["swift"],"platforms":["iOS"]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/challenge\/oobcode"]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge"]]},"metadata":{"modules":[{"name":"Auth0"}],"title":"oobCode","symbolKind":"property","roleHeading":"Instance Property","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"oobCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"externalID":"s:5Auth09ChallengeV7oobCodeSSSgvp"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/oobCode","interfaceLanguage":"swift"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/Challenge/oobCode":{"kind":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"oobCode","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"title":"oobCode","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Out-of-band (OOB) code."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge\/oobCode","url":"\/documentation\/auth0\/challenge\/oobcode"},"doc://com.auth0.Auth0/documentation/Auth0/Challenge":{"title":"Challenge","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Challenge","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Challenge"}],"abstract":[{"text":"A multi-factor challenge.","type":"text"}],"url":"\/documentation\/auth0\/challenge","navigatorTitle":[{"kind":"identifier","text":"Challenge"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentials.json b/docs/data/documentation/auth0/credentials.json index 0176d70b4..34fc506f1 100644 --- a/docs/data/documentation/auth0/credentials.json +++ b/docs/data/documentation/auth0/credentials.json @@ -1 +1 @@ -{"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","interfaceLanguage":"swift"},"schemaVersion":{"patch":0,"minor":3,"major":0},"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/init(accessToken:tokenType:idToken:refreshToken:expiresIn:scope:recoveryCode:)"],"title":"Initializers","generated":true,"anchor":"Initializers"},{"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","generated":true,"anchor":"Instance-Properties"},{"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"],"title":"Default Implementations","generated":true,"anchor":"Default-Implementations"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"@objc","kind":"attribute"},{"text":"(A0Credentials) ","kind":"text"},{"text":"final","kind":"keyword"},{"text":" ","kind":"text"},{"text":"class","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Credentials","kind":"identifier"}],"platforms":["iOS"],"languages":["swift"]}]}],"relationshipsSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/objc(cs)NSObject"],"type":"inheritsFrom","kind":"relationships","title":"Inherits From"},{"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\/s8CopyableP","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","doc:\/\/com.auth0.Auth0\/s8SendableP","doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP"],"type":"conformsTo","kind":"relationships","title":"Conforms To"}],"metadata":{"navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"symbolKind":"class","externalID":"c:@M@Auth0@objc(cs)A0Credentials","roleHeading":"Class","title":"Credentials","modules":[{"name":"Auth0"}],"role":"symbol"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentials"]}],"references":{"doc://com.auth0.Auth0/objc(cs)NSObject":{"title":"ObjectiveC.NSObject","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/objc(cs)NSObject"},"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/tokenType":{"url":"\/documentation\/auth0\/credentials\/tokentype","abstract":[{"text":"Indicates how the access token should be used. For example, as a bearer token.","type":"text"}],"title":"tokenType","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/tokenType","kind":"symbol","type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"tokenType"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/refreshToken":{"url":"\/documentation\/auth0\/credentials\/refreshtoken","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/refreshToken","role":"symbol","title":"refreshToken","type":"topic","abstract":[{"type":"text","text":"Token that can be used to request a new access token."}],"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"refreshToken","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/scope":{"abstract":[{"type":"text","text":"The scopes that have been granted by Auth0."}],"type":"topic","url":"\/documentation\/auth0\/credentials\/scope","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/scope","kind":"symbol","title":"scope","role":"symbol"},"doc://com.auth0.Auth0/s28CustomDebugStringConvertibleP":{"identifier":"doc:\/\/com.auth0.Auth0\/s28CustomDebugStringConvertibleP","title":"Swift.CustomDebugStringConvertible","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/init(accessToken:tokenType:idToken:refreshToken:expiresIn:scope:recoveryCode:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/init(accessToken:tokenType:idToken:refreshToken:expiresIn:scope:recoveryCode:)","role":"symbol","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"accessToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"tokenType"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"idToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"refreshToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"expiresIn"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DateV","text":"Date"},{"kind":"text","text":", "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"recoveryCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?)"}],"type":"topic","url":"\/documentation\/auth0\/credentials\/init(accesstoken:tokentype:idtoken:refreshtoken:expiresin:scope:recoverycode:)","kind":"symbol","title":"init(accessToken:tokenType:idToken:refreshToken:expiresIn:scope:recoveryCode:)","abstract":[{"type":"text","text":"Default initializer."}]},"doc://com.auth0.Auth0/s8SendableP":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s8SendableP","title":"Swift.Sendable"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"url":"\/documentation\/auth0\/credentials","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"role":"symbol","type":"topic","abstract":[{"text":"User’s credentials obtained from Auth0.","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","role":"collectionGroup","abstract":[],"title":"Decodable Implementations","type":"topic","kind":"article"},"doc://com.auth0.Auth0/Se":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/Se","title":"Swift.Decodable"},"doc://com.auth0.Auth0/s16SendableMetatypeP":{"identifier":"doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP","title":"Swift.SendableMetatype","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/recoveryCode":{"title":"recoveryCode","url":"\/documentation\/auth0\/credentials\/recoverycode","type":"topic","abstract":[{"text":"MFA recovery code that the application must display to the user, to be stored securely for future use.","type":"text"}],"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"recoveryCode","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"kind":"symbol","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/recoveryCode"},"doc://com.auth0.Auth0/s7CVarArgP":{"identifier":"doc:\/\/com.auth0.Auth0\/s7CVarArgP","title":"Swift.CVarArg","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/idToken":{"role":"symbol","abstract":[{"type":"text","text":"Token that contains the user information."}],"kind":"symbol","type":"topic","title":"idToken","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/idToken","url":"\/documentation\/auth0\/credentials\/idtoken","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"idToken","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}]},"doc://com.auth0.Auth0/objc(pl)NSCoding":{"identifier":"doc:\/\/com.auth0.Auth0\/objc(pl)NSCoding","title":"Foundation.NSCoding","type":"unresolvable"},"doc://com.auth0.Auth0/SQ":{"identifier":"doc:\/\/com.auth0.Auth0\/SQ","type":"unresolvable","title":"Swift.Equatable"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/NSCoding-Implementations":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/NSCoding-Implementations","url":"\/documentation\/auth0\/credentials\/nscoding-implementations","type":"topic","abstract":[],"title":"NSCoding Implementations","kind":"article","role":"collectionGroup"},"doc://com.auth0.Auth0/s8CopyableP":{"identifier":"doc:\/\/com.auth0.Auth0\/s8CopyableP","type":"unresolvable","title":"Swift.Copyable"},"doc://com.auth0.Auth0/SE":{"identifier":"doc:\/\/com.auth0.Auth0\/SE","title":"Swift.Encodable","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"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":[{"text":"audience","type":"text"}],"type":"strong"},{"type":"text","text":" value used on login)."}],"type":"topic","url":"\/documentation\/auth0\/credentials\/accesstoken","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/accessToken","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"accessToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"kind":"symbol","title":"accessToken"},"doc://com.auth0.Auth0/SH":{"identifier":"doc:\/\/com.auth0.Auth0\/SH","type":"unresolvable","title":"Swift.Hashable"},"doc://com.auth0.Auth0/objc(pl)NSSecureCoding":{"identifier":"doc:\/\/com.auth0.Auth0\/objc(pl)NSSecureCoding","title":"Foundation.NSSecureCoding","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/expiresIn":{"url":"\/documentation\/auth0\/credentials\/expiresin","role":"symbol","title":"expiresIn","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/expiresIn","kind":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"expiresIn","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation4DateV","text":"Date","kind":"typeIdentifier"}],"type":"topic","abstract":[{"text":"When the access token expires.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/description":{"abstract":[{"text":"Custom description that redacts the tokens with ","type":"text"},{"code":"","type":"codeVoice"},{"text":".","type":"text"}],"type":"topic","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/description","url":"\/documentation\/auth0\/credentials\/description","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"description","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"title":"description","kind":"symbol"},"doc://com.auth0.Auth0/s23CustomStringConvertibleP":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s23CustomStringConvertibleP","title":"Swift.CustomStringConvertible"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/NSSecureCoding-Implementations":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/NSSecureCoding-Implementations","abstract":[],"title":"NSSecureCoding Implementations","kind":"article","type":"topic","role":"collectionGroup","url":"\/documentation\/auth0\/credentials\/nssecurecoding-implementations"}}} \ No newline at end of file +{"topicSections":[{"title":"Initializers","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/init(accessToken:tokenType:idToken:refreshToken:expiresIn:scope:recoveryCode:)"],"anchor":"Initializers","generated":true},{"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"],"anchor":"Instance-Properties","generated":true},{"title":"Default Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/Decodable-Implementations","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/NSCoding-Implementations","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/NSSecureCoding-Implementations"],"anchor":"Default-Implementations","generated":true}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"metadata":{"symbolKind":"class","modules":[{"name":"Auth0"}],"title":"Credentials","navigatorTitle":[{"text":"Credentials","kind":"identifier"}],"fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"Credentials","kind":"identifier"}],"externalID":"c:@M@Auth0@objc(cs)A0Credentials","role":"symbol","roleHeading":"Class"},"sections":[],"abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}],"relationshipsSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/objc(cs)NSObject"],"kind":"relationships","title":"Inherits From","type":"inheritsFrom"},{"title":"Conforms To","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\/s8CopyableP","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","doc:\/\/com.auth0.Auth0\/s8SendableP","doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP"],"type":"conformsTo","kind":"relationships"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentials"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","interfaceLanguage":"swift"},"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"attribute","text":"@objc"},{"kind":"text","text":"(A0Credentials) "},{"text":"final","kind":"keyword"},{"text":" ","kind":"text"},{"text":"class","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Credentials","kind":"identifier"}],"languages":["swift"],"platforms":["iOS"]}]}],"references":{"doc://com.auth0.Auth0/s23CustomStringConvertibleP":{"type":"unresolvable","title":"Swift.CustomStringConvertible","identifier":"doc:\/\/com.auth0.Auth0\/s23CustomStringConvertibleP"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/init(accessToken:tokenType:idToken:refreshToken:expiresIn:scope:recoveryCode:)":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/init(accessToken:tokenType:idToken:refreshToken:expiresIn:scope:recoveryCode:)","title":"init(accessToken:tokenType:idToken:refreshToken:expiresIn:scope:recoveryCode:)","fragments":[{"text":"init","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"accessToken"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"tokenType"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"idToken"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"refreshToken"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"expiresIn"},{"kind":"text","text":": "},{"preciseIdentifier":"s:10Foundation4DateV","kind":"typeIdentifier","text":"Date"},{"kind":"text","text":", "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"recoveryCode"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?)"}],"role":"symbol","url":"\/documentation\/auth0\/credentials\/init(accesstoken:tokentype:idtoken:refreshtoken:expiresin:scope:recoverycode:)","abstract":[{"text":"Default initializer.","type":"text"}],"type":"topic"},"doc://com.auth0.Auth0/SQ":{"title":"Swift.Equatable","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/SQ"},"doc://com.auth0.Auth0/SH":{"title":"Swift.Hashable","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/SH"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/objc(pl)NSCoding":{"title":"Foundation.NSCoding","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/objc(pl)NSCoding"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/NSSecureCoding-Implementations":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/NSSecureCoding-Implementations","kind":"article","title":"NSSecureCoding Implementations","role":"collectionGroup","url":"\/documentation\/auth0\/credentials\/nssecurecoding-implementations","abstract":[],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/expiresIn":{"kind":"symbol","title":"expiresIn","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"expiresIn","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation4DateV","text":"Date","kind":"typeIdentifier"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/expiresIn","abstract":[{"text":"When the access token expires.","type":"text"}],"url":"\/documentation\/auth0\/credentials\/expiresin"},"doc://com.auth0.Auth0/s7CVarArgP":{"title":"Swift.CVarArg","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s7CVarArgP"},"doc://com.auth0.Auth0/SE":{"title":"Swift.Encodable","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/SE"},"doc://com.auth0.Auth0/s28CustomDebugStringConvertibleP":{"title":"Swift.CustomDebugStringConvertible","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s28CustomDebugStringConvertibleP"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"Credentials","kind":"identifier"}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}]},"doc://com.auth0.Auth0/s16SendableMetatypeP":{"title":"Swift.SendableMetatype","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/description":{"type":"topic","title":"description","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/description","kind":"symbol","abstract":[{"type":"text","text":"Custom description that redacts the tokens with "},{"type":"codeVoice","code":""},{"type":"text","text":"."}],"url":"\/documentation\/auth0\/credentials\/description","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"description"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}]},"doc://com.auth0.Auth0/Se":{"title":"Swift.Decodable","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/Se"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/idToken":{"kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"idToken"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"title":"idToken","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Token that contains the user information."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/idToken","url":"\/documentation\/auth0\/credentials\/idtoken"},"doc://com.auth0.Auth0/s8CopyableP":{"title":"Swift.Copyable","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s8CopyableP"},"doc://com.auth0.Auth0/objc(cs)NSObject":{"title":"ObjectiveC.NSObject","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/objc(cs)NSObject"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/recoveryCode":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/recoveryCode","title":"recoveryCode","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"recoveryCode","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"role":"symbol","url":"\/documentation\/auth0\/credentials\/recoverycode","abstract":[{"type":"text","text":"MFA recovery code that the application must display to the user, to be stored securely for future use."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/NSCoding-Implementations":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/NSCoding-Implementations","kind":"article","title":"NSCoding Implementations","role":"collectionGroup","url":"\/documentation\/auth0\/credentials\/nscoding-implementations","abstract":[],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/Decodable-Implementations":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/Decodable-Implementations","kind":"article","title":"Decodable Implementations","role":"collectionGroup","url":"\/documentation\/auth0\/credentials\/decodable-implementations","abstract":[],"type":"topic"},"doc://com.auth0.Auth0/objc(pl)NSObject":{"title":"ObjectiveC.NSObjectProtocol","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/objc(pl)NSObject"},"doc://com.auth0.Auth0/s8SendableP":{"title":"Swift.Sendable","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s8SendableP"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/tokenType":{"type":"topic","title":"tokenType","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/tokenType","url":"\/documentation\/auth0\/credentials\/tokentype","abstract":[{"text":"Indicates how the access token should be used. For example, as a bearer token.","type":"text"}],"kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"tokenType"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}]},"doc://com.auth0.Auth0/objc(pl)NSSecureCoding":{"title":"Foundation.NSSecureCoding","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/objc(pl)NSSecureCoding"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/accessToken":{"url":"\/documentation\/auth0\/credentials\/accesstoken","title":"accessToken","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"}]},{"type":"text","text":" value used on login)."}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"accessToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/accessToken","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/refreshToken":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/refreshToken","kind":"symbol","title":"refreshToken","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"refreshToken"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}],"role":"symbol","url":"\/documentation\/auth0\/credentials\/refreshtoken","abstract":[{"type":"text","text":"Token that can be used to request a new access token."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/scope":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/scope","kind":"symbol","title":"scope","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"scope"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}],"role":"symbol","url":"\/documentation\/auth0\/credentials\/scope","abstract":[{"type":"text","text":"The scopes that have been granted by Auth0."}],"type":"topic"}}} \ 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 fc06fc842..d6a13af40 100644 --- a/docs/data/documentation/auth0/credentials/accesstoken.json +++ b/docs/data/documentation/auth0/credentials/accesstoken.json @@ -1 +1 @@ -{"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/accessToken"},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"accessToken","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"languages":["swift"],"platforms":["iOS"]}]}],"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"],"anchor":"Related-Documentation"}],"metadata":{"externalID":"s:5Auth011CredentialsC11accessTokenSSvp","roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"symbolKind":"property","role":"symbol","title":"accessToken","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"accessToken","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}]},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"]]},"kind":"symbol","abstract":[{"type":"text","text":"Token that can be used to make authenticated requests to the specified API (the "},{"type":"strong","inlineContent":[{"text":"audience","type":"text"}]},{"type":"text","text":" value used on login)."}],"schemaVersion":{"patch":0,"major":0,"minor":3},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentials\/accesstoken"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"url":"\/documentation\/auth0\/credentials","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"role":"symbol","type":"topic","abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}]},"https://auth0.com/docs/secure/tokens/access-tokens/get-access-tokens#control-access-token-audience":{"type":"link","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/access-tokens\/get-access-tokens#control-access-token-audience","titleInlineContent":[{"type":"text","text":"Audience"}],"url":"https:\/\/auth0.com\/docs\/secure\/tokens\/access-tokens\/get-access-tokens#control-access-token-audience","title":"Audience"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"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":[{"text":"audience","type":"text"}],"type":"strong"},{"type":"text","text":" value used on login)."}],"type":"topic","url":"\/documentation\/auth0\/credentials\/accesstoken","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/accessToken","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"accessToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"kind":"symbol","title":"accessToken"},"https://auth0.com/docs/secure/tokens/access-tokens":{"titleInlineContent":[{"type":"text","text":"Access Tokens"}],"title":"Access Tokens","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/access-tokens","type":"link","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/access-tokens"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"]]},"metadata":{"externalID":"s:5Auth011CredentialsC11accessTokenSSvp","symbolKind":"property","title":"accessToken","roleHeading":"Instance Property","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"accessToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"modules":[{"name":"Auth0"}]},"sections":[],"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"}]},{"type":"text","text":" value used on login)."}],"variants":[{"paths":["\/documentation\/auth0\/credentials\/accesstoken"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/accessToken"},"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"],"anchor":"Related-Documentation"}],"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"accessToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}]}]}],"references":{"https://auth0.com/docs/secure/tokens/access-tokens":{"title":"Access Tokens","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/access-tokens","titleInlineContent":[{"type":"text","text":"Access Tokens"}],"type":"link","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/access-tokens"},"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"}],"type":"link","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/access-tokens\/get-access-tokens#control-access-token-audience"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"Credentials","kind":"identifier"}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/accessToken":{"url":"\/documentation\/auth0\/credentials\/accesstoken","title":"accessToken","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"}]},{"type":"text","text":" value used on login)."}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"accessToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/accessToken","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ 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 8530f4d07..5424da0a8 100644 --- a/docs/data/documentation/auth0/credentials/decodable-implementations.json +++ b/docs/data/documentation/auth0/credentials/decodable-implementations.json @@ -1 +1 @@ -{"schemaVersion":{"major":0,"minor":3,"patch":0},"topicSections":[{"generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/init(from:)"],"title":"Initializers","anchor":"Initializers"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentials\/decodable-implementations"]}],"kind":"article","metadata":{"roleHeading":"API Collection","modules":[{"name":"Auth0"}],"role":"collectionGroup","title":"Decodable Implementations"},"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/Decodable-Implementations"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"url":"\/documentation\/auth0\/credentials","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"role":"symbol","type":"topic","abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/init(from:)":{"role":"symbol","url":"\/documentation\/auth0\/credentials\/init(from:)","kind":"symbol","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Decoder","preciseIdentifier":"s:s7DecoderP"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/init(from:)","title":"init(from:)","abstract":[{"type":"codeVoice","code":"Decodable"},{"type":"text","text":" initializer."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"metadata":{"modules":[{"name":"Auth0"}],"roleHeading":"API Collection","title":"Decodable Implementations","role":"collectionGroup"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentials\/decodable-implementations"]}],"topicSections":[{"anchor":"Initializers","title":"Initializers","generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/init(from:)"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/Decodable-Implementations","interfaceLanguage":"swift"},"kind":"article","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"]]},"schemaVersion":{"major":0,"patch":0,"minor":3},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials/init(from:)":{"url":"\/documentation\/auth0\/credentials\/init(from:)","title":"init(from:)","abstract":[{"type":"codeVoice","code":"Decodable"},{"type":"text","text":" initializer."}],"fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Decoder","preciseIdentifier":"s:s7DecoderP"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/init(from:)","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"Credentials","kind":"identifier"}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}]}}} \ 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 deaccb45e..976706b15 100644 --- a/docs/data/documentation/auth0/credentials/description.json +++ b/docs/data/documentation/auth0/credentials/description.json @@ -1 +1 @@ -{"abstract":[{"type":"text","text":"Custom description that redacts the tokens with "},{"type":"codeVoice","code":""},{"type":"text","text":"."}],"metadata":{"modules":[{"name":"Auth0"}],"role":"symbol","externalID":"c:@M@Auth0@objc(cs)A0Credentials(py)description","roleHeading":"Instance Property","symbolKind":"property","title":"description","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"description"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}]},"variants":[{"paths":["\/documentation\/auth0\/credentials\/description"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/description","interfaceLanguage":"swift"},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"]]},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"override"},{"kind":"text","text":" "},{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"description"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"kind":"symbol","schemaVersion":{"minor":3,"major":0,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"url":"\/documentation\/auth0\/credentials","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"role":"symbol","type":"topic","abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/description":{"abstract":[{"text":"Custom description that redacts the tokens with ","type":"text"},{"code":"","type":"codeVoice"},{"text":".","type":"text"}],"type":"topic","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/description","url":"\/documentation\/auth0\/credentials\/description","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"description","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"title":"description","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"metadata":{"symbolKind":"property","title":"description","roleHeading":"Instance Property","externalID":"c:@M@Auth0@objc(cs)A0Credentials(py)description","modules":[{"name":"Auth0"}],"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"description","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"role":"symbol"},"sections":[],"variants":[{"paths":["\/documentation\/auth0\/credentials\/description"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/description","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"type":"text","text":"Custom description that redacts the tokens with "},{"type":"codeVoice","code":""},{"type":"text","text":"."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"override"},{"kind":"text","text":" "},{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"description"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"platforms":["iOS"]}]}],"schemaVersion":{"patch":0,"minor":3,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials/description":{"type":"topic","title":"description","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/description","kind":"symbol","abstract":[{"type":"text","text":"Custom description that redacts the tokens with "},{"type":"codeVoice","code":""},{"type":"text","text":"."}],"url":"\/documentation\/auth0\/credentials\/description","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"description"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"Credentials","kind":"identifier"}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ 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 fcd0f9adc..8b2130dd6 100644 --- a/docs/data/documentation/auth0/credentials/encode(with:).json +++ b/docs/data/documentation/auth0/credentials/encode(with:).json @@ -1 +1 @@ -{"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"encode"},{"kind":"text","text":"("},{"kind":"externalParam","text":"with"},{"kind":"text","text":" "},{"kind":"internalParam","text":"aCoder"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSCoder","text":"NSCoder"},{"kind":"text","text":")"}],"platforms":["iOS"]}],"kind":"declarations"}],"metadata":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"encode","kind":"identifier"},{"text":"(","kind":"text"},{"text":"with","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:objc(cs)NSCoder","text":"NSCoder","kind":"typeIdentifier"},{"text":")","kind":"text"}],"modules":[{"name":"Auth0"}],"title":"encode(with:)","externalID":"c:@CM@Auth0@objc(cs)A0Credentials(im)encodeWithCoder:","roleHeading":"Instance Method","extendedModule":"Auth0","role":"symbol","symbolKind":"method"},"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/encode(with:)","interfaceLanguage":"swift"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentials\/encode(with:)"]}],"abstract":[{"type":"codeVoice","code":"NSSecureCoding"},{"type":"text","text":" encoding method."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"]]},"kind":"symbol","schemaVersion":{"minor":3,"patch":0,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials/encode(with:)":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/encode(with:)","role":"symbol","title":"encode(with:)","kind":"symbol","url":"\/documentation\/auth0\/credentials\/encode(with:)","abstract":[{"type":"codeVoice","code":"NSSecureCoding"},{"type":"text","text":" encoding method."}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"encode","kind":"identifier"},{"text":"(","kind":"text"},{"text":"with","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:objc(cs)NSCoder","text":"NSCoder","kind":"typeIdentifier"},{"text":")","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"url":"\/documentation\/auth0\/credentials","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"role":"symbol","type":"topic","abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/encode(with:)","interfaceLanguage":"swift"},"kind":"symbol","metadata":{"externalID":"c:@CM@Auth0@objc(cs)A0Credentials(im)encodeWithCoder:","modules":[{"name":"Auth0"}],"title":"encode(with:)","extendedModule":"Auth0","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"encode"},{"kind":"text","text":"("},{"kind":"externalParam","text":"with"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"NSCoder","preciseIdentifier":"c:objc(cs)NSCoder"},{"kind":"text","text":")"}],"role":"symbol","symbolKind":"method"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentials\/encode(with:)"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"]]},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"encode","kind":"identifier"},{"text":"(","kind":"text"},{"text":"with","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"aCoder","kind":"internalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:objc(cs)NSCoder","text":"NSCoder","kind":"typeIdentifier"},{"text":")","kind":"text"}]}],"kind":"declarations"}],"abstract":[{"code":"NSSecureCoding","type":"codeVoice"},{"type":"text","text":" encoding method."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"Credentials","kind":"identifier"}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/encode(with:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/encode(with:)","kind":"symbol","title":"encode(with:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"encode"},{"kind":"text","text":"("},{"kind":"externalParam","text":"with"},{"kind":"text","text":": "},{"preciseIdentifier":"c:objc(cs)NSCoder","kind":"typeIdentifier","text":"NSCoder"},{"kind":"text","text":")"}],"role":"symbol","url":"\/documentation\/auth0\/credentials\/encode(with:)","abstract":[{"code":"NSSecureCoding","type":"codeVoice"},{"type":"text","text":" encoding method."}],"type":"topic"}}} \ 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 d0b0a4b8d..2b79cc7f6 100644 --- a/docs/data/documentation/auth0/credentials/expiresin.json +++ b/docs/data/documentation/auth0/credentials/expiresin.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"]]},"kind":"symbol","metadata":{"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"expiresIn","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation4DateV","text":"Date","kind":"typeIdentifier"}],"symbolKind":"property","externalID":"s:5Auth011CredentialsC9expiresIn10Foundation4DateVvp","modules":[{"name":"Auth0"}],"title":"expiresIn","roleHeading":"Instance Property","role":"symbol"},"sections":[],"variants":[{"paths":["\/documentation\/auth0\/credentials\/expiresin"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"expiresIn"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DateV","text":"Date"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"abstract":[{"type":"text","text":"When the access token expires."}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/expiresIn","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials/expiresIn":{"url":"\/documentation\/auth0\/credentials\/expiresin","role":"symbol","title":"expiresIn","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/expiresIn","kind":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"expiresIn","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation4DateV","text":"Date","kind":"typeIdentifier"}],"type":"topic","abstract":[{"text":"When the access token expires.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"url":"\/documentation\/auth0\/credentials","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"role":"symbol","type":"topic","abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}]}}} \ No newline at end of file +{"kind":"symbol","primaryContentSections":[{"declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"expiresIn","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation4DateV","text":"Date","kind":"typeIdentifier"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentials\/expiresin"]}],"sections":[],"schemaVersion":{"minor":3,"major":0,"patch":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/expiresIn","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"]]},"abstract":[{"text":"When the access token expires.","type":"text"}],"metadata":{"roleHeading":"Instance Property","symbolKind":"property","title":"expiresIn","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"expiresIn","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation4DateV","text":"Date","kind":"typeIdentifier"}],"externalID":"s:5Auth011CredentialsC9expiresIn10Foundation4DateVvp","modules":[{"name":"Auth0"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials/expiresIn":{"kind":"symbol","title":"expiresIn","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"expiresIn","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation4DateV","text":"Date","kind":"typeIdentifier"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/expiresIn","abstract":[{"text":"When the access token expires.","type":"text"}],"url":"\/documentation\/auth0\/credentials\/expiresin"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"Credentials","kind":"identifier"}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}]}}} \ 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 c9105e349..e945382c7 100644 --- a/docs/data/documentation/auth0/credentials/idtoken.json +++ b/docs/data/documentation/auth0/credentials/idtoken.json @@ -1 +1 @@ -{"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/idToken","interfaceLanguage":"swift"},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"idToken","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"},{"content":[{"type":"heading","level":2,"text":"Discussion","anchor":"discussion"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The ID tokens obtained from Web Auth login are automatically validated by Auth0.swift, ensuring their"},{"type":"text","text":" "},{"type":"text","text":"contents have not been tampered with. "},{"type":"strong","inlineContent":[{"type":"text","text":"This is not the case for the ID tokens obtained from the Authentication API"},{"type":"text","text":" "},{"type":"text","text":"client"}]},{"type":"text","text":", including the ones received when renewing the credentials using the refresh token. You must"},{"type":"text","text":" "},{"type":"reference","isActive":true,"identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens\/validate-id-tokens"},{"type":"text","text":" any ID tokens received from the"},{"type":"text","text":" "},{"type":"text","text":"Authentication API client before using the information they contain."}]}],"type":"aside","style":"important","name":"Important"}],"kind":"content"}],"metadata":{"symbolKind":"property","modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","externalID":"s:5Auth011CredentialsC7idTokenSSvp","title":"idToken","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"idToken","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}]},"schemaVersion":{"minor":3,"major":0,"patch":0},"seeAlsoSections":[{"title":"Related Documentation","anchor":"Related-Documentation","identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens","https:\/\/auth0.com\/docs\/secure\/tokens\/json-web-tokens","https:\/\/jwt.io"]}],"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"]]},"abstract":[{"text":"Token that contains the user information.","type":"text"}],"variants":[{"paths":["\/documentation\/auth0\/credentials\/idtoken"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"https://jwt.io":{"type":"link","title":"jwt.io","titleInlineContent":[{"type":"text","text":"jwt.io"}],"identifier":"https:\/\/jwt.io","url":"https:\/\/jwt.io"},"https://auth0.com/docs/secure/tokens/id-tokens/validate-id-tokens":{"url":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens\/validate-id-tokens","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens\/validate-id-tokens","title":"validate","titleInlineContent":[{"type":"text","text":"validate"}],"type":"link"},"https://auth0.com/docs/secure/tokens/id-tokens":{"type":"link","title":"ID Tokens","titleInlineContent":[{"type":"text","text":"ID Tokens"}],"identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens"},"https://auth0.com/docs/secure/tokens/json-web-tokens":{"url":"https:\/\/auth0.com\/docs\/secure\/tokens\/json-web-tokens","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/json-web-tokens","title":"JSON Web Tokens","titleInlineContent":[{"type":"text","text":"JSON Web Tokens"}],"type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"url":"\/documentation\/auth0\/credentials","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"role":"symbol","type":"topic","abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/idToken":{"role":"symbol","abstract":[{"type":"text","text":"Token that contains the user information."}],"kind":"symbol","type":"topic","title":"idToken","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/idToken","url":"\/documentation\/auth0\/credentials\/idtoken","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"idToken","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"abstract":[{"type":"text","text":"Token that contains the user information."}],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens","https:\/\/auth0.com\/docs\/secure\/tokens\/json-web-tokens","https:\/\/jwt.io"],"anchor":"Related-Documentation"}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"idToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}]}],"kind":"declarations"},{"content":[{"level":2,"type":"heading","anchor":"discussion","text":"Discussion"},{"type":"aside","content":[{"inlineContent":[{"text":"The ID tokens obtained from Web Auth login are automatically validated by Auth0.swift, ensuring their","type":"text"},{"text":" ","type":"text"},{"text":"contents have not been tampered with. ","type":"text"},{"inlineContent":[{"type":"text","text":"This is not the case for the ID tokens obtained from the Authentication API"},{"type":"text","text":" "},{"type":"text","text":"client"}],"type":"strong"},{"text":", including the ones received when renewing the credentials using the refresh token. You must","type":"text"},{"text":" ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens\/validate-id-tokens","isActive":true,"type":"reference"},{"text":" any ID tokens received from the","type":"text"},{"text":" ","type":"text"},{"text":"Authentication API client before using the information they contain.","type":"text"}],"type":"paragraph"}],"name":"Important","style":"important"}],"kind":"content"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentials\/idtoken"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"]]},"metadata":{"modules":[{"name":"Auth0"}],"title":"idToken","roleHeading":"Instance Property","symbolKind":"property","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"idToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"externalID":"s:5Auth011CredentialsC7idTokenSSvp"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/idToken","interfaceLanguage":"swift"},"kind":"symbol","references":{"https://auth0.com/docs/secure/tokens/id-tokens":{"title":"ID Tokens","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens","type":"link","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens","titleInlineContent":[{"type":"text","text":"ID Tokens"}]},"https://jwt.io":{"title":"jwt.io","url":"https:\/\/jwt.io","type":"link","identifier":"https:\/\/jwt.io","titleInlineContent":[{"type":"text","text":"jwt.io"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/idToken":{"kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"idToken"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"title":"idToken","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Token that contains the user information."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/idToken","url":"\/documentation\/auth0\/credentials\/idtoken"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"Credentials","kind":"identifier"}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}]},"https://auth0.com/docs/secure/tokens/json-web-tokens":{"title":"JSON Web Tokens","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/json-web-tokens","type":"link","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/json-web-tokens","titleInlineContent":[{"type":"text","text":"JSON Web Tokens"}]},"https://auth0.com/docs/secure/tokens/id-tokens/validate-id-tokens":{"title":"validate","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens\/validate-id-tokens","type":"link","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens\/validate-id-tokens","titleInlineContent":[{"type":"text","text":"validate"}]}}} \ 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 52701db8c..19a17e9ac 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"},{"text":"(","kind":"text"},{"text":"accessToken","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" = \"\", ","kind":"text"},{"text":"tokenType","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" = \"\", ","kind":"text"},{"text":"idToken","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" = \"\", ","kind":"text"},{"text":"refreshToken","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"? = nil, "},{"kind":"externalParam","text":"expiresIn"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DateV","text":"Date"},{"kind":"text","text":" = Date(), "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"? = nil, ","kind":"text"},{"text":"recoveryCode","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"? = nil)"}],"languages":["swift"]}],"kind":"declarations"}],"metadata":{"roleHeading":"Initializer","title":"init(accessToken:tokenType:idToken:refreshToken:expiresIn:scope:recoveryCode:)","externalID":"s:5Auth011CredentialsC11accessToken9tokenType02idD007refreshD09expiresIn5scope12recoveryCodeACSS_S3SSg10Foundation4DateVA2Ktcfc","symbolKind":"init","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"accessToken","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"tokenType","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"idToken","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"refreshToken","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"text":"expiresIn","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Date","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DateV"},{"text":", ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"text":"recoveryCode","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?)","kind":"text"}],"modules":[{"name":"Auth0"}],"role":"symbol"},"abstract":[{"type":"text","text":"Default initializer."}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/init(accessToken:tokenType:idToken:refreshToken:expiresIn:scope:recoveryCode:)","interfaceLanguage":"swift"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentials\/init(accesstoken:tokentype:idtoken:refreshtoken:expiresin:scope:recoverycode:)"]}],"schemaVersion":{"minor":3,"major":0,"patch":0},"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials/init(accessToken:tokenType:idToken:refreshToken:expiresIn:scope:recoveryCode:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/init(accessToken:tokenType:idToken:refreshToken:expiresIn:scope:recoveryCode:)","role":"symbol","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"accessToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"tokenType"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"idToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"refreshToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"expiresIn"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DateV","text":"Date"},{"kind":"text","text":", "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"recoveryCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?)"}],"type":"topic","url":"\/documentation\/auth0\/credentials\/init(accesstoken:tokentype:idtoken:refreshtoken:expiresin:scope:recoverycode:)","kind":"symbol","title":"init(accessToken:tokenType:idToken:refreshToken:expiresIn:scope:recoveryCode:)","abstract":[{"type":"text","text":"Default initializer."}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"url":"\/documentation\/auth0\/credentials","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"role":"symbol","type":"topic","abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"abstract":[{"text":"Default initializer.","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"init","kind":"keyword"},{"text":"(","kind":"text"},{"text":"accessToken","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" = \"\", ","kind":"text"},{"text":"tokenType","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" = \"\", ","kind":"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","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"? = nil, "},{"text":"expiresIn","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Date","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DateV"},{"text":" = Date(), ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"? = nil, "},{"kind":"externalParam","text":"recoveryCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"? = nil)"}],"platforms":["iOS"]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentials\/init(accesstoken:tokentype:idtoken:refreshtoken:expiresin:scope:recoverycode:)"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"]]},"metadata":{"modules":[{"name":"Auth0"}],"symbolKind":"init","roleHeading":"Initializer","title":"init(accessToken:tokenType:idToken:refreshToken:expiresIn:scope:recoveryCode:)","role":"symbol","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"accessToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"tokenType"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"idToken"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"text":"refreshToken","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"expiresIn"},{"text":": ","kind":"text"},{"text":"Date","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"scope"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"recoveryCode"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?)","kind":"text"}],"externalID":"s:5Auth011CredentialsC11accessToken9tokenType02idD007refreshD09expiresIn5scope12recoveryCodeACSS_S3SSg10Foundation4DateVA2Ktcfc"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/init(accessToken:tokenType:idToken:refreshToken:expiresIn:scope:recoveryCode:)","interfaceLanguage":"swift"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"Credentials","kind":"identifier"}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/init(accessToken:tokenType:idToken:refreshToken:expiresIn:scope:recoveryCode:)":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/init(accessToken:tokenType:idToken:refreshToken:expiresIn:scope:recoveryCode:)","title":"init(accessToken:tokenType:idToken:refreshToken:expiresIn:scope:recoveryCode:)","fragments":[{"text":"init","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"accessToken"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"tokenType"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"idToken"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"refreshToken"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"expiresIn"},{"kind":"text","text":": "},{"preciseIdentifier":"s:10Foundation4DateV","kind":"typeIdentifier","text":"Date"},{"kind":"text","text":", "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"recoveryCode"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?)"}],"role":"symbol","url":"\/documentation\/auth0\/credentials\/init(accesstoken:tokentype:idtoken:refreshtoken:expiresin:scope:recoverycode:)","abstract":[{"text":"Default initializer.","type":"text"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ 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 75a7e07f4..f66e76e65 100644 --- a/docs/data/documentation/auth0/credentials/init(coder:).json +++ b/docs/data/documentation/auth0/credentials/init(coder:).json @@ -1 +1 @@ -{"sections":[],"abstract":[{"type":"codeVoice","code":"NSSecureCoding"},{"text":" decoding initializer.","type":"text"}],"metadata":{"title":"init(coder:)","externalID":"c:@CM@Auth0@objc(cs)A0Credentials(im)initWithCoder:","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"?("},{"kind":"externalParam","text":"coder"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSCoder","text":"NSCoder"},{"kind":"text","text":")"}],"symbolKind":"init","roleHeading":"Initializer","role":"symbol","modules":[{"name":"Auth0"}],"extendedModule":"Auth0"},"schemaVersion":{"patch":0,"minor":3,"major":0},"kind":"symbol","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\/init(coder:)"},"variants":[{"paths":["\/documentation\/auth0\/credentials\/init(coder:)"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"convenience","kind":"keyword"},{"text":" ","kind":"text"},{"text":"init","kind":"keyword"},{"text":"?(","kind":"text"},{"text":"coder","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"aDecoder","kind":"internalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:objc(cs)NSCoder","text":"NSCoder","kind":"typeIdentifier"},{"text":")","kind":"text"}]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/init(coder:)":{"title":"init(coder:)","url":"\/documentation\/auth0\/credentials\/init(coder:)","type":"topic","fragments":[{"text":"init","kind":"identifier"},{"text":"?(","kind":"text"},{"text":"coder","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"NSCoder","preciseIdentifier":"c:objc(cs)NSCoder","kind":"typeIdentifier"},{"text":")","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/init(coder:)","kind":"symbol","abstract":[{"code":"NSSecureCoding","type":"codeVoice"},{"text":" decoding initializer.","type":"text"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"url":"\/documentation\/auth0\/credentials","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"role":"symbol","type":"topic","abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}]}}} \ No newline at end of file +{"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/init(coder:)","interfaceLanguage":"swift"},"kind":"symbol","metadata":{"externalID":"c:@CM@Auth0@objc(cs)A0Credentials(im)initWithCoder:","modules":[{"name":"Auth0"}],"title":"init(coder:)","extendedModule":"Auth0","roleHeading":"Initializer","fragments":[{"text":"init","kind":"identifier"},{"text":"?(","kind":"text"},{"text":"coder","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:objc(cs)NSCoder","text":"NSCoder","kind":"typeIdentifier"},{"text":")","kind":"text"}],"role":"symbol","symbolKind":"init"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentials\/init(coder:)"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"]]},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"convenience"},{"kind":"text","text":" "},{"kind":"keyword","text":"init"},{"kind":"text","text":"?("},{"kind":"externalParam","text":"coder"},{"kind":"text","text":" "},{"kind":"internalParam","text":"aDecoder"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"NSCoder","preciseIdentifier":"c:objc(cs)NSCoder"},{"kind":"text","text":")"}]}],"kind":"declarations"}],"abstract":[{"type":"codeVoice","code":"NSSecureCoding"},{"type":"text","text":" decoding initializer."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials/init(coder:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/init(coder:)","kind":"symbol","title":"init(coder:)","fragments":[{"text":"init","kind":"identifier"},{"text":"?(","kind":"text"},{"text":"coder","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:objc(cs)NSCoder","text":"NSCoder","kind":"typeIdentifier"},{"text":")","kind":"text"}],"role":"symbol","url":"\/documentation\/auth0\/credentials\/init(coder:)","abstract":[{"type":"codeVoice","code":"NSSecureCoding"},{"type":"text","text":" decoding initializer."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"Credentials","kind":"identifier"}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}]}}} \ 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 3ee2dbd9d..18ee8759e 100644 --- a/docs/data/documentation/auth0/credentials/init(from:).json +++ b/docs/data/documentation/auth0/credentials/init(from:).json @@ -1 +1 @@ -{"schemaVersion":{"major":0,"patch":0,"minor":3},"abstract":[{"code":"Decodable","type":"codeVoice"},{"type":"text","text":" initializer."}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/init(from:)","interfaceLanguage":"swift"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentials\/init(from:)"]}],"sections":[],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"]]},"metadata":{"roleHeading":"Initializer","role":"symbol","externalID":"s:5Auth011CredentialsC4fromACs7Decoder_p_tKcfc","extendedModule":"Auth0","symbolKind":"init","title":"init(from:)","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Decoder","kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"modules":[{"name":"Auth0"}]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"convenience"},{"kind":"text","text":" "},{"kind":"keyword","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":" "},{"kind":"internalParam","text":"decoder"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP","text":"Decoder"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"languages":["swift"],"platforms":["iOS"]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials/init(from:)":{"role":"symbol","url":"\/documentation\/auth0\/credentials\/init(from:)","kind":"symbol","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Decoder","preciseIdentifier":"s:s7DecoderP"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/init(from:)","title":"init(from:)","abstract":[{"type":"codeVoice","code":"Decodable"},{"type":"text","text":" initializer."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"url":"\/documentation\/auth0\/credentials","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"role":"symbol","type":"topic","abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"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"]]},"abstract":[{"code":"Decodable","type":"codeVoice"},{"text":" initializer.","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"convenience","kind":"keyword"},{"text":" ","kind":"text"},{"text":"init","kind":"keyword"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"decoder","kind":"internalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:s7DecoderP","text":"Decoder","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}]}]}],"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"metadata":{"externalID":"s:5Auth011CredentialsC4fromACs7Decoder_p_tKcfc","extendedModule":"Auth0","symbolKind":"init","title":"init(from:)","roleHeading":"Initializer","role":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:s7DecoderP","text":"Decoder","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"modules":[{"name":"Auth0"}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/init(from:)"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials/init(from:)":{"url":"\/documentation\/auth0\/credentials\/init(from:)","title":"init(from:)","abstract":[{"type":"codeVoice","code":"Decodable"},{"type":"text","text":" initializer."}],"fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Decoder","preciseIdentifier":"s:s7DecoderP"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/init(from:)","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"Credentials","kind":"identifier"}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}]}}} \ 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 54f25f105..1663f25d1 100644 --- a/docs/data/documentation/auth0/credentials/nscoding-implementations.json +++ b/docs/data/documentation/auth0/credentials/nscoding-implementations.json @@ -1 +1 @@ -{"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(coder:)"],"title":"Initializers","generated":true,"anchor":"Initializers"},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/encode(with:)"],"title":"Instance Methods","generated":true,"anchor":"Instance-Methods"}],"metadata":{"role":"collectionGroup","modules":[{"name":"Auth0"}],"roleHeading":"API Collection","title":"NSCoding Implementations"},"schemaVersion":{"major":0,"minor":3,"patch":0},"variants":[{"paths":["\/documentation\/auth0\/credentials\/nscoding-implementations"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"kind":"article","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/NSCoding-Implementations"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"url":"\/documentation\/auth0\/credentials","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"role":"symbol","type":"topic","abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/init(coder:)":{"title":"init(coder:)","url":"\/documentation\/auth0\/credentials\/init(coder:)","type":"topic","fragments":[{"text":"init","kind":"identifier"},{"text":"?(","kind":"text"},{"text":"coder","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"NSCoder","preciseIdentifier":"c:objc(cs)NSCoder","kind":"typeIdentifier"},{"text":")","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/init(coder:)","kind":"symbol","abstract":[{"code":"NSSecureCoding","type":"codeVoice"},{"text":" decoding initializer.","type":"text"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/encode(with:)":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/encode(with:)","role":"symbol","title":"encode(with:)","kind":"symbol","url":"\/documentation\/auth0\/credentials\/encode(with:)","abstract":[{"type":"codeVoice","code":"NSSecureCoding"},{"type":"text","text":" encoding method."}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"encode","kind":"identifier"},{"text":"(","kind":"text"},{"text":"with","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:objc(cs)NSCoder","text":"NSCoder","kind":"typeIdentifier"},{"text":")","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"kind":"article","topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/init(coder:)"],"generated":true,"title":"Initializers","anchor":"Initializers"},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/encode(with:)"],"generated":true,"title":"Instance Methods","anchor":"Instance-Methods"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentials\/nscoding-implementations"]}],"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"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\/NSCoding-Implementations"},"metadata":{"roleHeading":"API Collection","modules":[{"name":"Auth0"}],"role":"collectionGroup","title":"NSCoding Implementations"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/encode(with:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/encode(with:)","kind":"symbol","title":"encode(with:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"encode"},{"kind":"text","text":"("},{"kind":"externalParam","text":"with"},{"kind":"text","text":": "},{"preciseIdentifier":"c:objc(cs)NSCoder","kind":"typeIdentifier","text":"NSCoder"},{"kind":"text","text":")"}],"role":"symbol","url":"\/documentation\/auth0\/credentials\/encode(with:)","abstract":[{"code":"NSSecureCoding","type":"codeVoice"},{"type":"text","text":" encoding method."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"Credentials","kind":"identifier"}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/init(coder:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/init(coder:)","kind":"symbol","title":"init(coder:)","fragments":[{"text":"init","kind":"identifier"},{"text":"?(","kind":"text"},{"text":"coder","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:objc(cs)NSCoder","text":"NSCoder","kind":"typeIdentifier"},{"text":")","kind":"text"}],"role":"symbol","url":"\/documentation\/auth0\/credentials\/init(coder:)","abstract":[{"type":"codeVoice","code":"NSSecureCoding"},{"type":"text","text":" decoding initializer."}],"type":"topic"}}} \ 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 b0af8aac1..2e7918a6b 100644 --- a/docs/data/documentation/auth0/credentials/nssecurecoding-implementations.json +++ b/docs/data/documentation/auth0/credentials/nssecurecoding-implementations.json @@ -1 +1 @@ -{"metadata":{"modules":[{"name":"Auth0"}],"title":"NSSecureCoding Implementations","roleHeading":"API Collection","role":"collectionGroup"},"variants":[{"paths":["\/documentation\/auth0\/credentials\/nssecurecoding-implementations"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"article","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"]]},"sections":[],"topicSections":[{"title":"Type Properties","anchor":"Type-Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/supportsSecureCoding"],"generated":true}],"schemaVersion":{"minor":3,"major":0,"patch":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/NSSecureCoding-Implementations","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials/supportsSecureCoding":{"url":"\/documentation\/auth0\/credentials\/supportssecurecoding","type":"topic","kind":"symbol","title":"supportsSecureCoding","abstract":[{"text":"Property that enables secure coding. Equals to ","type":"text"},{"code":"true","type":"codeVoice"},{"text":".","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/supportsSecureCoding","role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"supportsSecureCoding","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"url":"\/documentation\/auth0\/credentials","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"role":"symbol","type":"topic","abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}]}}} \ No newline at end of file +{"sections":[],"metadata":{"role":"collectionGroup","title":"NSSecureCoding Implementations","roleHeading":"API Collection","modules":[{"name":"Auth0"}]},"kind":"article","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/NSSecureCoding-Implementations","interfaceLanguage":"swift"},"topicSections":[{"anchor":"Type-Properties","title":"Type Properties","generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/supportsSecureCoding"]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentials\/nssecurecoding-implementations"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"]]},"schemaVersion":{"patch":0,"minor":3,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/supportsSecureCoding":{"kind":"symbol","abstract":[{"text":"Property that enables secure coding. Equals to ","type":"text"},{"code":"true","type":"codeVoice"},{"text":".","type":"text"}],"type":"topic","title":"supportsSecureCoding","url":"\/documentation\/auth0\/credentials\/supportssecurecoding","role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"supportsSecureCoding","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/supportsSecureCoding"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"Credentials","kind":"identifier"}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"kind":"identifier","text":"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 c7504f8dc..5af75d843 100644 --- a/docs/data/documentation/auth0/credentials/recoverycode.json +++ b/docs/data/documentation/auth0/credentials/recoverycode.json @@ -1 +1 @@ -{"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\/recoveryCode"},"kind":"symbol","seeAlsoSections":[{"anchor":"Related-Documentation","identifiers":["https:\/\/auth0.com\/docs\/secure\/multi-factor-authentication\/configure-recovery-codes-for-mfa"],"title":"Related Documentation"}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"recoveryCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"languages":["swift"]}],"kind":"declarations"}],"abstract":[{"type":"text","text":"MFA recovery code that the application must display to the user, to be stored securely for future use."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentials\/recoverycode"]}],"metadata":{"symbolKind":"property","externalID":"s:5Auth011CredentialsC12recoveryCodeSSSgvp","modules":[{"name":"Auth0"}],"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"recoveryCode","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"roleHeading":"Instance Property","role":"symbol","title":"recoveryCode"},"schemaVersion":{"major":0,"patch":0,"minor":3},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"url":"\/documentation\/auth0\/credentials","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"role":"symbol","type":"topic","abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/recoveryCode":{"title":"recoveryCode","url":"\/documentation\/auth0\/credentials\/recoverycode","type":"topic","abstract":[{"text":"MFA recovery code that the application must display to the user, to be stored securely for future use.","type":"text"}],"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"recoveryCode","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"kind":"symbol","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/recoveryCode"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"https://auth0.com/docs/secure/multi-factor-authentication/configure-recovery-codes-for-mfa":{"title":"MFA Recovery Codes","titleInlineContent":[{"type":"text","text":"MFA Recovery Codes"}],"url":"https:\/\/auth0.com\/docs\/secure\/multi-factor-authentication\/configure-recovery-codes-for-mfa","identifier":"https:\/\/auth0.com\/docs\/secure\/multi-factor-authentication\/configure-recovery-codes-for-mfa","type":"link"}}} \ No newline at end of file +{"metadata":{"symbolKind":"property","title":"recoveryCode","roleHeading":"Instance Property","externalID":"s:5Auth011CredentialsC12recoveryCodeSSSgvp","modules":[{"name":"Auth0"}],"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"recoveryCode","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"role":"symbol"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentials\/recoverycode"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/recoveryCode","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"text":"MFA recovery code that the application must display to the user, to be stored securely for future use.","type":"text"}],"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\/multi-factor-authentication\/configure-recovery-codes-for-mfa"],"anchor":"Related-Documentation"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"recoveryCode"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}],"platforms":["iOS"]}]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"references":{"https://auth0.com/docs/secure/multi-factor-authentication/configure-recovery-codes-for-mfa":{"title":"MFA Recovery Codes","type":"link","titleInlineContent":[{"type":"text","text":"MFA Recovery Codes"}],"identifier":"https:\/\/auth0.com\/docs\/secure\/multi-factor-authentication\/configure-recovery-codes-for-mfa","url":"https:\/\/auth0.com\/docs\/secure\/multi-factor-authentication\/configure-recovery-codes-for-mfa"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"Credentials","kind":"identifier"}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/recoveryCode":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/recoveryCode","title":"recoveryCode","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"recoveryCode","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"role":"symbol","url":"\/documentation\/auth0\/credentials\/recoverycode","abstract":[{"type":"text","text":"MFA recovery code that the application must display to the user, to be stored securely for future use."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ 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 9ebe90bcc..e44a33fc1 100644 --- a/docs/data/documentation/auth0/credentials/refreshtoken.json +++ b/docs/data/documentation/auth0/credentials/refreshtoken.json @@ -1 +1 @@ -{"variants":[{"paths":["\/documentation\/auth0\/credentials\/refreshtoken"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/refreshToken"},"sections":[],"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"refreshToken","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]},{"kind":"content","content":[{"anchor":"discussion","type":"heading","text":"Discussion","level":2},{"style":"note","type":"aside","name":"Requires","content":[{"inlineContent":[{"text":"The scope ","type":"text"},{"code":"offline_access","type":"codeVoice"},{"text":" to have been requested on login. Make sure that your Auth0 application","type":"text"},{"text":" ","type":"text"},{"text":"has the ","type":"text"},{"inlineContent":[{"type":"text","text":"refresh token"}],"type":"strong"},{"text":" ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/update-grant-types","isActive":true,"type":"reference"},{"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"},{"type":"text","text":" "},{"type":"strong","inlineContent":[{"type":"text","text":"Allow Offline Access"}]},{"type":"text","text":" "},{"type":"reference","isActive":true,"identifier":"https:\/\/auth0.com\/docs\/get-started\/apis\/api-settings#access-settings"},{"type":"text","text":"."}],"type":"paragraph"}]}]}],"metadata":{"roleHeading":"Instance Property","title":"refreshToken","role":"symbol","externalID":"s:5Auth011CredentialsC12refreshTokenSSSgvp","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"refreshToken","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"symbolKind":"property","modules":[{"name":"Auth0"}]},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"type":"text","text":"Token that can be used to request a new access token."}],"seeAlsoSections":[{"anchor":"Related-Documentation","title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"url":"\/documentation\/auth0\/credentials","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"role":"symbol","type":"topic","abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/refreshToken":{"url":"\/documentation\/auth0\/credentials\/refreshtoken","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/refreshToken","role":"symbol","title":"refreshToken","type":"topic","abstract":[{"type":"text","text":"Token that can be used to request a new access token."}],"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"refreshToken","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"kind":"symbol"},"https://auth0.com/docs/secure/tokens/refresh-tokens":{"titleInlineContent":[{"type":"text","text":"Refresh Tokens"}],"type":"link","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","title":"Refresh Tokens","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens"},"https://auth0.com/docs/get-started/applications/update-grant-types":{"titleInlineContent":[{"type":"text","text":"grant enabled"}],"url":"https:\/\/auth0.com\/docs\/get-started\/applications\/update-grant-types","title":"grant enabled","identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/update-grant-types","type":"link"},"https://auth0.com/docs/get-started/apis/api-settings#access-settings":{"titleInlineContent":[{"type":"text","text":"setting enabled"}],"type":"link","identifier":"https:\/\/auth0.com\/docs\/get-started\/apis\/api-settings#access-settings","title":"setting enabled","url":"https:\/\/auth0.com\/docs\/get-started\/apis\/api-settings#access-settings"}}} \ No newline at end of file +{"metadata":{"symbolKind":"property","roleHeading":"Instance Property","externalID":"s:5Auth011CredentialsC12refreshTokenSSSgvp","title":"refreshToken","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"refreshToken"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}],"role":"symbol"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentials\/refreshtoken"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/refreshToken","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"text":"Token that can be used to request a new access token.","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"]]},"seeAlsoSections":[{"title":"Related Documentation","anchor":"Related-Documentation","identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"refreshToken"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}],"platforms":["iOS"]}]},{"kind":"content","content":[{"level":2,"text":"Discussion","type":"heading","anchor":"discussion"},{"name":"Requires","type":"aside","content":[{"inlineContent":[{"type":"text","text":"The scope "},{"type":"codeVoice","code":"offline_access"},{"type":"text","text":" to have been requested on login. Make sure that your Auth0 application"},{"type":"text","text":" "},{"type":"text","text":"has the "},{"type":"strong","inlineContent":[{"type":"text","text":"refresh token"}]},{"type":"text","text":" "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/update-grant-types","isActive":true},{"type":"text","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":" "},{"type":"strong","inlineContent":[{"type":"text","text":"Allow Offline Access"}]},{"type":"text","text":" "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/get-started\/apis\/api-settings#access-settings","isActive":true},{"type":"text","text":"."}],"type":"paragraph"}],"style":"note"}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"Credentials","kind":"identifier"}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"https://auth0.com/docs/secure/tokens/refresh-tokens":{"title":"Refresh Tokens","type":"link","titleInlineContent":[{"text":"Refresh Tokens","type":"text"}],"identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens"},"https://auth0.com/docs/get-started/apis/api-settings#access-settings":{"title":"setting enabled","type":"link","titleInlineContent":[{"text":"setting enabled","type":"text"}],"identifier":"https:\/\/auth0.com\/docs\/get-started\/apis\/api-settings#access-settings","url":"https:\/\/auth0.com\/docs\/get-started\/apis\/api-settings#access-settings"},"https://auth0.com/docs/get-started/applications/update-grant-types":{"title":"grant enabled","type":"link","titleInlineContent":[{"text":"grant enabled","type":"text"}],"identifier":"https:\/\/auth0.com\/docs\/get-started\/applications\/update-grant-types","url":"https:\/\/auth0.com\/docs\/get-started\/applications\/update-grant-types"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/refreshToken":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/refreshToken","kind":"symbol","title":"refreshToken","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"refreshToken"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}],"role":"symbol","url":"\/documentation\/auth0\/credentials\/refreshtoken","abstract":[{"type":"text","text":"Token that can be used to request a new access token."}],"type":"topic"}}} \ 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 1938f3370..304b3f2c5 100644 --- a/docs/data/documentation/auth0/credentials/scope.json +++ b/docs/data/documentation/auth0/credentials/scope.json @@ -1 +1 @@ -{"seeAlsoSections":[{"title":"Related Documentation","anchor":"Related-Documentation","identifiers":["https:\/\/auth0.com\/docs\/get-started\/apis\/scopes"]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentials\/scope"]}],"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"]]},"abstract":[{"text":"The scopes that have been granted by Auth0.","type":"text"}],"metadata":{"roleHeading":"Instance Property","role":"symbol","modules":[{"name":"Auth0"}],"symbolKind":"property","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"scope","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"title":"scope","externalID":"s:5Auth011CredentialsC5scopeSSSgvp"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/scope","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"scope","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"languages":["swift"]}]}],"kind":"symbol","references":{"https://auth0.com/docs/get-started/apis/scopes":{"type":"link","title":"Scopes","titleInlineContent":[{"text":"Scopes","type":"text"}],"identifier":"https:\/\/auth0.com\/docs\/get-started\/apis\/scopes","url":"https:\/\/auth0.com\/docs\/get-started\/apis\/scopes"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"url":"\/documentation\/auth0\/credentials","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"role":"symbol","type":"topic","abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/scope":{"abstract":[{"type":"text","text":"The scopes that have been granted by Auth0."}],"type":"topic","url":"\/documentation\/auth0\/credentials\/scope","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/scope","kind":"symbol","title":"scope","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/scope"},"kind":"symbol","metadata":{"externalID":"s:5Auth011CredentialsC5scopeSSSgvp","modules":[{"name":"Auth0"}],"title":"scope","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"roleHeading":"Instance Property","role":"symbol","symbolKind":"property"},"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/get-started\/apis\/scopes"],"anchor":"Related-Documentation"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentials\/scope"]}],"schemaVersion":{"patch":0,"minor":3,"major":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"]]},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"abstract":[{"type":"text","text":"The scopes that have been granted by Auth0."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"Credentials","kind":"identifier"}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}]},"https://auth0.com/docs/get-started/apis/scopes":{"title":"Scopes","url":"https:\/\/auth0.com\/docs\/get-started\/apis\/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":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/scope","kind":"symbol","title":"scope","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"scope"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}],"role":"symbol","url":"\/documentation\/auth0\/credentials\/scope","abstract":[{"type":"text","text":"The scopes that have been granted by Auth0."}],"type":"topic"}}} \ 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 ffe134173..3a890f669 100644 --- a/docs/data/documentation/auth0/credentials/supportssecurecoding.json +++ b/docs/data/documentation/auth0/credentials/supportssecurecoding.json @@ -1 +1 @@ -{"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"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":"."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentials\/supportssecurecoding"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"supportsSecureCoding","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}]}],"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"]]},"metadata":{"symbolKind":"property","extendedModule":"Auth0","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"supportsSecureCoding","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"roleHeading":"Type Property","role":"symbol","title":"supportsSecureCoding","externalID":"c:@CM@Auth0@objc(cs)A0Credentials(cpy)supportsSecureCoding","modules":[{"name":"Auth0"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials/supportsSecureCoding":{"url":"\/documentation\/auth0\/credentials\/supportssecurecoding","type":"topic","kind":"symbol","title":"supportsSecureCoding","abstract":[{"text":"Property that enables secure coding. Equals to ","type":"text"},{"code":"true","type":"codeVoice"},{"text":".","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/supportsSecureCoding","role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"supportsSecureCoding","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"url":"\/documentation\/auth0\/credentials","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"role":"symbol","type":"topic","abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}]}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"]]},"metadata":{"extendedModule":"Auth0","symbolKind":"property","modules":[{"name":"Auth0"}],"title":"supportsSecureCoding","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"supportsSecureCoding","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"externalID":"c:@CM@Auth0@objc(cs)A0Credentials(cpy)supportsSecureCoding","role":"symbol","roleHeading":"Type Property"},"sections":[],"abstract":[{"text":"Property that enables secure coding. Equals to ","type":"text"},{"code":"true","type":"codeVoice"},{"type":"text","text":"."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentials\/supportssecurecoding"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/supportsSecureCoding"},"kind":"symbol","schemaVersion":{"minor":3,"patch":0,"major":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"supportsSecureCoding"},{"kind":"text","text":": "},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials/supportsSecureCoding":{"kind":"symbol","abstract":[{"text":"Property that enables secure coding. Equals to ","type":"text"},{"code":"true","type":"codeVoice"},{"text":".","type":"text"}],"type":"topic","title":"supportsSecureCoding","url":"\/documentation\/auth0\/credentials\/supportssecurecoding","role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"supportsSecureCoding","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/supportsSecureCoding"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"Credentials","kind":"identifier"}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"kind":"identifier","text":"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 a889f9fd8..840d5931e 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"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}]}]}],"variants":[{"paths":["\/documentation\/auth0\/credentials\/tokentype"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"]]},"schemaVersion":{"minor":3,"patch":0,"major":0},"kind":"symbol","metadata":{"modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","externalID":"s:5Auth011CredentialsC9tokenTypeSSvp","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"tokenType"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"role":"symbol","title":"tokenType","symbolKind":"property"},"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/tokenType","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Indicates how the access token should be used. For example, as a bearer token."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/tokenType":{"url":"\/documentation\/auth0\/credentials\/tokentype","abstract":[{"text":"Indicates how the access token should be used. For example, as a bearer token.","type":"text"}],"title":"tokenType","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/tokenType","kind":"symbol","type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"tokenType"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"url":"\/documentation\/auth0\/credentials","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"role":"symbol","type":"topic","abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}]}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentials\/tokentype"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"]]},"abstract":[{"type":"text","text":"Indicates how the access token should be used. For example, as a bearer token."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"tokenType"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}]}]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"kind":"symbol","sections":[],"metadata":{"externalID":"s:5Auth011CredentialsC9tokenTypeSSvp","symbolKind":"property","title":"tokenType","role":"symbol","roleHeading":"Instance Property","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"tokenType","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"modules":[{"name":"Auth0"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/tokenType","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials/tokenType":{"type":"topic","title":"tokenType","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/tokenType","url":"\/documentation\/auth0\/credentials\/tokentype","abstract":[{"text":"Indicates how the access token should be used. For example, as a bearer token.","type":"text"}],"kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"tokenType"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"Credentials","kind":"identifier"}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentialsmanager.json b/docs/data/documentation/auth0/credentialsmanager.json index 777ed844f..7e632ab85 100644 --- a/docs/data/documentation/auth0/credentialsmanager.json +++ b/docs/data/documentation/auth0/credentialsmanager.json @@ -1 +1 @@ -{"abstract":[{"type":"text","text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain."}],"variants":[{"paths":["\/documentation\/auth0\/credentialsmanager"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/init(authentication:storeKey:storage:)"],"title":"Initializers","generated":true,"anchor":"Initializers"},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/user"],"title":"Instance Properties","generated":true,"anchor":"Instance-Properties"},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/apiCredentials(forAudience:scope:minTTL:parameters:headers:)-18htb","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/apiCredentials(forAudience:scope:minTTL:parameters:headers:)-8lezm","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/apiCredentials(forAudience:scope:minTTL:parameters:headers:callback:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/canRenew()","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/clear()","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/clear(forAudience:)","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\/ssoCredentials(parameters:headers:)-151ni","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/ssoCredentials(parameters:headers:)-8vdt4","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/ssoCredentials(parameters:headers:callback:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/store(credentials:)"],"title":"Instance Methods","generated":true,"anchor":"Instance-Methods"}],"metadata":{"title":"CredentialsManager","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}],"roleHeading":"Structure","symbolKind":"struct","externalID":"s:5Auth018CredentialsManagerV","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManager"}],"modules":[{"name":"Auth0"}]},"sections":[],"seeAlsoSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens"],"title":"Related Documentation","anchor":"Related-Documentation"}],"schemaVersion":{"patch":0,"minor":3,"major":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManager"}],"platforms":["iOS"]}]},{"kind":"content","content":[{"text":"Overview","type":"heading","level":2,"anchor":"overview"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The Credentials Manager is not thread-safe, except for the following methods:"}]},{"type":"unorderedList","items":[{"content":[{"inlineContent":[{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/credentials(withScope:minTTL:parameters:headers:callback:)","type":"reference"}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/apiCredentials(forAudience:scope:minTTL:parameters:headers:callback:)"}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/ssoCredentials(parameters:headers:callback:)","isActive":true}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/renew(parameters:headers:callback:)","type":"reference"}]}]}]},{"type":"paragraph","inlineContent":[{"text":"To avoid concurrency issues, do not call its non thread-safe methods and properties from different threads","type":"text"},{"text":" ","type":"text"},{"text":"without proper synchronization.","type":"text"}]}],"style":"warning","type":"aside","name":"Warning"}]}],"kind":"symbol","references":{"doc://com.auth0.Auth0/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."},{"type":"text","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"},{"type":"text","text":"."}],"title":"user","url":"\/documentation\/auth0\/credentialsmanager\/user","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"user","kind":"identifier"},{"text":": ","kind":"text"},{"text":"UserInfo","kind":"typeIdentifier","preciseIdentifier":"s:5Auth08UserInfoV"},{"text":"?","kind":"text"}],"type":"topic","kind":"symbol","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/revoke(headers:)-9mzo6":{"url":"\/documentation\/auth0\/credentialsmanager\/revoke(headers:)-9mzo6","kind":"symbol","role":"symbol","abstract":[{"text":"Calls the ","type":"text"},{"code":"\/oauth\/revoke","type":"codeVoice"},{"text":" endpoint to revoke the refresh token and then clears the credentials if the request","type":"text"},{"text":" ","type":"text"},{"text":"was successful. Otherwise, the credentials are not cleared and the subscription completes with an error.","type":"text"}],"title":"revoke(headers:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"revoke"},{"kind":"text","text":"("},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" : "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"]) -> "},{"preciseIdentifier":"s:7Combine12AnyPublisherV","kind":"typeIdentifier","text":"AnyPublisher"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/revoke(headers:)-9mzo6","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/apiCredentials(forAudience:scope:minTTL:parameters:headers:)-8lezm":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/apiCredentials(forAudience:scope:minTTL:parameters:headers:)-8lezm","role":"symbol","kind":"symbol","title":"apiCredentials(forAudience:scope:minTTL:parameters:headers:)","abstract":[{"text":"Retrieves API credentials from the Keychain and automatically renews them using the refresh token if the access","type":"text"},{"text":" ","type":"text"},{"text":"token is expired. Otherwise, it returns the retrieved API credentials as they are still valid.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanager\/apicredentials(foraudience:scope:minttl:parameters:headers:)-8lezm","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"apiCredentials","kind":"identifier"},{"text":"(","kind":"text"},{"text":"forAudience","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"text":"minTTL","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"text":", ","kind":"text"},{"text":"parameters","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","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"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"]) ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"APICredentials","kind":"typeIdentifier","preciseIdentifier":"s:5Auth014APICredentialsV"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/credentials(withScope:minTTL:parameters:headers:callback:)":{"abstract":[{"type":"text","text":"Retrieves credentials from the Keychain and automatically renews them using the refresh token if the access"},{"type":"text","text":" "},{"type":"text","text":"token is expired. Otherwise, the retrieved credentials will be returned via the success case as they are still"},{"type":"text","text":" "},{"type":"text","text":"valid. Renewed credentials will be stored in the Keychain. "},{"type":"strong","inlineContent":[{"type":"text","text":"This method is thread-safe"}]},{"type":"text","text":"."}],"url":"\/documentation\/auth0\/credentialsmanager\/credentials(withscope:minttl:parameters:headers:callback:)","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/credentials(withScope:minTTL:parameters:headers:callback:)","title":"credentials(withScope:minTTL:parameters:headers:callback:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"credentials","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withScope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"text":"minTTL","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"text":", ","kind":"text"},{"text":"parameters","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","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"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"], ","kind":"text"},{"text":"callback","kind":"externalParam"},{"text":": (","kind":"text"},{"text":"CredentialsManagerResult","kind":"typeIdentifier","preciseIdentifier":"s:5Auth024CredentialsManagerResulta"},{"text":"<","kind":"text"},{"text":"Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"text":">) -> ","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":")","kind":"text"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/credentials(withScope:minTTL:parameters:headers:)-7xldm":{"title":"credentials(withScope:minTTL:parameters:headers:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"credentials","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withScope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"text":"minTTL","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"text":", ","kind":"text"},{"text":"parameters","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","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"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"]) -> ","kind":"text"},{"text":"AnyPublisher","kind":"typeIdentifier","preciseIdentifier":"s:7Combine12AnyPublisherV"},{"text":"<","kind":"text"},{"text":"Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"text":", ","kind":"text"},{"text":"CredentialsManagerError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"},{"text":">","kind":"text"}],"url":"\/documentation\/auth0\/credentialsmanager\/credentials(withscope:minttl:parameters:headers:)-7xldm","abstract":[{"type":"text","text":"Retrieves credentials from the Keychain and automatically renews them using the refresh token if the access"},{"text":" ","type":"text"},{"text":"token is expired. Otherwise, the subscription will complete with the retrieved credentials as they are still","type":"text"},{"text":" ","type":"text"},{"text":"valid. Renewed credentials will be stored in the Keychain. ","type":"text"},{"type":"strong","inlineContent":[{"type":"text","text":"This method is thread-safe"}]},{"text":".","type":"text"}],"role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/credentials(withScope:minTTL:parameters:headers:)-7xldm","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/renew(parameters:headers:)-3jl3m":{"title":"renew(parameters:headers:)","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"}],"kind":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/renew(parameters:headers:)-3jl3m","url":"\/documentation\/auth0\/credentialsmanager\/renew(parameters:headers:)-3jl3m","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"renew"},{"kind":"text","text":"("},{"kind":"externalParam","text":"parameters"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/revokeFailed":{"type":"topic","title":"revokeFailed","kind":"symbol","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/revokeFailed","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"revokeFailed"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","kind":"typeIdentifier","text":"CredentialsManagerError"}],"url":"\/documentation\/auth0\/credentialsmanagererror\/revokefailed","abstract":[{"text":"The revocation of the refresh token failed.","type":"text"},{"text":" ","type":"text"},{"text":"The underlying ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","isActive":true,"type":"reference"},{"text":" can be accessed via the ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true,"type":"reference"},{"text":" property.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/clear()":{"abstract":[{"text":"Clears credentials stored in the Keychain.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanager\/clear()","kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"clear"},{"kind":"text","text":"() -> "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/clear()","role":"symbol","title":"clear()","type":"topic"},"https://auth0.com/docs/secure/tokens/id-tokens":{"identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens","title":"ID token","type":"link","titleInlineContent":[{"text":"ID token","type":"text"}],"url":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/canRenew()":{"kind":"symbol","url":"\/documentation\/auth0\/credentialsmanager\/canrenew()","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/canRenew()","title":"canRenew()","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"canRenew","kind":"identifier"},{"text":"() -> ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"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","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/hasValid(minTTL:)","isActive":true},{"type":"text","text":" to check for stored credentials when your app"},{"type":"text","text":" "},{"type":"text","text":"starts up."}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManager","kind":"identifier"}],"navigatorTitle":[{"text":"CredentialsManager","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","abstract":[{"type":"text","text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain."}],"kind":"symbol","title":"CredentialsManager","url":"\/documentation\/auth0\/credentialsmanager","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/apiCredentials(forAudience:scope:minTTL:parameters:headers:)-18htb":{"title":"apiCredentials(forAudience:scope:minTTL:parameters:headers:)","kind":"symbol","type":"topic","abstract":[{"type":"text","text":"Retrieves API credentials from the Keychain and automatically renews them using the refresh token if the access"},{"type":"text","text":" "},{"type":"text","text":"token is expired. Otherwise, the subscription will complete with the retrieved API credentials as they are"},{"type":"text","text":" "},{"type":"text","text":"still valid."}],"url":"\/documentation\/auth0\/credentialsmanager\/apicredentials(foraudience:scope:minttl:parameters:headers:)-18htb","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/apiCredentials(forAudience:scope:minTTL:parameters:headers:)-18htb","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"apiCredentials","kind":"identifier"},{"text":"(","kind":"text"},{"text":"forAudience","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"minTTL","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"parameters","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"], ","kind":"text"},{"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"},{"preciseIdentifier":"s:7Combine12AnyPublisherV","text":"AnyPublisher","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth014APICredentialsV","text":"APICredentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","kind":"typeIdentifier"},{"text":">","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/ssoCredentials(parameters:headers:callback:)":{"url":"\/documentation\/auth0\/credentialsmanager\/ssocredentials(parameters:headers:callback:)","abstract":[{"text":"Exchanges the refresh token for a session transfer token that can be used to perform web single sign-on (SSO).","type":"text"},{"text":" ","type":"text"},{"inlineContent":[{"type":"text","text":"This method is thread-safe"}],"type":"strong"},{"text":".","type":"text"}],"type":"topic","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ssoCredentials","kind":"identifier"},{"text":"(","kind":"text"},{"text":"parameters","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","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"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"], ","kind":"text"},{"text":"callback","kind":"externalParam"},{"text":": (","kind":"text"},{"text":"CredentialsManagerResult","kind":"typeIdentifier","preciseIdentifier":"s:5Auth024CredentialsManagerResulta"},{"text":"<","kind":"text"},{"text":"SSOCredentials","kind":"typeIdentifier","preciseIdentifier":"s:5Auth014SSOCredentialsV"},{"text":">) -> ","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":")","kind":"text"}],"role":"symbol","title":"ssoCredentials(parameters:headers:callback:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/ssoCredentials(parameters:headers:callback:)"},"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","abstract":[{"type":"text","text":"Renews credentials using the refresh token and stores them in the Keychain. "},{"type":"strong","inlineContent":[{"type":"text","text":"This method is thread-safe"}]},{"type":"text","text":"."}],"kind":"symbol","url":"\/documentation\/auth0\/credentialsmanager\/renew(parameters:headers:)-7yn20","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"renew"},{"kind":"text","text":"("},{"kind":"externalParam","text":"parameters"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" : "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"]) -> "},{"preciseIdentifier":"s:7Combine12AnyPublisherV","kind":"typeIdentifier","text":"AnyPublisher"},{"kind":"text","text":"<"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","text":"Credentials"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","kind":"typeIdentifier","text":"CredentialsManagerError"},{"kind":"text","text":">"}],"title":"renew(parameters:headers:)"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/credentials(withScope:minTTL:parameters:headers:)-11d2f":{"role":"symbol","kind":"symbol","url":"\/documentation\/auth0\/credentialsmanager\/credentials(withscope:minttl:parameters:headers:)-11d2f","type":"topic","abstract":[{"text":"Retrieves credentials from the Keychain and automatically renews them using the refresh token if the access","type":"text"},{"text":" ","type":"text"},{"text":"token is expired. Otherwise, it returns the retrieved credentials as they are still valid. Renewed credentials","type":"text"},{"text":" ","type":"text"},{"text":"will be stored in the Keychain. ","type":"text"},{"inlineContent":[{"type":"text","text":"This method is thread-safe"}],"type":"strong"},{"text":".","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/credentials(withScope:minTTL:parameters:headers:)-11d2f","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"credentials","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withScope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"minTTL","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Int","preciseIdentifier":"s:Si","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"parameters","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"], ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"]) ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier"}],"title":"credentials(withScope:minTTL:parameters:headers:)"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"url":"\/documentation\/auth0\/credentialsmanagererror","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}],"title":"CredentialsManagerError","kind":"symbol","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/init(authentication:storeKey:storage:)":{"fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"authentication","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Authentication","kind":"typeIdentifier","preciseIdentifier":"s:5Auth014AuthenticationP"},{"text":", ","kind":"text"},{"text":"storeKey","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"storage","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"CredentialsStorage","kind":"typeIdentifier","preciseIdentifier":"s:5Auth018CredentialsStorageP"},{"text":")","kind":"text"}],"type":"topic","title":"init(authentication:storeKey:storage:)","url":"\/documentation\/auth0\/credentialsmanager\/init(authentication:storekey:storage:)","role":"symbol","abstract":[{"type":"text","text":"Creates a new "},{"type":"codeVoice","code":"CredentialsManager"},{"text":" instance.","type":"text"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/init(authentication:storeKey:storage:)"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/ssoCredentials(parameters:headers:)-8vdt4":{"abstract":[{"type":"text","text":"Exchanges the refresh token for a session transfer token that can be used to perform web single sign-on (SSO)."},{"type":"text","text":" "},{"type":"strong","inlineContent":[{"type":"text","text":"This method is thread-safe"}]},{"type":"text","text":"."}],"url":"\/documentation\/auth0\/credentialsmanager\/ssocredentials(parameters:headers:)-8vdt4","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/ssoCredentials(parameters:headers:)-8vdt4","title":"ssoCredentials(parameters:headers:)","type":"topic","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ssoCredentials","kind":"identifier"},{"text":"(","kind":"text"},{"text":"parameters","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","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"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"]) ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"SSOCredentials","kind":"typeIdentifier","preciseIdentifier":"s:5Auth014SSOCredentialsV"}],"kind":"symbol","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/apiCredentials(forAudience:scope:minTTL:parameters:headers:callback:)":{"url":"\/documentation\/auth0\/credentialsmanager\/apicredentials(foraudience:scope:minttl:parameters:headers:callback:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"apiCredentials","kind":"identifier"},{"text":"(","kind":"text"},{"text":"forAudience","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"text":"minTTL","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"text":", ","kind":"text"},{"text":"parameters","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","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"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"], ","kind":"text"},{"text":"callback","kind":"externalParam"},{"text":": (","kind":"text"},{"text":"CredentialsManagerResult","kind":"typeIdentifier","preciseIdentifier":"s:5Auth024CredentialsManagerResulta"},{"text":"<","kind":"text"},{"text":"APICredentials","kind":"typeIdentifier","preciseIdentifier":"s:5Auth014APICredentialsV"},{"text":">) -> ","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":")","kind":"text"}],"type":"topic","title":"apiCredentials(forAudience:scope:minTTL:parameters:headers:callback:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/apiCredentials(forAudience:scope:minTTL:parameters:headers:callback:)","kind":"symbol","role":"symbol","abstract":[{"text":"Retrieves API credentials from the Keychain and automatically renews them using the refresh token if the access","type":"text"},{"text":" ","type":"text"},{"text":"token is expired. Otherwise, the retrieved API credentials will be returned via the success case as they are","type":"text"},{"text":" ","type":"text"},{"text":"still valid.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/revoke(headers:_:)":{"type":"topic","abstract":[{"type":"text","text":"Calls the "},{"code":"\/oauth\/revoke","type":"codeVoice"},{"type":"text","text":" endpoint to revoke the refresh token and then clears the credentials if the request"},{"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,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/revokeFailed","type":"reference"},{"type":"text","text":" error."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/revoke(headers:_:)","url":"\/documentation\/auth0\/credentialsmanager\/revoke(headers:_:)","kind":"symbol","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"revoke","kind":"identifier"},{"text":"(","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"], (","kind":"text"},{"text":"CredentialsManagerResult","kind":"typeIdentifier","preciseIdentifier":"s:5Auth024CredentialsManagerResulta"},{"text":"<","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":">) -> ","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":")","kind":"text"}],"title":"revoke(headers:_:)"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/ssoCredentials(parameters:headers:)-151ni":{"url":"\/documentation\/auth0\/credentialsmanager\/ssocredentials(parameters:headers:)-151ni","abstract":[{"type":"text","text":"Exchanges the refresh token for a session transfer token that can be used to perform web single sign-on (SSO)."},{"type":"text","text":" "},{"type":"strong","inlineContent":[{"text":"This method is thread-safe","type":"text"}]},{"type":"text","text":"."}],"role":"symbol","title":"ssoCredentials(parameters:headers:)","type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/ssoCredentials(parameters:headers:)-151ni","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"ssoCredentials"},{"kind":"text","text":"("},{"kind":"externalParam","text":"parameters"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"]) -> "},{"kind":"typeIdentifier","text":"AnyPublisher","preciseIdentifier":"s:7Combine12AnyPublisherV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"SSOCredentials","preciseIdentifier":"s:5Auth014SSOCredentialsV"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"},{"kind":"text","text":">"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/enableBiometrics(withTitle:cancelTitle:fallbackTitle:evaluationPolicy:)":{"url":"\/documentation\/auth0\/credentialsmanager\/enablebiometrics(withtitle:canceltitle:fallbacktitle:evaluationpolicy:)","kind":"symbol","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:)","title":"enableBiometrics(withTitle:cancelTitle:fallbackTitle:evaluationPolicy:)","type":"topic","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"enableBiometrics","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withTitle","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"cancelTitle","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"fallbackTitle","kind":"externalParam"},{"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"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/revoke(headers:)-6wgai":{"type":"topic","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"revoke"},{"kind":"text","text":"("},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"role":"symbol","kind":"symbol","abstract":[{"text":"Calls the ","type":"text"},{"code":"\/oauth\/revoke","type":"codeVoice"},{"text":" endpoint to revoke the refresh token and then clears the credentials if the request","type":"text"},{"text":" ","type":"text"},{"text":"was successful. Otherwise, the credentials are not cleared and an error is thrown.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/revoke(headers:)-6wgai","url":"\/documentation\/auth0\/credentialsmanager\/revoke(headers:)-6wgai","title":"revoke(headers:)"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/hasValid(minTTL:)":{"url":"\/documentation\/auth0\/credentialsmanager\/hasvalid(minttl:)","abstract":[{"text":"Checks that there are credentials stored, and that the access token has not expired and will not expire within","type":"text"},{"text":" ","type":"text"},{"text":"the specified TTL. If you are not using refresh tokens, use this method instead of ","type":"text"},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/canRenew()"},{"text":" to","type":"text"},{"text":" ","type":"text"},{"text":"check for stored credentials when your app starts up.","type":"text"}],"role":"symbol","title":"hasValid(minTTL:)","type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/hasValid(minTTL:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"hasValid","kind":"identifier"},{"text":"(","kind":"text"},{"text":"minTTL","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/store(credentials:)":{"abstract":[{"type":"text","text":"Stores a "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","isActive":true},{"type":"text","text":" instance in the Keychain."}],"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/credentialsmanager\/store(credentials:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/store(credentials:)","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"store"},{"kind":"text","text":"("},{"kind":"externalParam","text":"credentials"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"title":"store(credentials:)"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/clear(forAudience:)":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"clear","kind":"identifier"},{"text":"(","kind":"text"},{"text":"forAudience","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"kind":"symbol","role":"symbol","title":"clear(forAudience:)","abstract":[{"type":"text","text":"Clears API credentials stored in the Keychain for a given audience value."}],"url":"\/documentation\/auth0\/credentialsmanager\/clear(foraudience:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/clear(forAudience:)","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"url":"\/documentation\/auth0\/credentials","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"role":"symbol","type":"topic","abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/RefreshTokens":{"url":"\/documentation\/auth0\/refreshtokens","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens","kind":"article","title":"Refresh Tokens: Common Errors","type":"topic","abstract":[],"role":"article"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/renew(parameters:headers:callback:)":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/renew(parameters:headers:callback:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"renew","kind":"identifier"},{"text":"(","kind":"text"},{"text":"parameters","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","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"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"], ","kind":"text"},{"text":"callback","kind":"externalParam"},{"text":": (","kind":"text"},{"text":"CredentialsManagerResult","kind":"typeIdentifier","preciseIdentifier":"s:5Auth024CredentialsManagerResulta"},{"text":"<","kind":"text"},{"text":"Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"text":">) -> ","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":")","kind":"text"}],"title":"renew(parameters:headers:callback:)","url":"\/documentation\/auth0\/credentialsmanager\/renew(parameters:headers:callback:)","role":"symbol","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"}]},{"type":"text","text":"."}],"type":"topic"}}} \ No newline at end of file +{"abstract":[{"type":"text","text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain."}],"seeAlsoSections":[{"title":"Related Documentation","anchor":"Related-Documentation","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManager"}],"languages":["swift"],"platforms":["iOS"]}]},{"kind":"content","content":[{"level":2,"anchor":"overview","text":"Overview","type":"heading"},{"content":[{"type":"paragraph","inlineContent":[{"text":"The Credentials Manager is not thread-safe, except for the following methods:","type":"text"}]},{"type":"unorderedList","items":[{"content":[{"inlineContent":[{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/credentials(withScope:minTTL:parameters:headers:callback:)","isActive":true}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/apiCredentials(forAudience:scope:minTTL:parameters:headers:callback:)","isActive":true}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/ssoCredentials(parameters:headers:callback:)","isActive":true}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/renew(parameters:headers:callback:)","isActive":true}],"type":"paragraph"}]}]},{"type":"paragraph","inlineContent":[{"text":"To avoid concurrency issues, do not call its non thread-safe methods and properties from different threads","type":"text"},{"text":" ","type":"text"},{"text":"without proper synchronization.","type":"text"}]}],"style":"warning","name":"Warning","type":"aside"}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanager"]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"topicSections":[{"title":"Initializers","generated":true,"anchor":"Initializers","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/init(authentication:storeKey:storage:)"]},{"title":"Instance Properties","generated":true,"anchor":"Instance-Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/user"]},{"title":"Instance Methods","generated":true,"anchor":"Instance-Methods","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/apiCredentials(forAudience:scope:minTTL:parameters:headers:)-18htb","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/apiCredentials(forAudience:scope:minTTL:parameters:headers:)-8lezm","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/apiCredentials(forAudience:scope:minTTL:parameters:headers:callback:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/canRenew()","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/clear()","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/clear(forAudience:scope:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/clearBiometricSession()","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:policy:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/hasValid(minTTL:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/isBiometricSessionValid()","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\/ssoCredentials(parameters:headers:)-151ni","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/ssoCredentials(parameters:headers:)-8vdt4","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/ssoCredentials(parameters:headers:callback:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/store(apiCredentials:forAudience:forScope:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/store(credentials:)"]}],"metadata":{"navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}],"modules":[{"name":"Auth0"}],"symbolKind":"struct","roleHeading":"Structure","title":"CredentialsManager","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManager"}],"externalID":"s:5Auth018CredentialsManagerV"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","interfaceLanguage":"swift"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/ssoCredentials(parameters:headers:callback:)":{"type":"topic","abstract":[{"text":"Exchanges the refresh token for a session transfer token that can be used to perform web single sign-on (SSO).","type":"text"},{"text":" ","type":"text"},{"inlineContent":[{"type":"text","text":"This method is thread-safe"}],"type":"strong"},{"text":".","type":"text"}],"title":"ssoCredentials(parameters:headers:callback:)","kind":"symbol","url":"\/documentation\/auth0\/credentialsmanager\/ssocredentials(parameters:headers:callback:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ssoCredentials","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"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"callback"},{"kind":"text","text":": ("},{"text":"CredentialsManagerResult","preciseIdentifier":"s:5Auth024CredentialsManagerResulta","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth014SSOCredentialsV","kind":"typeIdentifier","text":"SSOCredentials"},{"text":">) -> ","kind":"text"},{"text":"Void","preciseIdentifier":"s:s4Voida","kind":"typeIdentifier"},{"text":")","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/ssoCredentials(parameters:headers:callback:)"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/enableBiometrics(withTitle:cancelTitle:fallbackTitle:evaluationPolicy:policy:)":{"title":"enableBiometrics(withTitle:cancelTitle:fallbackTitle:evaluationPolicy:policy:)","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/enableBiometrics(withTitle:cancelTitle:fallbackTitle:evaluationPolicy:policy:)","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"enableBiometrics"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withTitle"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"text":"cancelTitle","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"fallbackTitle"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"evaluationPolicy"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:@E@LAPolicy","text":"LAPolicy"},{"kind":"text","text":", "},{"text":"policy","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015BiometricPolicyO","text":"BiometricPolicy"},{"kind":"text","text":")"}],"abstract":[{"type":"text","text":"Enables biometric authentication for additional security during credentials retrieval."}],"url":"\/documentation\/auth0\/credentialsmanager\/enablebiometrics(withtitle:canceltitle:fallbacktitle:evaluationpolicy:policy:)"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/isBiometricSessionValid()":{"url":"\/documentation\/auth0\/credentialsmanager\/isbiometricsessionvalid()","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"isBiometricSessionValid"},{"kind":"text","text":"() -> "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"title":"isBiometricSessionValid()","type":"topic","role":"symbol","abstract":[{"text":"Checks if the current biometric session is valid based on the configured policy.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/isBiometricSessionValid()","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/credentials(withScope:minTTL:parameters:headers:)-7xldm":{"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 automatically renews them using the refresh token if the access"},{"type":"text","text":" "},{"type":"text","text":"token is expired. Otherwise, the subscription will complete with the retrieved credentials as they are still"},{"type":"text","text":" "},{"type":"text","text":"valid. Renewed credentials will be stored in the Keychain. "},{"inlineContent":[{"type":"text","text":"This method is thread-safe"}],"type":"strong"},{"type":"text","text":"."}],"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"},{"text":"?, ","kind":"text"},{"text":"minTTL","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"parameters","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"]) -> "},{"preciseIdentifier":"s:7Combine12AnyPublisherV","text":"AnyPublisher","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/credentials(withScope:minTTL:parameters:headers:)-7xldm","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/ssoCredentials(parameters:headers:)-151ni":{"role":"symbol","title":"ssoCredentials(parameters:headers:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"ssoCredentials"},{"kind":"text","text":"("},{"kind":"externalParam","text":"parameters"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"]) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:7Combine12AnyPublisherV","text":"AnyPublisher"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth014SSOCredentialsV","text":"SSOCredentials"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"},{"kind":"text","text":">"}],"abstract":[{"type":"text","text":"Exchanges the refresh token for a session transfer token that can be used to perform web single sign-on (SSO)."},{"type":"text","text":" "},{"type":"strong","inlineContent":[{"type":"text","text":"This method is thread-safe"}]},{"type":"text","text":"."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/ssoCredentials(parameters:headers:)-151ni","url":"\/documentation\/auth0\/credentialsmanager\/ssocredentials(parameters:headers:)-151ni","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/credentials(withScope:minTTL:parameters:headers:)-11d2f":{"type":"topic","abstract":[{"type":"text","text":"Retrieves credentials from the Keychain and automatically renews them using the refresh token if the access"},{"type":"text","text":" "},{"type":"text","text":"token is expired. Otherwise, it returns the retrieved credentials as they are still valid. Renewed credentials"},{"type":"text","text":" "},{"type":"text","text":"will be stored in the Keychain. "},{"inlineContent":[{"type":"text","text":"This method is thread-safe"}],"type":"strong"},{"type":"text","text":"."}],"kind":"symbol","url":"\/documentation\/auth0\/credentialsmanager\/credentials(withscope:minttl:parameters:headers:)-11d2f","title":"credentials(withScope:minTTL:parameters:headers:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"credentials","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"withScope"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"minTTL"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"},{"text":", ","kind":"text"},{"text":"parameters","kind":"externalParam"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"text":"], ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"]) ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/credentials(withScope:minTTL:parameters:headers:)-11d2f"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"role":"symbol","title":"CredentialsManagerError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerError"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}],"abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","url":"\/documentation\/auth0\/credentialsmanagererror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/store(apiCredentials:forAudience:forScope:)":{"type":"topic","title":"store(apiCredentials:forAudience:forScope:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/store(apiCredentials:forAudience:forScope:)","url":"\/documentation\/auth0\/credentialsmanager\/store(apicredentials:foraudience:forscope:)","abstract":[],"kind":"symbol","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"store","kind":"identifier"},{"text":"(","kind":"text"},{"text":"apiCredentials","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"APICredentials","kind":"typeIdentifier","preciseIdentifier":"s:5Auth014APICredentialsV"},{"text":", ","kind":"text"},{"text":"forAudience","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"forScope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?) -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/clearBiometricSession()":{"url":"\/documentation\/auth0\/credentialsmanager\/clearbiometricsession()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"clearBiometricSession"},{"kind":"text","text":"()"}],"title":"clearBiometricSession()","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Clears the in-memory biometric session timestamp. This will force biometric authentication on the next"},{"type":"text","text":" "},{"type":"text","text":"credential access."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/clearBiometricSession()","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/init(authentication:storeKey:storage:)":{"url":"\/documentation\/auth0\/credentialsmanager\/init(authentication:storekey:storage:)","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"authentication","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Authentication","preciseIdentifier":"s:5Auth014AuthenticationP","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"storeKey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"storage"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CredentialsStorage","preciseIdentifier":"s:5Auth018CredentialsStorageP"},{"kind":"text","text":")"}],"title":"init(authentication:storeKey:storage:)","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Creates a new "},{"type":"codeVoice","code":"CredentialsManager"},{"type":"text","text":" instance."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/init(authentication:storeKey:storage:)","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"Credentials","kind":"identifier"}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/apiCredentials(forAudience:scope:minTTL:parameters:headers:callback:)":{"kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"apiCredentials"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forAudience"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"minTTL"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"},{"kind":"text","text":", "},{"kind":"externalParam","text":"parameters"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" : "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"callback"},{"kind":"text","text":": ("},{"preciseIdentifier":"s:5Auth024CredentialsManagerResulta","kind":"typeIdentifier","text":"CredentialsManagerResult"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:5Auth014APICredentialsV","kind":"typeIdentifier","text":"APICredentials"},{"kind":"text","text":">) -> "},{"preciseIdentifier":"s:s4Voida","kind":"typeIdentifier","text":"Void"},{"kind":"text","text":")"}],"title":"apiCredentials(forAudience:scope:minTTL:parameters:headers:callback:)","type":"topic","role":"symbol","abstract":[{"text":"Retrieves API credentials from the Keychain and automatically renews them using the refresh token if the access","type":"text"},{"text":" ","type":"text"},{"text":"token is expired. Otherwise, the retrieved API credentials will be returned via the success case as they are","type":"text"},{"text":" ","type":"text"},{"text":"still valid.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/apiCredentials(forAudience:scope:minTTL:parameters:headers:callback:)","url":"\/documentation\/auth0\/credentialsmanager\/apicredentials(foraudience:scope:minttl:parameters:headers:callback:)"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/clear()":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/clear()","kind":"symbol","title":"clear()","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"clear","kind":"identifier"},{"text":"() -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"role":"symbol","url":"\/documentation\/auth0\/credentialsmanager\/clear()","abstract":[{"type":"text","text":"Clears credentials stored in the Keychain."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/RefreshTokens":{"title":"Refresh Tokens: Common Errors","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens","role":"article","kind":"article","abstract":[],"url":"\/documentation\/auth0\/refreshtokens"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/credentials(withScope:minTTL:parameters:headers:callback:)":{"type":"topic","title":"credentials(withScope:minTTL:parameters:headers:callback:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/credentials(withScope:minTTL:parameters:headers:callback:)","kind":"symbol","abstract":[{"type":"text","text":"Retrieves credentials from the Keychain and automatically renews them using the refresh token if the access"},{"type":"text","text":" "},{"type":"text","text":"token is expired. Otherwise, the retrieved credentials will be returned via the success case as they are still"},{"type":"text","text":" "},{"type":"text","text":"valid. Renewed credentials will be stored in the Keychain. "},{"type":"strong","inlineContent":[{"type":"text","text":"This method is thread-safe"}]},{"type":"text","text":"."}],"url":"\/documentation\/auth0\/credentialsmanager\/credentials(withscope:minttl:parameters:headers:callback:)","role":"symbol","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"},{"text":"?, ","kind":"text"},{"text":"minTTL","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"parameters","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"], ","kind":"text"},{"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"},{"text":"callback","kind":"externalParam"},{"text":": (","kind":"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"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"text":")","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/revoke(headers:)-9mzo6":{"role":"symbol","title":"revoke(headers:)","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"revoke","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"headers"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"]) -> "},{"kind":"typeIdentifier","text":"AnyPublisher","preciseIdentifier":"s:7Combine12AnyPublisherV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":", "},{"text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"abstract":[{"text":"Calls the ","type":"text"},{"type":"codeVoice","code":"\/oauth\/revoke"},{"text":" endpoint to revoke the refresh token and then clears the credentials if the request","type":"text"},{"text":" ","type":"text"},{"text":"was successful. Otherwise, the credentials are not cleared and the subscription completes with an error.","type":"text"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/revoke(headers:)-9mzo6","url":"\/documentation\/auth0\/credentialsmanager\/revoke(headers:)-9mzo6","type":"topic"},"https://auth0.com/docs/secure/tokens/id-tokens":{"type":"link","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens","title":"ID token","titleInlineContent":[{"type":"text","text":"ID token"}]},"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","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"store"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"credentials"},{"kind":"text","text":": "},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","text":"Credentials"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"abstract":[{"type":"text","text":"Stores a "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","isActive":true},{"type":"text","text":" instance in the Keychain."}],"url":"\/documentation\/auth0\/credentialsmanager\/store(credentials:)"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/apiCredentials(forAudience:scope:minTTL:parameters:headers:)-18htb":{"kind":"symbol","abstract":[{"type":"text","text":"Retrieves API credentials from the Keychain and automatically renews them using the refresh token if the access"},{"type":"text","text":" "},{"type":"text","text":"token is expired. Otherwise, the subscription will complete with the retrieved API credentials as they are"},{"type":"text","text":" "},{"type":"text","text":"still valid."}],"type":"topic","url":"\/documentation\/auth0\/credentialsmanager\/apicredentials(foraudience:scope:minttl:parameters:headers:)-18htb","title":"apiCredentials(forAudience:scope:minTTL:parameters:headers:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"apiCredentials","kind":"identifier"},{"text":"(","kind":"text"},{"text":"forAudience","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"minTTL"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"},{"kind":"text","text":", "},{"kind":"externalParam","text":"parameters"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"]) -> "},{"kind":"typeIdentifier","text":"AnyPublisher","preciseIdentifier":"s:7Combine12AnyPublisherV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth014APICredentialsV","text":"APICredentials"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/apiCredentials(forAudience:scope:minTTL:parameters:headers:)-18htb"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/revoke(headers:_:)":{"url":"\/documentation\/auth0\/credentialsmanager\/revoke(headers:_:)","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"},{"text":" ","type":"text"},{"text":"was successful. Otherwise, the credentials will not be cleared and the callback will be called with a failure","type":"text"},{"text":" ","type":"text"},{"text":"result containing a ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/revokeFailed","type":"reference"},{"text":" error.","type":"text"}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"revoke"},{"kind":"text","text":"("},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"], ("},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth024CredentialsManagerResulta","text":"CredentialsManagerResult"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"kind":"text","text":">) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"text":")","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/revoke(headers:_:)","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/apiCredentials(forAudience:scope:minTTL:parameters:headers:)-8lezm":{"title":"apiCredentials(forAudience:scope:minTTL:parameters:headers:)","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/apiCredentials(forAudience:scope:minTTL:parameters:headers:)-8lezm","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"apiCredentials"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forAudience"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"minTTL"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"},{"kind":"text","text":", "},{"kind":"externalParam","text":"parameters"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth014APICredentialsV","text":"APICredentials"}],"abstract":[{"type":"text","text":"Retrieves API credentials from the Keychain and automatically renews them using the refresh token if the access"},{"type":"text","text":" "},{"type":"text","text":"token is expired. Otherwise, it returns the retrieved API credentials as they are still valid."}],"url":"\/documentation\/auth0\/credentialsmanager\/apicredentials(foraudience:scope:minttl:parameters:headers:)-8lezm"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/renew(parameters:headers:)-7yn20":{"url":"\/documentation\/auth0\/credentialsmanager\/renew(parameters:headers:)-7yn20","title":"renew(parameters:headers:)","abstract":[{"type":"text","text":"Renews credentials using the refresh token and stores them in the Keychain. "},{"type":"strong","inlineContent":[{"type":"text","text":"This method is thread-safe"}]},{"type":"text","text":"."}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"renew"},{"kind":"text","text":"("},{"kind":"externalParam","text":"parameters"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" : "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"]) -> "},{"preciseIdentifier":"s:7Combine12AnyPublisherV","kind":"typeIdentifier","text":"AnyPublisher"},{"kind":"text","text":"<"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","text":"Credentials"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","kind":"typeIdentifier","text":"CredentialsManagerError"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/renew(parameters:headers:)-7yn20","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/renew(parameters:headers:)-3jl3m":{"type":"topic","title":"renew(parameters:headers:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/renew(parameters:headers:)-3jl3m","kind":"symbol","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:)-3jl3m","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"renew"},{"kind":"text","text":"("},{"kind":"externalParam","text":"parameters"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" : "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","text":"Credentials"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/revokeFailed":{"type":"topic","abstract":[{"type":"text","text":"The revocation of the refresh token 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","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true},{"type":"text","text":" property."}],"title":"revokeFailed","kind":"symbol","url":"\/documentation\/auth0\/credentialsmanagererror\/revokefailed","role":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"revokeFailed"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/revokeFailed"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/renew(parameters:headers:callback:)":{"type":"topic","abstract":[{"text":"Renews credentials using the refresh token and stores them in the Keychain. ","type":"text"},{"inlineContent":[{"type":"text","text":"This method is thread-safe"}],"type":"strong"},{"text":".","type":"text"}],"title":"renew(parameters:headers:callback:)","kind":"symbol","url":"\/documentation\/auth0\/credentialsmanager\/renew(parameters:headers:callback:)","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"renew"},{"kind":"text","text":"("},{"kind":"externalParam","text":"parameters"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"callback"},{"kind":"text","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":">) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"kind":"text","text":")"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/renew(parameters:headers:callback:)"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/ssoCredentials(parameters:headers:)-8vdt4":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/ssoCredentials(parameters:headers:)-8vdt4","title":"ssoCredentials(parameters:headers:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"ssoCredentials"},{"kind":"text","text":"("},{"kind":"externalParam","text":"parameters"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth014SSOCredentialsV","text":"SSOCredentials"}],"role":"symbol","url":"\/documentation\/auth0\/credentialsmanager\/ssocredentials(parameters:headers:)-8vdt4","abstract":[{"type":"text","text":"Exchanges the refresh token for a session transfer token that can be used to perform web single sign-on (SSO)."},{"type":"text","text":" "},{"inlineContent":[{"type":"text","text":"This method is thread-safe"}],"type":"strong"},{"type":"text","text":"."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/user":{"kind":"symbol","abstract":[{"text":"Retrieves the user information from the Keychain synchronously, without checking if the credentials are expired.","type":"text"},{"text":" ","type":"text"},{"text":"The user information is read from the stored ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens","isActive":true,"type":"reference"},{"type":"text","text":"."}],"type":"topic","title":"user","url":"\/documentation\/auth0\/credentialsmanager\/user","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"user","kind":"identifier"},{"text":": ","kind":"text"},{"text":"UserInfo","preciseIdentifier":"s:5Auth08UserInfoV","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/user"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/canRenew()":{"url":"\/documentation\/auth0\/credentialsmanager\/canrenew()","abstract":[{"type":"text","text":"Checks that there are credentials stored, and that the credentials contain a refresh token. If you are using"},{"type":"text","text":" "},{"type":"text","text":"refresh tokens, use this method instead of "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/hasValid(minTTL:)","isActive":true},{"type":"text","text":" to check for stored credentials when your app"},{"type":"text","text":" "},{"type":"text","text":"starts up."}],"title":"canRenew()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"canRenew"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/canRenew()","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/revoke(headers:)-6wgai":{"type":"topic","title":"revoke(headers:)","identifier":"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"},{"type":"text","text":" "},{"type":"text","text":"was successful. Otherwise, the credentials are not cleared and an error is thrown."}],"url":"\/documentation\/auth0\/credentialsmanager\/revoke(headers:)-6wgai","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"revoke"},{"kind":"text","text":"("},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" : "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"title":"CredentialsManager","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManager"}],"abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanager","navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/hasValid(minTTL:)":{"kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"hasValid"},{"kind":"text","text":"("},{"text":"minTTL","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Int","preciseIdentifier":"s:Si","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"title":"hasValid(minTTL:)","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Checks that there are credentials stored, and that the access token has not expired and will not expire within"},{"type":"text","text":" "},{"type":"text","text":"the specified TTL. If you are not using refresh tokens, use this method instead of "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/canRenew()","isActive":true},{"type":"text","text":" to"},{"type":"text","text":" "},{"type":"text","text":"check for stored credentials when your app starts up."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/hasValid(minTTL:)","url":"\/documentation\/auth0\/credentialsmanager\/hasvalid(minttl:)"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/clear(forAudience:scope:)":{"type":"topic","abstract":[{"type":"text","text":"Clears API credentials stored in the Keychain for a given audience value."}],"title":"clear(forAudience:scope:)","kind":"symbol","url":"\/documentation\/auth0\/credentialsmanager\/clear(foraudience:scope:)","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"clear"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forAudience"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?) -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/clear(forAudience:scope:)"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentialsmanager/apicredentials(foraudience:scope:minttl:parameters:headers:)-18htb.json b/docs/data/documentation/auth0/credentialsmanager/apicredentials(foraudience:scope:minttl:parameters:headers:)-18htb.json index 22b0ebbf6..42bdd7ffc 100644 --- a/docs/data/documentation/auth0/credentialsmanager/apicredentials(foraudience:scope:minttl:parameters:headers:)-18htb.json +++ b/docs/data/documentation/auth0/credentialsmanager/apicredentials(foraudience:scope:minttl:parameters:headers:)-18htb.json @@ -1 +1 @@ -{"kind":"symbol","sections":[],"metadata":{"externalID":"s:5Auth018CredentialsManagerV03apiB011forAudience5scope6minTTL10parameters7headers7Combine12AnyPublisherVyAA14APICredentialsVAA0bC5ErrorVGSS_SSSgSiSDySSypGSDyS2SGtF","roleHeading":"Instance Method","symbolKind":"method","title":"apiCredentials(forAudience:scope:minTTL:parameters:headers:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"apiCredentials","kind":"identifier"},{"text":"(","kind":"text"},{"text":"forAudience","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"minTTL","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"parameters","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"], ","kind":"text"},{"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"},{"preciseIdentifier":"s:7Combine12AnyPublisherV","text":"AnyPublisher","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth014APICredentialsV","text":"APICredentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"extendedModule":"Auth0","modules":[{"name":"Auth0"}],"role":"symbol"},"seeAlsoSections":[{"anchor":"Related-Documentation","title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/get-started\/apis\/scopes","https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","https:\/\/auth0.com\/docs\/api\/authentication\/refresh-token\/refresh-token","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens"]}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"apiCredentials","kind":"identifier"},{"text":"(","kind":"text"},{"text":"forAudience","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"audience","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"? = nil, ","kind":"text"},{"text":"minTTL","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"text":" = 0, ","kind":"text"},{"text":"parameters","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","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"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"] = [:]) -> ","kind":"text"},{"text":"AnyPublisher","kind":"typeIdentifier","preciseIdentifier":"s:7Combine12AnyPublisherV"},{"text":"<","kind":"text"},{"text":"APICredentials","kind":"typeIdentifier","preciseIdentifier":"s:5Auth014APICredentialsV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials"},{"text":", ","kind":"text"},{"text":"CredentialsManagerError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"},{"text":">","kind":"text"}],"platforms":["iOS"]}],"kind":"declarations"},{"parameters":[{"name":"audience","content":[{"inlineContent":[{"type":"text","text":"Identifier of the API that your application is requesting access to."}],"type":"paragraph"}]},{"name":"scope","content":[{"type":"paragraph","inlineContent":[{"text":"Space-separated list of scope values to request when exchanging a refresh token for API credentials. Defaults to ","type":"text"},{"code":"nil","type":"codeVoice"},{"text":", which will ask for the default scopes configured for the API.","type":"text"}]}]},{"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"},{"type":"codeVoice","code":"0"},{"text":".","type":"text"}]}]},{"name":"parameters","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Additional parameters to use when exchanging a refresh token for API credentials."}]}]},{"name":"headers","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Additional headers to use when exchanging a refresh token for API credentials."}]}]}],"kind":"parameters"},{"content":[{"anchor":"discussion","text":"Discussion","level":2,"type":"heading"},{"inlineContent":[{"type":"text","text":"If there are no stored API credentials, the refresh token will be exchaged for a new set of API credentials."},{"type":"text","text":" "},{"type":"text","text":"New or renewed API credentials will be automatically stored in the Keychain. "},{"inlineContent":[{"text":"This method is thread-safe","type":"text"}],"type":"strong"},{"type":"text","text":"."}],"type":"paragraph"},{"anchor":"Usage","text":"Usage","level":2,"type":"heading"},{"syntax":"swift","code":["credentialsManager"," .apiCredentials(forAudience: \"http:\/\/example.com\/api\")"," .sink(receiveCompletion: { completion in"," if case .failure(let error) = completion {"," print(\"Failed with: \\(error)\")"," }"," }, receiveValue: { apiCredentials in"," print(\"Obtained API credentials: \\(apiCredentials)\")"," })"," .store(in: &cancellables)"],"type":"codeListing"},{"inlineContent":[{"type":"text","text":"The default scopes configured for the API will be granted if you don’t request any specific scopes. If you"},{"type":"text","text":" "},{"type":"text","text":"request different scopes than the ones that were granted last time, the API credentials will be renewed"},{"type":"text","text":" "},{"type":"text","text":"immediately, regardless of whether they are expired or not."}],"type":"paragraph"},{"syntax":"swift","code":["credentialsManager"," .apiCredentials(forAudience: \"http:\/\/example.com\/api\","," scopes: \"read:todos update:todos\")"," .sink(receiveCompletion: { print($0) },"," receiveValue: { print($0) })"," .store(in: &cancellables)"],"type":"codeListing"},{"inlineContent":[{"type":"text","text":"To avoid retrieving access tokens with too little time left, enforce a minimum TTL (in seconds):"}],"type":"paragraph"},{"syntax":"swift","code":["credentialsManager"," .apiCredentials(forAudience: \"http:\/\/example.com\/api\","," minTTL: 60)"," .sink(receiveCompletion: { print($0) },"," receiveValue: { print($0) })"," .store(in: &cancellables)"],"type":"codeListing"},{"inlineContent":[{"text":"You can specify custom parameters or headers for the exchange request:","type":"text"}],"type":"paragraph"},{"syntax":"swift","code":["credentialsManager"," .apiCredentials(forAudience: \"http:\/\/example.com\/api\","," parameters: [\"key\": \"value\"],"," headers: [\"key\": \"value\"])"," .sink(receiveCompletion: { print($0) },"," receiveValue: { print($0) })"," .store(in: &cancellables)"],"type":"codeListing"},{"style":"note","content":[{"inlineContent":[{"type":"text","text":"The scope "},{"type":"codeVoice","code":"offline_access"},{"type":"text","text":" to have been requested on login to get a refresh token from Auth0. If"},{"type":"text","text":" "},{"type":"text","text":"the API credentials are expired and there is no refresh token, the callback will be called with a"},{"type":"text","text":" "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken","isActive":true},{"type":"text","text":" error."}],"type":"paragraph"}],"name":"Requires","type":"aside"},{"style":"important","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"To ensure that no concurrent exchange 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"}],"kind":"content"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/apiCredentials(forAudience:scope:minTTL:parameters:headers:)-18htb","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Retrieves API credentials from the Keychain and automatically renews them using the refresh token if the access"},{"type":"text","text":" "},{"type":"text","text":"token is expired. Otherwise, the subscription will complete with the retrieved API credentials as they are"},{"type":"text","text":" "},{"type":"text","text":"still valid."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanager\/apicredentials(foraudience:scope:minttl:parameters:headers:)-18htb"]}],"schemaVersion":{"minor":3,"major":0,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/apiCredentials(forAudience:scope:minTTL:parameters:headers:)-18htb":{"title":"apiCredentials(forAudience:scope:minTTL:parameters:headers:)","kind":"symbol","type":"topic","abstract":[{"type":"text","text":"Retrieves API credentials from the Keychain and automatically renews them using the refresh token if the access"},{"type":"text","text":" "},{"type":"text","text":"token is expired. Otherwise, the subscription will complete with the retrieved API credentials as they are"},{"type":"text","text":" "},{"type":"text","text":"still valid."}],"url":"\/documentation\/auth0\/credentialsmanager\/apicredentials(foraudience:scope:minttl:parameters:headers:)-18htb","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/apiCredentials(forAudience:scope:minTTL:parameters:headers:)-18htb","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"apiCredentials","kind":"identifier"},{"text":"(","kind":"text"},{"text":"forAudience","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"minTTL","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"parameters","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"], ","kind":"text"},{"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"},{"preciseIdentifier":"s:7Combine12AnyPublisherV","text":"AnyPublisher","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth014APICredentialsV","text":"APICredentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","kind":"typeIdentifier"},{"text":">","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManager","kind":"identifier"}],"navigatorTitle":[{"text":"CredentialsManager","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","abstract":[{"type":"text","text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain."}],"kind":"symbol","title":"CredentialsManager","url":"\/documentation\/auth0\/credentialsmanager","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"title":"cause","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","kind":"symbol","abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":"?"}],"role":"symbol","type":"topic"},"https://auth0.com/docs/api/authentication/refresh-token/refresh-token":{"type":"link","title":"Authentication API Endpoint","url":"https:\/\/auth0.com\/docs\/api\/authentication\/refresh-token\/refresh-token","identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/refresh-token\/refresh-token","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}]},"https://auth0.com/docs/get-started/apis/scopes":{"title":"Scopes","titleInlineContent":[{"type":"text","text":"Scopes"}],"url":"https:\/\/auth0.com\/docs\/get-started\/apis\/scopes","type":"link","identifier":"https:\/\/auth0.com\/docs\/get-started\/apis\/scopes"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"url":"\/documentation\/auth0\/credentials","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"role":"symbol","type":"topic","abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/noRefreshToken":{"url":"\/documentation\/auth0\/credentialsmanagererror\/norefreshtoken","abstract":[{"type":"text","text":"The stored "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","isActive":true},{"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":"."}],"fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"noRefreshToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"}],"kind":"symbol","type":"topic","title":"noRefreshToken","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"url":"\/documentation\/auth0\/credentialsmanagererror","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}],"title":"CredentialsManagerError","kind":"symbol","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/APICredentials":{"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0 for a specific API as the result of exchanging a refresh token."}],"title":"APICredentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials","role":"symbol","navigatorTitle":[{"text":"APICredentials","kind":"identifier"}],"url":"\/documentation\/auth0\/apicredentials","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"APICredentials","kind":"identifier"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/RefreshTokens":{"url":"\/documentation\/auth0\/refreshtokens","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens","kind":"article","title":"Refresh Tokens: Common Errors","type":"topic","abstract":[],"role":"article"},"https://auth0.com/docs/secure/tokens/refresh-tokens":{"type":"link","title":"Refresh Tokens","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","titleInlineContent":[{"type":"text","text":"Refresh Tokens"}]}}} \ No newline at end of file +{"sections":[],"variants":[{"paths":["\/documentation\/auth0\/credentialsmanager\/apicredentials(foraudience:scope:minttl:parameters:headers:)-18htb"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/get-started\/apis\/scopes","https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","https:\/\/auth0.com\/docs\/api\/authentication\/refresh-token\/refresh-token","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens"],"anchor":"Related-Documentation"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"abstract":[{"type":"text","text":"Retrieves API credentials from the Keychain and automatically renews them using the refresh token if the access"},{"text":" ","type":"text"},{"text":"token is expired. Otherwise, the subscription will complete with the retrieved API credentials as they are","type":"text"},{"text":" ","type":"text"},{"text":"still valid.","type":"text"}],"metadata":{"roleHeading":"Instance Method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"apiCredentials","kind":"identifier"},{"text":"(","kind":"text"},{"text":"forAudience","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"scope","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"minTTL"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"kind":"text","text":", "},{"kind":"externalParam","text":"parameters"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"]) -> "},{"kind":"typeIdentifier","text":"AnyPublisher","preciseIdentifier":"s:7Combine12AnyPublisherV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"APICredentials","preciseIdentifier":"s:5Auth014APICredentialsV"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"},{"kind":"text","text":">"}],"modules":[{"name":"Auth0"}],"role":"symbol","title":"apiCredentials(forAudience:scope:minTTL:parameters:headers:)","externalID":"s:5Auth018CredentialsManagerV03apiB011forAudience5scope6minTTL10parameters7headers7Combine12AnyPublisherVyAA14APICredentialsVAA0bC5ErrorVGSS_SSSgSiSDySSypGSDyS2SGtF","extendedModule":"Auth0","symbolKind":"method"},"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"apiCredentials"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"forAudience"},{"kind":"text","text":" "},{"text":"audience","kind":"internalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"scope","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"? = nil, ","kind":"text"},{"text":"minTTL","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"text":" = 0, ","kind":"text"},{"text":"parameters","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"] = [:], ","kind":"text"},{"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"},{"preciseIdentifier":"s:7Combine12AnyPublisherV","text":"AnyPublisher","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth014APICredentialsV","text":"APICredentials","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"},{"kind":"text","text":">"}]}]},{"parameters":[{"name":"audience","content":[{"inlineContent":[{"type":"text","text":"Identifier of the API that your application is requesting access to."}],"type":"paragraph"}]},{"name":"scope","content":[{"inlineContent":[{"type":"text","text":"Space-separated list of scope values to request when exchanging a refresh token for API credentials. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":", which will ask for the default scopes configured for the API."}],"type":"paragraph"}]},{"name":"minTTL","content":[{"inlineContent":[{"type":"text","text":"Minimum time in seconds the access token must remain valid to avoid being renewed. Defaults to "},{"type":"codeVoice","code":"0"},{"type":"text","text":"."}],"type":"paragraph"}]},{"name":"parameters","content":[{"inlineContent":[{"type":"text","text":"Additional parameters to use when exchanging a refresh token for API credentials."}],"type":"paragraph"}]},{"name":"headers","content":[{"inlineContent":[{"type":"text","text":"Additional headers to use when exchanging a refresh token for API credentials."}],"type":"paragraph"}]}],"kind":"parameters"},{"content":[{"type":"heading","anchor":"discussion","level":2,"text":"Discussion"},{"type":"paragraph","inlineContent":[{"text":"If there are no stored API credentials, the refresh token will be exchaged for a new set of API credentials.","type":"text"},{"text":" ","type":"text"},{"text":"New or renewed API credentials will be automatically stored in the Keychain. ","type":"text"},{"inlineContent":[{"type":"text","text":"This method is thread-safe"}],"type":"strong"},{"text":".","type":"text"}]},{"type":"heading","anchor":"Usage","level":2,"text":"Usage"},{"type":"codeListing","syntax":"swift","code":["credentialsManager"," .apiCredentials(forAudience: \"http:\/\/example.com\/api\")"," .sink(receiveCompletion: { completion in"," if case .failure(let error) = completion {"," print(\"Failed with: \\(error)\")"," }"," }, receiveValue: { apiCredentials in"," print(\"Obtained API credentials: \\(apiCredentials)\")"," })"," .store(in: &cancellables)"]},{"type":"paragraph","inlineContent":[{"text":"The default scopes configured for the API will be granted if you don’t request any specific scopes. If you","type":"text"},{"text":" ","type":"text"},{"text":"request different scopes than the ones that were granted last time, the API credentials will be renewed","type":"text"},{"text":" ","type":"text"},{"text":"immediately, regardless of whether they are expired or not.","type":"text"}]},{"type":"codeListing","syntax":"swift","code":["credentialsManager"," .apiCredentials(forAudience: \"http:\/\/example.com\/api\","," scopes: \"read:todos update:todos\")"," .sink(receiveCompletion: { print($0) },"," receiveValue: { print($0) })"," .store(in: &cancellables)"]},{"type":"paragraph","inlineContent":[{"text":"To avoid retrieving access tokens with too little time left, enforce a minimum TTL (in seconds):","type":"text"}]},{"type":"codeListing","syntax":"swift","code":["credentialsManager"," .apiCredentials(forAudience: \"http:\/\/example.com\/api\","," minTTL: 60)"," .sink(receiveCompletion: { print($0) },"," receiveValue: { print($0) })"," .store(in: &cancellables)"]},{"type":"paragraph","inlineContent":[{"text":"You can specify custom parameters or headers for the exchange request:","type":"text"}]},{"type":"codeListing","syntax":"swift","code":["credentialsManager"," .apiCredentials(forAudience: \"http:\/\/example.com\/api\","," parameters: [\"key\": \"value\"],"," headers: [\"key\": \"value\"])"," .sink(receiveCompletion: { print($0) },"," receiveValue: { print($0) })"," .store(in: &cancellables)"]},{"type":"aside","name":"Requires","content":[{"inlineContent":[{"type":"text","text":"The scope "},{"type":"codeVoice","code":"offline_access"},{"type":"text","text":" to have been requested on login to get a refresh token from Auth0. If"},{"type":"text","text":" "},{"type":"text","text":"the API credentials are expired and there is no refresh token, the callback will be called with a"},{"type":"text","text":" "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken","isActive":true},{"type":"text","text":" error."}],"type":"paragraph"}],"style":"note"},{"type":"aside","content":[{"inlineContent":[{"type":"text","text":"To ensure that no concurrent exchange 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","style":"important"}],"kind":"content"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/apiCredentials(forAudience:scope:minTTL:parameters:headers:)-18htb"},"references":{"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","titleInlineContent":[{"type":"text","text":"Refresh Tokens"}],"type":"link","title":"Refresh Tokens"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"title":"CredentialsManager","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManager"}],"abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanager","navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}]},"https://auth0.com/docs/api/authentication/refresh-token/refresh-token":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/refresh-token\/refresh-token","url":"https:\/\/auth0.com\/docs\/api\/authentication\/refresh-token\/refresh-token","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"type":"link","title":"Authentication API Endpoint"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"Credentials","kind":"identifier"}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/noRefreshToken":{"title":"noRefreshToken","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"noRefreshToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"}],"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":" "},{"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"}],"url":"\/documentation\/auth0\/credentialsmanagererror\/norefreshtoken"},"doc://com.auth0.Auth0/documentation/Auth0/RefreshTokens":{"title":"Refresh Tokens: Common Errors","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens","role":"article","kind":"article","abstract":[],"url":"\/documentation\/auth0\/refreshtokens"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/apiCredentials(forAudience:scope:minTTL:parameters:headers:)-18htb":{"kind":"symbol","abstract":[{"type":"text","text":"Retrieves API credentials from the Keychain and automatically renews them using the refresh token if the access"},{"type":"text","text":" "},{"type":"text","text":"token is expired. Otherwise, the subscription will complete with the retrieved API credentials as they are"},{"type":"text","text":" "},{"type":"text","text":"still valid."}],"type":"topic","url":"\/documentation\/auth0\/credentialsmanager\/apicredentials(foraudience:scope:minttl:parameters:headers:)-18htb","title":"apiCredentials(forAudience:scope:minTTL:parameters:headers:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"apiCredentials","kind":"identifier"},{"text":"(","kind":"text"},{"text":"forAudience","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"minTTL"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"},{"kind":"text","text":", "},{"kind":"externalParam","text":"parameters"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"]) -> "},{"kind":"typeIdentifier","text":"AnyPublisher","preciseIdentifier":"s:7Combine12AnyPublisherV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth014APICredentialsV","text":"APICredentials"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/apiCredentials(forAudience:scope:minTTL:parameters:headers:)-18htb"},"doc://com.auth0.Auth0/documentation/Auth0/APICredentials":{"role":"symbol","title":"APICredentials","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"APICredentials"}],"navigatorTitle":[{"kind":"identifier","text":"APICredentials"}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0 for a specific API as the result of exchanging a refresh token."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials","url":"\/documentation\/auth0\/apicredentials","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"kind":"symbol","title":"cause","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier","text":"Error"},{"kind":"text","text":"?"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","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":"."}],"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"role":"symbol","title":"CredentialsManagerError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerError"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}],"abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","url":"\/documentation\/auth0\/credentialsmanagererror","type":"topic"},"https://auth0.com/docs/get-started/apis/scopes":{"identifier":"https:\/\/auth0.com\/docs\/get-started\/apis\/scopes","url":"https:\/\/auth0.com\/docs\/get-started\/apis\/scopes","titleInlineContent":[{"type":"text","text":"Scopes"}],"type":"link","title":"Scopes"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentialsmanager/apicredentials(foraudience:scope:minttl:parameters:headers:)-8lezm.json b/docs/data/documentation/auth0/credentialsmanager/apicredentials(foraudience:scope:minttl:parameters:headers:)-8lezm.json index b6fb5b5b8..ba93afd31 100644 --- a/docs/data/documentation/auth0/credentialsmanager/apicredentials(foraudience:scope:minttl:parameters:headers:)-8lezm.json +++ b/docs/data/documentation/auth0/credentialsmanager/apicredentials(foraudience:scope:minttl:parameters:headers:)-8lezm.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"abstract":[{"type":"text","text":"Retrieves API credentials from the Keychain and automatically renews them using the refresh token if the access"},{"type":"text","text":" "},{"type":"text","text":"token is expired. Otherwise, it returns the retrieved API credentials as they are still valid."}],"sections":[],"metadata":{"roleHeading":"Instance Method","title":"apiCredentials(forAudience:scope:minTTL:parameters:headers:)","symbolKind":"method","role":"symbol","modules":[{"name":"Auth0"}],"externalID":"s:5Auth018CredentialsManagerV03apiB011forAudience5scope6minTTL10parameters7headersAA14APICredentialsVSS_SSSgSiSDySSypGSDyS2SGtYaKF","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"apiCredentials"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forAudience"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"minTTL"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"},{"kind":"text","text":", "},{"kind":"externalParam","text":"parameters"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" : "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"preciseIdentifier":"s:5Auth014APICredentialsV","kind":"typeIdentifier","text":"APICredentials"}],"extendedModule":"Auth0"},"schemaVersion":{"patch":0,"major":0,"minor":3},"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/apiCredentials(forAudience:scope:minTTL:parameters:headers:)-8lezm"},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"apiCredentials","kind":"identifier"},{"text":"(","kind":"text"},{"text":"forAudience","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"audience","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"? = nil, ","kind":"text"},{"text":"minTTL","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"text":" = 0, ","kind":"text"},{"text":"parameters","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","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"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"] = [:]) ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"APICredentials","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials","preciseIdentifier":"s:5Auth014APICredentialsV"}],"languages":["swift"],"platforms":["iOS"]}]},{"kind":"parameters","parameters":[{"name":"audience","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Identifier of the API that your application is requesting access to."}]}]},{"name":"scope","content":[{"type":"paragraph","inlineContent":[{"text":"Space-separated list of scope values to request when exchanging a refresh token for API credentials. Defaults to ","type":"text"},{"type":"codeVoice","code":"nil"},{"text":", which will ask for the default scopes configured for the API.","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"},{"type":"text","text":"."}]}]},{"name":"parameters","content":[{"type":"paragraph","inlineContent":[{"text":"Additional parameters to use when exchanging a refresh token for API credentials.","type":"text"}]}]},{"name":"headers","content":[{"type":"paragraph","inlineContent":[{"text":"Additional headers to use when exchanging a refresh token for API credentials.","type":"text"}]}]}]},{"kind":"content","content":[{"anchor":"discussion","text":"Discussion","type":"heading","level":2},{"type":"paragraph","inlineContent":[{"type":"text","text":"If there are no stored API credentials, the refresh token will be exchaged for a new set of API credentials."},{"type":"text","text":" "},{"type":"text","text":"New or renewed API credentials will be automatically stored in the Keychain. "},{"inlineContent":[{"type":"text","text":"This method is thread-safe"}],"type":"strong"},{"type":"text","text":"."}]},{"anchor":"Usage","text":"Usage","type":"heading","level":2},{"syntax":"swift","type":"codeListing","code":["do {"," let apiCredentials = try await credentialsManager.apiCredentials(forAudience: \"http:\/\/example.com\/api\")"," print(\"Obtained API credentials: \\(apiCredentials)\")","} catch {"," print(\"Failed with: \\(error)\")","}"]},{"type":"paragraph","inlineContent":[{"type":"text","text":"The default scopes configured for the API will be granted if you don’t request any specific scopes. If you"},{"type":"text","text":" "},{"type":"text","text":"request different scopes than the ones that were granted last time, the API credentials will be renewed"},{"type":"text","text":" "},{"type":"text","text":"immediately, regardless of whether they are expired or not."}]},{"syntax":"swift","type":"codeListing","code":["let apiCredentials = try await credentialsManager.apiCredentials(forAudience: \"http:\/\/example.com\/api\","," scope: \"read:todos update:todos\")"]},{"type":"paragraph","inlineContent":[{"text":"To avoid retrieving access tokens with too little time left, enforce a minimum TTL (in seconds):","type":"text"}]},{"syntax":"swift","type":"codeListing","code":["let apiCredentials = try await credentialsManager.apiCredentials(forAudience: \"http:\/\/example.com\/api\","," minTTL: 60)"]},{"type":"paragraph","inlineContent":[{"text":"You can specify custom parameters or headers for the exchange request:","type":"text"}]},{"syntax":"swift","type":"codeListing","code":["let apiCredentials = try await credentialsManager.apiCredentials(forAudience: \"http:\/\/example.com\/api\","," parameters: [\"key\": \"value\"],"," headers: [\"key\": \"value\"])"]},{"name":"Requires","type":"aside","style":"note","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The scope "},{"type":"codeVoice","code":"offline_access"},{"type":"text","text":" to have been requested on login to get a refresh token from Auth0. If"},{"type":"text","text":" "},{"type":"text","text":"the API credentials are expired and there is no refresh token, the callback will be called with a"},{"type":"text","text":" "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken"},{"type":"text","text":" error."}]}]},{"name":"Important","type":"aside","style":"important","content":[{"inlineContent":[{"type":"text","text":"To ensure that no concurrent exchange 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"}]}]}],"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/get-started\/apis\/scopes","https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","https:\/\/auth0.com\/docs\/api\/authentication\/refresh-token\/refresh-token","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens"],"title":"Related Documentation","anchor":"Related-Documentation"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanager\/apicredentials(foraudience:scope:minttl:parameters:headers:)-8lezm"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/apiCredentials(forAudience:scope:minTTL:parameters:headers:)-8lezm":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/apiCredentials(forAudience:scope:minTTL:parameters:headers:)-8lezm","role":"symbol","kind":"symbol","title":"apiCredentials(forAudience:scope:minTTL:parameters:headers:)","abstract":[{"text":"Retrieves API credentials from the Keychain and automatically renews them using the refresh token if the access","type":"text"},{"text":" ","type":"text"},{"text":"token is expired. Otherwise, it returns the retrieved API credentials as they are still valid.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanager\/apicredentials(foraudience:scope:minttl:parameters:headers:)-8lezm","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"apiCredentials","kind":"identifier"},{"text":"(","kind":"text"},{"text":"forAudience","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"text":"minTTL","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"text":", ","kind":"text"},{"text":"parameters","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","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"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"]) ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"APICredentials","kind":"typeIdentifier","preciseIdentifier":"s:5Auth014APICredentialsV"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"url":"\/documentation\/auth0\/credentials","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"role":"symbol","type":"topic","abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/APICredentials":{"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0 for a specific API as the result of exchanging a refresh token."}],"title":"APICredentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials","role":"symbol","navigatorTitle":[{"text":"APICredentials","kind":"identifier"}],"url":"\/documentation\/auth0\/apicredentials","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"APICredentials","kind":"identifier"}],"type":"topic"},"https://auth0.com/docs/api/authentication/refresh-token/refresh-token":{"type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/refresh-token\/refresh-token","title":"Authentication API Endpoint","url":"https:\/\/auth0.com\/docs\/api\/authentication\/refresh-token\/refresh-token","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}]},"doc://com.auth0.Auth0/documentation/Auth0/RefreshTokens":{"url":"\/documentation\/auth0\/refreshtokens","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens","kind":"article","title":"Refresh Tokens: Common Errors","type":"topic","abstract":[],"role":"article"},"https://auth0.com/docs/secure/tokens/refresh-tokens":{"type":"link","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","title":"Refresh Tokens","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","titleInlineContent":[{"type":"text","text":"Refresh Tokens"}]},"https://auth0.com/docs/get-started/apis/scopes":{"type":"link","identifier":"https:\/\/auth0.com\/docs\/get-started\/apis\/scopes","title":"Scopes","url":"https:\/\/auth0.com\/docs\/get-started\/apis\/scopes","titleInlineContent":[{"type":"text","text":"Scopes"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManager","kind":"identifier"}],"navigatorTitle":[{"text":"CredentialsManager","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","abstract":[{"type":"text","text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain."}],"kind":"symbol","title":"CredentialsManager","url":"\/documentation\/auth0\/credentialsmanager","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"title":"cause","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","kind":"symbol","abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":"?"}],"role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/noRefreshToken":{"url":"\/documentation\/auth0\/credentialsmanagererror\/norefreshtoken","abstract":[{"type":"text","text":"The stored "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","isActive":true},{"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":"."}],"fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"noRefreshToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"}],"kind":"symbol","type":"topic","title":"noRefreshToken","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken"}}} \ No newline at end of file +{"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/apiCredentials(forAudience:scope:minTTL:parameters:headers:)-8lezm","interfaceLanguage":"swift"},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"apiCredentials"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forAudience"},{"kind":"text","text":" "},{"kind":"internalParam","text":"audience"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"? = nil, "},{"kind":"externalParam","text":"minTTL"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"kind":"text","text":" = 0, "},{"kind":"externalParam","text":"parameters"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"] = [:], "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"] = [:]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials","kind":"typeIdentifier","text":"APICredentials","preciseIdentifier":"s:5Auth014APICredentialsV"}]}],"kind":"declarations"},{"parameters":[{"content":[{"inlineContent":[{"text":"Identifier of the API that your application is requesting access to.","type":"text"}],"type":"paragraph"}],"name":"audience"},{"content":[{"inlineContent":[{"text":"Space-separated list of scope values to request when exchanging a refresh token for API credentials. Defaults to ","type":"text"},{"code":"nil","type":"codeVoice"},{"text":", which will ask for the default scopes configured for the API.","type":"text"}],"type":"paragraph"}],"name":"scope"},{"content":[{"inlineContent":[{"type":"text","text":"Minimum time in seconds the access token must remain valid to avoid being renewed. Defaults to "},{"type":"codeVoice","code":"0"},{"type":"text","text":"."}],"type":"paragraph"}],"name":"minTTL"},{"name":"parameters","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Additional parameters to use when exchanging a refresh token for API credentials."}]}]},{"name":"headers","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Additional headers to use when exchanging a refresh token for API credentials."}]}]}],"kind":"parameters"},{"content":[{"level":2,"text":"Discussion","type":"heading","anchor":"discussion"},{"inlineContent":[{"type":"text","text":"If there are no stored API credentials, the refresh token will be exchaged for a new set of API credentials."},{"type":"text","text":" "},{"type":"text","text":"New or renewed API credentials will be automatically stored in the Keychain. "},{"type":"strong","inlineContent":[{"type":"text","text":"This method is thread-safe"}]},{"type":"text","text":"."}],"type":"paragraph"},{"level":2,"text":"Usage","type":"heading","anchor":"Usage"},{"code":["do {"," let apiCredentials = try await credentialsManager.apiCredentials(forAudience: \"http:\/\/example.com\/api\")"," print(\"Obtained API credentials: \\(apiCredentials)\")","} catch {"," print(\"Failed with: \\(error)\")","}"],"syntax":"swift","type":"codeListing"},{"inlineContent":[{"type":"text","text":"The default scopes configured for the API will be granted if you don’t request any specific scopes. If you"},{"type":"text","text":" "},{"type":"text","text":"request different scopes than the ones that were granted last time, the API credentials will be renewed"},{"type":"text","text":" "},{"type":"text","text":"immediately, regardless of whether they are expired or not."}],"type":"paragraph"},{"code":["let apiCredentials = try await credentialsManager.apiCredentials(forAudience: \"http:\/\/example.com\/api\","," scope: \"read:todos update:todos\")"],"syntax":"swift","type":"codeListing"},{"type":"paragraph","inlineContent":[{"type":"text","text":"To avoid retrieving access tokens with too little time left, enforce a minimum TTL (in seconds):"}]},{"type":"codeListing","syntax":"swift","code":["let apiCredentials = try await credentialsManager.apiCredentials(forAudience: \"http:\/\/example.com\/api\","," minTTL: 60)"]},{"type":"paragraph","inlineContent":[{"text":"You can specify custom parameters or headers for the exchange request:","type":"text"}]},{"type":"codeListing","syntax":"swift","code":["let apiCredentials = try await credentialsManager.apiCredentials(forAudience: \"http:\/\/example.com\/api\","," parameters: [\"key\": \"value\"],"," headers: [\"key\": \"value\"])"]},{"type":"aside","style":"note","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The scope "},{"type":"codeVoice","code":"offline_access"},{"type":"text","text":" to have been requested on login to get a refresh token from Auth0. If"},{"type":"text","text":" "},{"type":"text","text":"the API credentials are expired and there is no refresh token, the callback will be called with a"},{"type":"text","text":" "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken","isActive":true},{"type":"text","text":" error."}]}],"name":"Requires"},{"type":"aside","style":"important","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"To ensure that no concurrent exchange 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"}],"kind":"content"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanager\/apicredentials(foraudience:scope:minttl:parameters:headers:)-8lezm"]}],"kind":"symbol","metadata":{"modules":[{"name":"Auth0"}],"title":"apiCredentials(forAudience:scope:minTTL:parameters:headers:)","externalID":"s:5Auth018CredentialsManagerV03apiB011forAudience5scope6minTTL10parameters7headersAA14APICredentialsVSS_SSSgSiSDySSypGSDyS2SGtYaKF","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"apiCredentials"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forAudience"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"minTTL"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"},{"kind":"text","text":", "},{"kind":"externalParam","text":"parameters"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth014APICredentialsV","text":"APICredentials"}],"roleHeading":"Instance Method","extendedModule":"Auth0","symbolKind":"method"},"schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"type":"text","text":"Retrieves API credentials from the Keychain and automatically renews them using the refresh token if the access"},{"type":"text","text":" "},{"type":"text","text":"token is expired. Otherwise, it returns the retrieved API credentials as they are still valid."}],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/get-started\/apis\/scopes","https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","https:\/\/auth0.com\/docs\/api\/authentication\/refresh-token\/refresh-token","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens"],"anchor":"Related-Documentation"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"kind":"symbol","title":"cause","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier","text":"Error"},{"kind":"text","text":"?"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","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":"."}],"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0/RefreshTokens":{"title":"Refresh Tokens: Common Errors","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens","role":"article","kind":"article","abstract":[],"url":"\/documentation\/auth0\/refreshtokens"},"https://auth0.com/docs/secure/tokens/refresh-tokens":{"title":"Refresh Tokens","type":"link","titleInlineContent":[{"type":"text","text":"Refresh Tokens"}],"identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens"},"https://auth0.com/docs/api/authentication/refresh-token/refresh-token":{"title":"Authentication API Endpoint","type":"link","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/refresh-token\/refresh-token","url":"https:\/\/auth0.com\/docs\/api\/authentication\/refresh-token\/refresh-token"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"Credentials","kind":"identifier"}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}]},"https://auth0.com/docs/get-started/apis/scopes":{"title":"Scopes","type":"link","titleInlineContent":[{"type":"text","text":"Scopes"}],"identifier":"https:\/\/auth0.com\/docs\/get-started\/apis\/scopes","url":"https:\/\/auth0.com\/docs\/get-started\/apis\/scopes"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/apiCredentials(forAudience:scope:minTTL:parameters:headers:)-8lezm":{"title":"apiCredentials(forAudience:scope:minTTL:parameters:headers:)","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/apiCredentials(forAudience:scope:minTTL:parameters:headers:)-8lezm","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"apiCredentials"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forAudience"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"minTTL"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"},{"kind":"text","text":", "},{"kind":"externalParam","text":"parameters"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth014APICredentialsV","text":"APICredentials"}],"abstract":[{"type":"text","text":"Retrieves API credentials from the Keychain and automatically renews them using the refresh token if the access"},{"type":"text","text":" "},{"type":"text","text":"token is expired. Otherwise, it returns the retrieved API credentials as they are still valid."}],"url":"\/documentation\/auth0\/credentialsmanager\/apicredentials(foraudience:scope:minttl:parameters:headers:)-8lezm"},"doc://com.auth0.Auth0/documentation/Auth0/APICredentials":{"role":"symbol","title":"APICredentials","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"APICredentials"}],"navigatorTitle":[{"kind":"identifier","text":"APICredentials"}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0 for a specific API as the result of exchanging a refresh token."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials","url":"\/documentation\/auth0\/apicredentials","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"title":"CredentialsManager","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManager"}],"abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanager","navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/noRefreshToken":{"title":"noRefreshToken","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"noRefreshToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"}],"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":" "},{"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"}],"url":"\/documentation\/auth0\/credentialsmanagererror\/norefreshtoken"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentialsmanager/apicredentials(foraudience:scope:minttl:parameters:headers:callback:).json b/docs/data/documentation/auth0/credentialsmanager/apicredentials(foraudience:scope:minttl:parameters:headers:callback:).json index b9e16a4ac..591747a9a 100644 --- a/docs/data/documentation/auth0/credentialsmanager/apicredentials(foraudience:scope:minttl:parameters:headers:callback:).json +++ b/docs/data/documentation/auth0/credentialsmanager/apicredentials(foraudience:scope:minttl:parameters:headers:callback:).json @@ -1 +1 @@ -{"kind":"symbol","seeAlsoSections":[{"anchor":"Related-Documentation","title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/get-started\/apis\/scopes","https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","https:\/\/auth0.com\/docs\/api\/authentication\/refresh-token\/refresh-token","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"apiCredentials","kind":"identifier"},{"text":"(","kind":"text"},{"text":"forAudience","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"audience","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"? = nil, ","kind":"text"},{"text":"minTTL","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"text":" = 0, ","kind":"text"},{"text":"parameters","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"] = [:], "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"] = [:], "},{"kind":"externalParam","text":"callback"},{"kind":"text","text":": "},{"kind":"attribute","text":"@escaping"},{"kind":"text","text":" ("},{"kind":"typeIdentifier","text":"CredentialsManagerResult","preciseIdentifier":"s:5Auth024CredentialsManagerResulta","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerResult"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"APICredentials","preciseIdentifier":"s:5Auth014APICredentialsV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials"},{"kind":"text","text":">) -> "},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":")"}],"platforms":["iOS"]}]},{"kind":"parameters","parameters":[{"name":"audience","content":[{"inlineContent":[{"type":"text","text":"Identifier of the API that your application is requesting access to."}],"type":"paragraph"}]},{"name":"scope","content":[{"inlineContent":[{"type":"text","text":"Space-separated list of scope values to request when exchanging a refresh token for API credentials. Defaults to "},{"type":"codeVoice","code":"nil"},{"text":", which will ask for the default scopes configured for the API.","type":"text"}],"type":"paragraph"}]},{"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"},{"type":"text","text":"."}]}]},{"name":"parameters","content":[{"type":"paragraph","inlineContent":[{"text":"Additional parameters to use when exchanging a refresh token for API credentials.","type":"text"}]}]},{"name":"headers","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Additional headers to use when exchanging a refresh token for API credentials."}]}]},{"name":"callback","content":[{"inlineContent":[{"text":"Callback that receives a ","type":"text"},{"code":"Result","type":"codeVoice"},{"text":" containing either the API credentials or an error.","type":"text"}],"type":"paragraph"}]}]},{"kind":"content","content":[{"anchor":"discussion","type":"heading","text":"Discussion","level":2},{"inlineContent":[{"text":"If there are no stored API credentials, the refresh token will be exchaged for a new set of API credentials.","type":"text"},{"text":" ","type":"text"},{"text":"New or renewed API credentials will be automatically stored in the Keychain. ","type":"text"},{"inlineContent":[{"type":"text","text":"This method is thread-safe"}],"type":"strong"},{"text":".","type":"text"}],"type":"paragraph"},{"anchor":"Usage","type":"heading","text":"Usage","level":2},{"syntax":"swift","type":"codeListing","code":["credentialsManager.apiCredentials(forAudience: \"http:\/\/example.com\/api\") { result in"," switch result {"," case .success(let apiCredentials):"," print(\"Obtained API credentials: \\(apiCredentials)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }","}"]},{"inlineContent":[{"text":"The default scopes configured for the API will be granted if you don’t request any specific scopes. If you","type":"text"},{"text":" ","type":"text"},{"text":"request different scopes than the ones that were granted last time, the API credentials will be renewed","type":"text"},{"text":" ","type":"text"},{"text":"immediately, regardless of whether they are expired or not.","type":"text"}],"type":"paragraph"},{"syntax":"swift","type":"codeListing","code":["credentialsManager.apiCredentials(forAudience: \"http:\/\/example.com\/api\","," scope: \"read:todos update:todos\") { print($0) }"]},{"inlineContent":[{"type":"text","text":"To avoid retrieving access tokens with too little time left, enforce a minimum TTL (in seconds):"}],"type":"paragraph"},{"syntax":"swift","type":"codeListing","code":["credentialsManager.apiCredentials(forAudience: \"http:\/\/example.com\/api\","," minTTL: 60) { print($0) }"]},{"inlineContent":[{"text":"You can specify custom parameters or headers for the exchange request:","type":"text"}],"type":"paragraph"},{"syntax":"swift","type":"codeListing","code":["credentialsManager.apiCredentials(forAudience: \"http:\/\/example.com\/api\","," parameters: [\"key\": \"value\"],"," headers: [\"key\": \"value\"]) { print($0) }"]},{"type":"aside","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"},{"text":" ","type":"text"},{"text":"the API credentials are expired and there is no refresh token, the callback will be called with a","type":"text"},{"text":" ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken","isActive":true,"type":"reference"},{"text":" error.","type":"text"}],"type":"paragraph"}],"name":"Requires","style":"note"},{"type":"aside","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"To ensure that no concurrent exchange 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","style":"important"}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanager\/apicredentials(foraudience:scope:minttl:parameters:headers:callback:)"]}],"abstract":[{"type":"text","text":"Retrieves API credentials from the Keychain and automatically renews them using the refresh token if the access"},{"type":"text","text":" "},{"type":"text","text":"token is expired. Otherwise, the retrieved API credentials will be returned via the success case as they are"},{"type":"text","text":" "},{"type":"text","text":"still valid."}],"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/apiCredentials(forAudience:scope:minTTL:parameters:headers:callback:)","interfaceLanguage":"swift"},"schemaVersion":{"major":0,"patch":0,"minor":3},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"metadata":{"role":"symbol","roleHeading":"Instance Method","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"apiCredentials"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forAudience"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"minTTL"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"},{"kind":"text","text":", "},{"kind":"externalParam","text":"parameters"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" : "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"callback"},{"kind":"text","text":": ("},{"preciseIdentifier":"s:5Auth024CredentialsManagerResulta","kind":"typeIdentifier","text":"CredentialsManagerResult"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:5Auth014APICredentialsV","kind":"typeIdentifier","text":"APICredentials"},{"kind":"text","text":">) -> "},{"preciseIdentifier":"s:s4Voida","kind":"typeIdentifier","text":"Void"},{"kind":"text","text":")"}],"title":"apiCredentials(forAudience:scope:minTTL:parameters:headers:callback:)","symbolKind":"method","externalID":"s:5Auth018CredentialsManagerV03apiB011forAudience5scope6minTTL10parameters7headers8callbackySS_SSSgSiSDySSypGSDyS2SGys6ResultOyAA14APICredentialsVAA0bC5ErrorVGctF"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"title":"cause","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","kind":"symbol","abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":"?"}],"role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/apiCredentials(forAudience:scope:minTTL:parameters:headers:callback:)":{"url":"\/documentation\/auth0\/credentialsmanager\/apicredentials(foraudience:scope:minttl:parameters:headers:callback:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"apiCredentials","kind":"identifier"},{"text":"(","kind":"text"},{"text":"forAudience","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"text":"minTTL","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"text":", ","kind":"text"},{"text":"parameters","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","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"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"], ","kind":"text"},{"text":"callback","kind":"externalParam"},{"text":": (","kind":"text"},{"text":"CredentialsManagerResult","kind":"typeIdentifier","preciseIdentifier":"s:5Auth024CredentialsManagerResulta"},{"text":"<","kind":"text"},{"text":"APICredentials","kind":"typeIdentifier","preciseIdentifier":"s:5Auth014APICredentialsV"},{"text":">) -> ","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":")","kind":"text"}],"type":"topic","title":"apiCredentials(forAudience:scope:minTTL:parameters:headers:callback:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/apiCredentials(forAudience:scope:minTTL:parameters:headers:callback:)","kind":"symbol","role":"symbol","abstract":[{"text":"Retrieves API credentials from the Keychain and automatically renews them using the refresh token if the access","type":"text"},{"text":" ","type":"text"},{"text":"token is expired. Otherwise, the retrieved API credentials will be returned via the success case as they are","type":"text"},{"text":" ","type":"text"},{"text":"still valid.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/RefreshTokens":{"url":"\/documentation\/auth0\/refreshtokens","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens","kind":"article","title":"Refresh Tokens: Common Errors","type":"topic","abstract":[],"role":"article"},"https://auth0.com/docs/secure/tokens/refresh-tokens":{"titleInlineContent":[{"type":"text","text":"Refresh Tokens"}],"type":"link","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","title":"Refresh Tokens","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerResult":{"type":"topic","abstract":[{"type":"codeVoice","code":"Result"},{"type":"text","text":" wrapper for Credentials Manager operations."}],"kind":"symbol","role":"symbol","navigatorTitle":[{"text":"CredentialsManagerResult","kind":"identifier"}],"title":"CredentialsManagerResult","url":"\/documentation\/auth0\/credentialsmanagerresult","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerResult","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerResult"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/noRefreshToken":{"url":"\/documentation\/auth0\/credentialsmanagererror\/norefreshtoken","abstract":[{"type":"text","text":"The stored "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","isActive":true},{"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":"."}],"fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"noRefreshToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"}],"kind":"symbol","type":"topic","title":"noRefreshToken","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"url":"\/documentation\/auth0\/credentials","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"role":"symbol","type":"topic","abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/APICredentials":{"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0 for a specific API as the result of exchanging a refresh token."}],"title":"APICredentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials","role":"symbol","navigatorTitle":[{"text":"APICredentials","kind":"identifier"}],"url":"\/documentation\/auth0\/apicredentials","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"APICredentials","kind":"identifier"}],"type":"topic"},"https://auth0.com/docs/api/authentication/refresh-token/refresh-token":{"titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/refresh-token\/refresh-token","title":"Authentication API Endpoint","url":"https:\/\/auth0.com\/docs\/api\/authentication\/refresh-token\/refresh-token"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManager","kind":"identifier"}],"navigatorTitle":[{"text":"CredentialsManager","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","abstract":[{"type":"text","text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain."}],"kind":"symbol","title":"CredentialsManager","url":"\/documentation\/auth0\/credentialsmanager","type":"topic"},"https://auth0.com/docs/get-started/apis/scopes":{"titleInlineContent":[{"type":"text","text":"Scopes"}],"type":"link","identifier":"https:\/\/auth0.com\/docs\/get-started\/apis\/scopes","title":"Scopes","url":"https:\/\/auth0.com\/docs\/get-started\/apis\/scopes"}}} \ No newline at end of file +{"metadata":{"symbolKind":"method","title":"apiCredentials(forAudience:scope:minTTL:parameters:headers:callback:)","externalID":"s:5Auth018CredentialsManagerV03apiB011forAudience5scope6minTTL10parameters7headers8callbackySS_SSSgSiSDySSypGSDyS2SGys6ResultOyAA14APICredentialsVAA0bC5ErrorVGctF","roleHeading":"Instance Method","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"apiCredentials"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forAudience"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"minTTL"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"kind":"text","text":", "},{"kind":"externalParam","text":"parameters"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"callback"},{"kind":"text","text":": ("},{"kind":"typeIdentifier","text":"CredentialsManagerResult","preciseIdentifier":"s:5Auth024CredentialsManagerResulta"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"APICredentials","preciseIdentifier":"s:5Auth014APICredentialsV"},{"kind":"text","text":">) -> "},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":")"}],"role":"symbol"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanager\/apicredentials(foraudience:scope:minttl:parameters:headers:callback:)"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/apiCredentials(forAudience:scope:minTTL:parameters:headers:callback:)"},"kind":"symbol","abstract":[{"text":"Retrieves API credentials from the Keychain and automatically renews them using the refresh token if the access","type":"text"},{"text":" ","type":"text"},{"text":"token is expired. Otherwise, the retrieved API credentials will be returned via the success case as they are","type":"text"},{"text":" ","type":"text"},{"text":"still valid.","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/get-started\/apis\/scopes","https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","https:\/\/auth0.com\/docs\/api\/authentication\/refresh-token\/refresh-token","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens"],"anchor":"Related-Documentation","title":"Related Documentation"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"apiCredentials"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forAudience"},{"kind":"text","text":" "},{"kind":"internalParam","text":"audience"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"? = nil, "},{"kind":"externalParam","text":"minTTL"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"kind":"text","text":" = 0, "},{"kind":"externalParam","text":"parameters"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"] = [:], "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"] = [:], "},{"kind":"externalParam","text":"callback"},{"kind":"text","text":": "},{"kind":"attribute","text":"@escaping"},{"kind":"text","text":" ("},{"kind":"typeIdentifier","text":"CredentialsManagerResult","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerResult","preciseIdentifier":"s:5Auth024CredentialsManagerResulta"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"APICredentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials","preciseIdentifier":"s:5Auth014APICredentialsV"},{"kind":"text","text":">) -> "},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":")"}],"languages":["swift"],"platforms":["iOS"]}]},{"parameters":[{"name":"audience","content":[{"inlineContent":[{"type":"text","text":"Identifier of the API that your application is requesting access to."}],"type":"paragraph"}]},{"name":"scope","content":[{"inlineContent":[{"type":"text","text":"Space-separated list of scope values to request when exchanging a refresh token for API credentials. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":", which will ask for the default scopes configured for the API."}],"type":"paragraph"}]},{"name":"minTTL","content":[{"inlineContent":[{"type":"text","text":"Minimum time in seconds the access token must remain valid to avoid being renewed. Defaults to "},{"type":"codeVoice","code":"0"},{"type":"text","text":"."}],"type":"paragraph"}]},{"name":"parameters","content":[{"inlineContent":[{"type":"text","text":"Additional parameters to use when exchanging a refresh token for API credentials."}],"type":"paragraph"}]},{"name":"headers","content":[{"inlineContent":[{"type":"text","text":"Additional headers to use when exchanging a refresh token for API credentials."}],"type":"paragraph"}]},{"name":"callback","content":[{"inlineContent":[{"type":"text","text":"Callback that receives a "},{"type":"codeVoice","code":"Result"},{"type":"text","text":" containing either the API credentials or an error."}],"type":"paragraph"}]}],"kind":"parameters"},{"kind":"content","content":[{"anchor":"discussion","text":"Discussion","type":"heading","level":2},{"inlineContent":[{"text":"If there are no stored API credentials, the refresh token will be exchaged for a new set of API credentials.","type":"text"},{"text":" ","type":"text"},{"text":"New or renewed API credentials will be automatically stored in the Keychain. ","type":"text"},{"inlineContent":[{"type":"text","text":"This method is thread-safe"}],"type":"strong"},{"text":".","type":"text"}],"type":"paragraph"},{"anchor":"Usage","text":"Usage","type":"heading","level":2},{"syntax":"swift","type":"codeListing","code":["credentialsManager.apiCredentials(forAudience: \"http:\/\/example.com\/api\") { result in"," switch result {"," case .success(let apiCredentials):"," print(\"Obtained API credentials: \\(apiCredentials)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }","}"]},{"inlineContent":[{"text":"The default scopes configured for the API will be granted if you don’t request any specific scopes. If you","type":"text"},{"text":" ","type":"text"},{"text":"request different scopes than the ones that were granted last time, the API credentials will be renewed","type":"text"},{"text":" ","type":"text"},{"text":"immediately, regardless of whether they are expired or not.","type":"text"}],"type":"paragraph"},{"syntax":"swift","type":"codeListing","code":["credentialsManager.apiCredentials(forAudience: \"http:\/\/example.com\/api\","," scope: \"read:todos update:todos\") { print($0) }"]},{"inlineContent":[{"text":"To avoid retrieving access tokens with too little time left, enforce a minimum TTL (in seconds):","type":"text"}],"type":"paragraph"},{"syntax":"swift","type":"codeListing","code":["credentialsManager.apiCredentials(forAudience: \"http:\/\/example.com\/api\","," minTTL: 60) { print($0) }"]},{"inlineContent":[{"text":"You can specify custom parameters or headers for the exchange request:","type":"text"}],"type":"paragraph"},{"syntax":"swift","type":"codeListing","code":["credentialsManager.apiCredentials(forAudience: \"http:\/\/example.com\/api\","," parameters: [\"key\": \"value\"],"," headers: [\"key\": \"value\"]) { print($0) }"]},{"name":"Requires","type":"aside","style":"note","content":[{"inlineContent":[{"type":"text","text":"The scope "},{"type":"codeVoice","code":"offline_access"},{"type":"text","text":" to have been requested on login to get a refresh token from Auth0. If"},{"type":"text","text":" "},{"type":"text","text":"the API credentials are expired and there is no refresh token, the callback will be called with a"},{"text":" ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken","type":"reference","isActive":true},{"type":"text","text":" error."}],"type":"paragraph"}]},{"name":"Important","type":"aside","style":"important","content":[{"inlineContent":[{"type":"text","text":"To ensure that no concurrent exchange requests get made, do not call this method from multiple"},{"text":" ","type":"text"},{"text":"Credentials Manager instances. The Credentials Manager cannot synchronize requests across instances.","type":"text"}],"type":"paragraph"}]}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerResult":{"kind":"symbol","abstract":[{"code":"Result","type":"codeVoice"},{"text":" wrapper for Credentials Manager operations.","type":"text"}],"type":"topic","title":"CredentialsManagerResult","url":"\/documentation\/auth0\/credentialsmanagerresult","role":"symbol","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerResult"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerResult","navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerResult"}]},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"kind":"symbol","title":"cause","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier","text":"Error"},{"kind":"text","text":"?"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","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":"."}],"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/noRefreshToken":{"title":"noRefreshToken","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"noRefreshToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"}],"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":" "},{"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"}],"url":"\/documentation\/auth0\/credentialsmanagererror\/norefreshtoken"},"doc://com.auth0.Auth0/documentation/Auth0/APICredentials":{"role":"symbol","title":"APICredentials","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"APICredentials"}],"navigatorTitle":[{"kind":"identifier","text":"APICredentials"}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0 for a specific API as the result of exchanging a refresh token."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials","url":"\/documentation\/auth0\/apicredentials","type":"topic"},"https://auth0.com/docs/api/authentication/refresh-token/refresh-token":{"url":"https:\/\/auth0.com\/docs\/api\/authentication\/refresh-token\/refresh-token","type":"link","title":"Authentication API Endpoint","titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}],"identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/refresh-token\/refresh-token"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/apiCredentials(forAudience:scope:minTTL:parameters:headers:callback:)":{"kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"apiCredentials"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forAudience"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"minTTL"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"},{"kind":"text","text":", "},{"kind":"externalParam","text":"parameters"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" : "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"callback"},{"kind":"text","text":": ("},{"preciseIdentifier":"s:5Auth024CredentialsManagerResulta","kind":"typeIdentifier","text":"CredentialsManagerResult"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:5Auth014APICredentialsV","kind":"typeIdentifier","text":"APICredentials"},{"kind":"text","text":">) -> "},{"preciseIdentifier":"s:s4Voida","kind":"typeIdentifier","text":"Void"},{"kind":"text","text":")"}],"title":"apiCredentials(forAudience:scope:minTTL:parameters:headers:callback:)","type":"topic","role":"symbol","abstract":[{"text":"Retrieves API credentials from the Keychain and automatically renews them using the refresh token if the access","type":"text"},{"text":" ","type":"text"},{"text":"token is expired. Otherwise, the retrieved API credentials will be returned via the success case as they are","type":"text"},{"text":" ","type":"text"},{"text":"still valid.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/apiCredentials(forAudience:scope:minTTL:parameters:headers:callback:)","url":"\/documentation\/auth0\/credentialsmanager\/apicredentials(foraudience:scope:minttl:parameters:headers:callback:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"https://auth0.com/docs/secure/tokens/refresh-tokens":{"url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","type":"link","title":"Refresh Tokens","titleInlineContent":[{"text":"Refresh Tokens","type":"text"}],"identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"Credentials","kind":"identifier"}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}]},"doc://com.auth0.Auth0/documentation/Auth0/RefreshTokens":{"title":"Refresh Tokens: Common Errors","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens","role":"article","kind":"article","abstract":[],"url":"\/documentation\/auth0\/refreshtokens"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"title":"CredentialsManager","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManager"}],"abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanager","navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}]},"https://auth0.com/docs/get-started/apis/scopes":{"url":"https:\/\/auth0.com\/docs\/get-started\/apis\/scopes","type":"link","title":"Scopes","titleInlineContent":[{"text":"Scopes","type":"text"}],"identifier":"https:\/\/auth0.com\/docs\/get-started\/apis\/scopes"}}} \ 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 2682de6a0..4a6b86346 100644 --- a/docs/data/documentation/auth0/credentialsmanager/canrenew().json +++ b/docs/data/documentation/auth0/credentialsmanager/canrenew().json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/canRenew()","interfaceLanguage":"swift"},"schemaVersion":{"major":0,"minor":3,"patch":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"},{"text":"refresh tokens, use this method instead of ","type":"text"},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/hasValid(minTTL:)"},{"text":" to check for stored credentials when your app","type":"text"},{"text":" ","type":"text"},{"text":"starts up.","type":"text"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanager\/canrenew()"]}],"kind":"symbol","metadata":{"role":"symbol","externalID":"s:5Auth018CredentialsManagerV8canRenewSbyF","roleHeading":"Instance Method","modules":[{"name":"Auth0"}],"title":"canRenew()","symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"canRenew","kind":"identifier"},{"text":"() -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}]},"sections":[],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"canRenew"},{"kind":"text","text":"() -> "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"},{"content":[{"type":"heading","text":"Return Value","level":2,"anchor":"return-value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"If there are credentials stored containing a refresh token."}]}],"kind":"content"},{"content":[{"type":"heading","level":2,"text":"Usage","anchor":"Usage"},{"type":"codeListing","code":["guard credentialsManager.canRenew() else {"," \/\/ No renewable credentials exist, present the login page","}","\/\/ Retrieve the stored credentials"],"syntax":"swift"}],"kind":"content"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/canRenew()":{"kind":"symbol","url":"\/documentation\/auth0\/credentialsmanager\/canrenew()","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/canRenew()","title":"canRenew()","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"canRenew","kind":"identifier"},{"text":"() -> ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"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","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/hasValid(minTTL:)","isActive":true},{"type":"text","text":" to check for stored credentials when your app"},{"type":"text","text":" "},{"type":"text","text":"starts up."}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManager","kind":"identifier"}],"navigatorTitle":[{"text":"CredentialsManager","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","abstract":[{"type":"text","text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain."}],"kind":"symbol","title":"CredentialsManager","url":"\/documentation\/auth0\/credentialsmanager","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/hasValid(minTTL:)":{"url":"\/documentation\/auth0\/credentialsmanager\/hasvalid(minttl:)","abstract":[{"text":"Checks that there are credentials stored, and that the access token has not expired and will not expire within","type":"text"},{"text":" ","type":"text"},{"text":"the specified TTL. If you are not using refresh tokens, use this method instead of ","type":"text"},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/canRenew()"},{"text":" to","type":"text"},{"text":" ","type":"text"},{"text":"check for stored credentials when your app starts up.","type":"text"}],"role":"symbol","title":"hasValid(minTTL:)","type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/hasValid(minTTL:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"hasValid","kind":"identifier"},{"text":"(","kind":"text"},{"text":"minTTL","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}]}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"metadata":{"symbolKind":"method","modules":[{"name":"Auth0"}],"title":"canRenew()","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"canRenew","kind":"identifier"},{"text":"() -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"externalID":"s:5Auth018CredentialsManagerV8canRenewSbyF","role":"symbol","roleHeading":"Instance Method"},"sections":[],"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","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/hasValid(minTTL:)","isActive":true},{"type":"text","text":" to check for stored credentials when your app"},{"type":"text","text":" "},{"type":"text","text":"starts up."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanager\/canrenew()"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/canRenew()","interfaceLanguage":"swift"},"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"canRenew","kind":"identifier"},{"text":"() -> ","kind":"text"},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"languages":["swift"],"platforms":["iOS"]}]},{"content":[{"level":2,"type":"heading","anchor":"return-value","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"If there are credentials stored containing a refresh token."}]}],"kind":"content"},{"content":[{"level":2,"text":"Usage","type":"heading","anchor":"Usage"},{"code":["guard credentialsManager.canRenew() else {"," \/\/ No renewable credentials exist, present the login page","}","\/\/ Retrieve the stored credentials"],"syntax":"swift","type":"codeListing"}],"kind":"content"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"title":"CredentialsManager","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManager"}],"abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanager","navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/hasValid(minTTL:)":{"kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"hasValid"},{"kind":"text","text":"("},{"text":"minTTL","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Int","preciseIdentifier":"s:Si","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"title":"hasValid(minTTL:)","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Checks that there are credentials stored, and that the access token has not expired and will not expire within"},{"type":"text","text":" "},{"type":"text","text":"the specified TTL. If you are not using refresh tokens, use this method instead of "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/canRenew()","isActive":true},{"type":"text","text":" to"},{"type":"text","text":" "},{"type":"text","text":"check for stored credentials when your app starts up."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/hasValid(minTTL:)","url":"\/documentation\/auth0\/credentialsmanager\/hasvalid(minttl:)"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/canRenew()":{"url":"\/documentation\/auth0\/credentialsmanager\/canrenew()","abstract":[{"type":"text","text":"Checks that there are credentials stored, and that the credentials contain a refresh token. If you are using"},{"type":"text","text":" "},{"type":"text","text":"refresh tokens, use this method instead of "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/hasValid(minTTL:)","isActive":true},{"type":"text","text":" to check for stored credentials when your app"},{"type":"text","text":" "},{"type":"text","text":"starts up."}],"title":"canRenew()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"canRenew"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/canRenew()","role":"symbol","kind":"symbol","type":"topic"}}} \ 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 bbb99efb3..fb71b009b 100644 --- a/docs/data/documentation/auth0/credentialsmanager/clear().json +++ b/docs/data/documentation/auth0/credentialsmanager/clear().json @@ -1 +1 @@ -{"metadata":{"roleHeading":"Instance Method","modules":[{"name":"Auth0"}],"role":"symbol","title":"clear()","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"clear","kind":"identifier"},{"text":"() -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"symbolKind":"method","externalID":"s:5Auth018CredentialsManagerV5clearSbyF"},"sections":[],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"clear","kind":"identifier"},{"text":"() -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}]}],"kind":"declarations"},{"content":[{"text":"Return Value","level":2,"anchor":"return-value","type":"heading"},{"inlineContent":[{"text":"If the credentials were removed.","type":"text"}],"type":"paragraph"}],"kind":"content"},{"content":[{"text":"Usage","level":2,"type":"heading","anchor":"Usage"},{"code":["let didClear = credentialsManager.clear()"],"syntax":"swift","type":"codeListing"}],"kind":"content"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/clear()","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Clears credentials stored in the Keychain."}],"kind":"symbol","schemaVersion":{"major":0,"patch":0,"minor":3},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"variants":[{"paths":["\/documentation\/auth0\/credentialsmanager\/clear()"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/clear()":{"abstract":[{"text":"Clears credentials stored in the Keychain.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanager\/clear()","kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"clear"},{"kind":"text","text":"() -> "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/clear()","role":"symbol","title":"clear()","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManager","kind":"identifier"}],"navigatorTitle":[{"text":"CredentialsManager","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","abstract":[{"type":"text","text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain."}],"kind":"symbol","title":"CredentialsManager","url":"\/documentation\/auth0\/credentialsmanager","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"sections":[],"kind":"symbol","metadata":{"externalID":"s:5Auth018CredentialsManagerV5clearSbyF","modules":[{"name":"Auth0"}],"title":"clear()","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"clear","kind":"identifier"},{"text":"() -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"roleHeading":"Instance Method","role":"symbol","symbolKind":"method"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/clear()","interfaceLanguage":"swift"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanager\/clear()"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"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":"clear"},{"kind":"text","text":"() -> "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"},{"kind":"content","content":[{"text":"Return Value","level":2,"type":"heading","anchor":"return-value"},{"inlineContent":[{"type":"text","text":"If the credentials were removed."}],"type":"paragraph"}]},{"kind":"content","content":[{"text":"Usage","anchor":"Usage","type":"heading","level":2},{"type":"codeListing","code":["let didClear = credentialsManager.clear()"],"syntax":"swift"}]}],"abstract":[{"text":"Clears credentials stored in the Keychain.","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/clear()":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/clear()","kind":"symbol","title":"clear()","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"clear","kind":"identifier"},{"text":"() -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"role":"symbol","url":"\/documentation\/auth0\/credentialsmanager\/clear()","abstract":[{"type":"text","text":"Clears credentials stored in the Keychain."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"title":"CredentialsManager","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManager"}],"abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanager","navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentialsmanager/clear(foraudience:).json b/docs/data/documentation/auth0/credentialsmanager/clear(foraudience:).json deleted file mode 100644 index 3cd4447cc..000000000 --- a/docs/data/documentation/auth0/credentialsmanager/clear(foraudience:).json +++ /dev/null @@ -1 +0,0 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanager\/clear(foraudience:)"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"clear","kind":"identifier"},{"text":"(","kind":"text"},{"text":"forAudience","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"audience","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"text":"Identifier of the API the stored API credentials are for.","type":"text"}],"type":"paragraph"}],"name":"audience"}]},{"content":[{"text":"Return Value","type":"heading","level":2,"anchor":"return-value"},{"inlineContent":[{"text":"If the API credentials were removed.","type":"text"}],"type":"paragraph"}],"kind":"content"},{"content":[{"level":2,"text":"Usage","type":"heading","anchor":"Usage"},{"syntax":"swift","type":"codeListing","code":["let didClear = credentialsManager.clear(forAudience: \"http:\/\/example.com\/api\")"]}],"kind":"content"}],"metadata":{"symbolKind":"method","role":"symbol","externalID":"s:5Auth018CredentialsManagerV5clear11forAudienceSbSS_tF","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"clear"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forAudience"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"title":"clear(forAudience:)","roleHeading":"Instance Method"},"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/clear(forAudience:)"},"abstract":[{"type":"text","text":"Clears API credentials stored in the Keychain for a given audience value."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManager","kind":"identifier"}],"navigatorTitle":[{"text":"CredentialsManager","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","abstract":[{"type":"text","text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain."}],"kind":"symbol","title":"CredentialsManager","url":"\/documentation\/auth0\/credentialsmanager","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/clear(forAudience:)":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"clear","kind":"identifier"},{"text":"(","kind":"text"},{"text":"forAudience","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"kind":"symbol","role":"symbol","title":"clear(forAudience:)","abstract":[{"type":"text","text":"Clears API credentials stored in the Keychain for a given audience value."}],"url":"\/documentation\/auth0\/credentialsmanager\/clear(foraudience:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/clear(forAudience:)","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentialsmanager/clear(foraudience:scope:).json b/docs/data/documentation/auth0/credentialsmanager/clear(foraudience:scope:).json new file mode 100644 index 000000000..2e294afeb --- /dev/null +++ b/docs/data/documentation/auth0/credentialsmanager/clear(foraudience:scope:).json @@ -0,0 +1 @@ +{"metadata":{"role":"symbol","modules":[{"name":"Auth0"}],"title":"clear(forAudience:scope:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"clear","kind":"identifier"},{"text":"(","kind":"text"},{"text":"forAudience","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"scope","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?) -> "},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"externalID":"s:5Auth018CredentialsManagerV5clear11forAudience5scopeSbSS_SSSgtF","roleHeading":"Instance Method","symbolKind":"method"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanager\/clear(foraudience:scope:)"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/clear(forAudience:scope:)"},"kind":"symbol","abstract":[{"text":"Clears API credentials stored in the Keychain for a given audience value.","type":"text"}],"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"},{"text":"clear","kind":"identifier"},{"text":"(","kind":"text"},{"text":"forAudience","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"audience","kind":"internalParam"},{"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"},{"text":"? = nil) -> ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}]}]},{"kind":"parameters","parameters":[{"name":"audience","content":[{"inlineContent":[{"type":"text","text":"Identifier of the API the stored API credentials are for."}],"type":"paragraph"}]},{"name":"scope","content":[{"inlineContent":[{"type":"text","text":"Optional scope for which the API Credentials are stored. If the credentials were initially fetched\/stored with scope,"},{"type":"text","text":" "},{"type":"text","text":"it is recommended to pass scope also while clearing them."}],"type":"paragraph"}]}]},{"kind":"content","content":[{"type":"heading","anchor":"return-value","level":2,"text":"Return Value"},{"type":"paragraph","inlineContent":[{"text":"If the API credentials were removed.","type":"text"}]}]},{"kind":"content","content":[{"type":"heading","anchor":"Usage","level":2,"text":"Usage"},{"type":"codeListing","syntax":"swift","code":["let didClear = credentialsManager.clear(forAudience: \"http:\/\/example.com\/api\")"]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"title":"CredentialsManager","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManager"}],"abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanager","navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/clear(forAudience:scope:)":{"type":"topic","abstract":[{"type":"text","text":"Clears API credentials stored in the Keychain for a given audience value."}],"title":"clear(forAudience:scope:)","kind":"symbol","url":"\/documentation\/auth0\/credentialsmanager\/clear(foraudience:scope:)","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"clear"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forAudience"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?) -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/clear(forAudience:scope:)"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentialsmanager/clearbiometricsession().json b/docs/data/documentation/auth0/credentialsmanager/clearbiometricsession().json new file mode 100644 index 000000000..7a1db0801 --- /dev/null +++ b/docs/data/documentation/auth0/credentialsmanager/clearbiometricsession().json @@ -0,0 +1 @@ +{"schemaVersion":{"patch":0,"major":0,"minor":3},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"clearBiometricSession"},{"kind":"text","text":"()"}],"platforms":["iOS"]}]},{"content":[{"text":"Usage","level":2,"type":"heading","anchor":"Usage"},{"syntax":"swift","code":["credentialsManager.clearBiometricSession()"],"type":"codeListing"}],"kind":"content"}],"sections":[],"abstract":[{"text":"Clears the in-memory biometric session timestamp. This will force biometric authentication on the next","type":"text"},{"text":" ","type":"text"},{"text":"credential access.","type":"text"}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanager\/clearbiometricsession()"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/clearBiometricSession()","interfaceLanguage":"swift"},"metadata":{"role":"symbol","title":"clearBiometricSession()","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"clearBiometricSession"},{"kind":"text","text":"()"}],"externalID":"s:5Auth018CredentialsManagerV21clearBiometricSessionyyF","roleHeading":"Instance Method","symbolKind":"method"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/clearBiometricSession()":{"url":"\/documentation\/auth0\/credentialsmanager\/clearbiometricsession()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"clearBiometricSession"},{"kind":"text","text":"()"}],"title":"clearBiometricSession()","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Clears the in-memory biometric session timestamp. This will force biometric authentication on the next"},{"type":"text","text":" "},{"type":"text","text":"credential access."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/clearBiometricSession()","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"title":"CredentialsManager","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManager"}],"abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanager","navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ 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 ac4758a2e..528f2d6f4 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 @@ -{"abstract":[{"text":"Retrieves credentials from the Keychain and automatically renews them using the refresh token if the access","type":"text"},{"text":" ","type":"text"},{"text":"token is expired. Otherwise, it returns the retrieved credentials as they are still valid. Renewed credentials","type":"text"},{"text":" ","type":"text"},{"text":"will be stored in the Keychain. ","type":"text"},{"type":"strong","inlineContent":[{"text":"This method is thread-safe","type":"text"}]},{"text":".","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"credentials"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withScope"},{"kind":"text","text":" "},{"kind":"internalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"? = nil, "},{"kind":"externalParam","text":"minTTL"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"},{"kind":"text","text":" = 0, "},{"kind":"externalParam","text":"parameters"},{"kind":"text","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"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"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"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"}],"languages":["swift"],"platforms":["iOS"]}]},{"kind":"parameters","parameters":[{"name":"scope","content":[{"inlineContent":[{"type":"text","text":"Space-separated list of scope values to request when renewing credentials. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":", which will ask for the same scopes that were requested on login."}],"type":"paragraph"}]},{"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"},{"type":"codeVoice","code":"0"},{"text":".","type":"text"}]}]},{"name":"parameters","content":[{"inlineContent":[{"type":"text","text":"Additional parameters to use when renewing credentials."}],"type":"paragraph"}]},{"name":"headers","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Additional headers to use when renewing credentials."}]}]}]},{"kind":"content","content":[{"text":"Return Value","level":2,"anchor":"return-value","type":"heading"},{"inlineContent":[{"text":"The user’s credentials.","type":"text"}],"type":"paragraph"}]},{"kind":"content","content":[{"text":"Usage","level":2,"anchor":"Usage","type":"heading"},{"code":["do {"," let credentials = try await credentialsManager.credentials()"," print(\"Obtained credentials: \\(credentials)\")","} catch {"," print(\"Failed with: \\(error)\")","}"],"syntax":"swift","type":"codeListing"},{"inlineContent":[{"text":"To avoid retrieving access tokens with too little time left, enforce a minimum TTL (in seconds):","type":"text"}],"type":"paragraph"},{"code":["let credentials = try await credentialsManager.credentials(minTTL: 60)"],"syntax":"swift","type":"codeListing"},{"inlineContent":[{"type":"text","text":"You can specify custom parameters or headers for the renewal request:"}],"type":"paragraph"},{"code":["let credentials = try await credentialsManager.credentials(parameters: [\"key\": \"value\"],"," headers: [\"key\": \"value\"])"],"syntax":"swift","type":"codeListing"},{"inlineContent":[{"text":"When renewing credentials you can get a downscoped access token by requesting fewer scopes than were requested","type":"text"},{"text":" ","type":"text"},{"text":"on login. If you specify fewer scopes, the credentials will be renewed immediately, regardless of whether they","type":"text"},{"text":" ","type":"text"},{"text":"are expired or not.","type":"text"}],"type":"paragraph"},{"code":["let credentials = try await credentialsManager.credentials(scope: \"openid offline_access\")"],"syntax":"swift","type":"codeListing"},{"content":[{"inlineContent":[{"text":"An error of type ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","isActive":true,"type":"reference"},{"text":".","type":"text"}],"type":"paragraph"}],"name":"Throws","style":"note","type":"aside"},{"content":[{"inlineContent":[{"type":"text","text":"The scope "},{"type":"codeVoice","code":"offline_access"},{"type":"text","text":" to have been requested on login to get a refresh token from Auth0. If"},{"type":"text","text":" "},{"type":"text","text":"the credentials are expired and there is no refresh token, a "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken","isActive":true},{"type":"text","text":" error"},{"type":"text","text":" "},{"type":"text","text":"will be thrown."}],"type":"paragraph"}],"name":"Requires","style":"note","type":"aside"},{"content":[{"inlineContent":[{"text":"Do not call ","type":"text"},{"code":"store(credentials:)","type":"codeVoice"},{"text":" afterward. The Credentials Manager automatically persists the","type":"text"},{"text":" ","type":"text"},{"text":"renewed credentials. Since this method is thread-safe and ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/store(credentials:)","isActive":true,"type":"reference"},{"text":" is not, calling it anyway can","type":"text"},{"text":" ","type":"text"},{"text":"cause concurrency issues.","type":"text"}],"type":"paragraph"}],"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","style":"important","type":"aside"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/credentials(withScope:minTTL:parameters:headers:)-11d2f","interfaceLanguage":"swift"},"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","https:\/\/auth0.com\/docs\/api\/authentication\/refresh-token\/refresh-token","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens"],"anchor":"Related-Documentation"}],"variants":[{"paths":["\/documentation\/auth0\/credentialsmanager\/credentials(withscope:minttl:parameters:headers:)-11d2f"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"modules":[{"name":"Auth0"}],"extendedModule":"Auth0","title":"credentials(withScope:minTTL:parameters:headers:)","externalID":"s:5Auth018CredentialsManagerV11credentials9withScope6minTTL10parameters7headersAA0B0CSSSg_SiSDySSypGSDyS2SGtYaKF","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"credentials"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withScope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"minTTL"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"},{"kind":"text","text":", "},{"kind":"externalParam","text":"parameters"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"}],"symbolKind":"method","role":"symbol"},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"schemaVersion":{"patch":0,"major":0,"minor":3},"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/RefreshTokens":{"url":"\/documentation\/auth0\/refreshtokens","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens","kind":"article","title":"Refresh Tokens: Common Errors","type":"topic","abstract":[],"role":"article"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/credentials(withScope:minTTL:parameters:headers:)-11d2f":{"role":"symbol","kind":"symbol","url":"\/documentation\/auth0\/credentialsmanager\/credentials(withscope:minttl:parameters:headers:)-11d2f","type":"topic","abstract":[{"text":"Retrieves credentials from the Keychain and automatically renews them using the refresh token if the access","type":"text"},{"text":" ","type":"text"},{"text":"token is expired. Otherwise, it returns the retrieved credentials as they are still valid. Renewed credentials","type":"text"},{"text":" ","type":"text"},{"text":"will be stored in the Keychain. ","type":"text"},{"inlineContent":[{"type":"text","text":"This method is thread-safe"}],"type":"strong"},{"text":".","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/credentials(withScope:minTTL:parameters:headers:)-11d2f","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"credentials","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withScope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"minTTL","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Int","preciseIdentifier":"s:Si","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"parameters","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"], ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"]) ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier"}],"title":"credentials(withScope:minTTL:parameters:headers:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManager","kind":"identifier"}],"navigatorTitle":[{"text":"CredentialsManager","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","abstract":[{"type":"text","text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain."}],"kind":"symbol","title":"CredentialsManager","url":"\/documentation\/auth0\/credentialsmanager","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"title":"cause","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","kind":"symbol","abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":"?"}],"role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"url":"\/documentation\/auth0\/credentials","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"role":"symbol","type":"topic","abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"url":"\/documentation\/auth0\/credentialsmanagererror","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}],"title":"CredentialsManagerError","kind":"symbol","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}]},"https://auth0.com/docs/secure/tokens/refresh-tokens":{"title":"Refresh Tokens","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","titleInlineContent":[{"type":"text","text":"Refresh Tokens"}],"type":"link","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens"},"https://auth0.com/docs/api/authentication/refresh-token/refresh-token":{"title":"Authentication API Endpoint","url":"https:\/\/auth0.com\/docs\/api\/authentication\/refresh-token\/refresh-token","titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}],"type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/refresh-token\/refresh-token"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/store(credentials:)":{"abstract":[{"type":"text","text":"Stores a "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","isActive":true},{"type":"text","text":" instance in the Keychain."}],"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/credentialsmanager\/store(credentials:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/store(credentials:)","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"store"},{"kind":"text","text":"("},{"kind":"externalParam","text":"credentials"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"title":"store(credentials:)"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/noRefreshToken":{"url":"\/documentation\/auth0\/credentialsmanagererror\/norefreshtoken","abstract":[{"type":"text","text":"The stored "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","isActive":true},{"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":"."}],"fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"noRefreshToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"}],"kind":"symbol","type":"topic","title":"noRefreshToken","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"metadata":{"externalID":"s:5Auth018CredentialsManagerV11credentials9withScope6minTTL10parameters7headersAA0B0CSSSg_SiSDySSypGSDyS2SGtYaKF","title":"credentials(withScope:minTTL:parameters:headers:)","symbolKind":"method","role":"symbol","roleHeading":"Instance Method","extendedModule":"Auth0","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"credentials"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withScope"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"minTTL"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"kind":"text","text":", "},{"kind":"externalParam","text":"parameters"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"text":"], ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"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"}]},"sections":[],"abstract":[{"text":"Retrieves credentials from the Keychain and automatically renews them using the refresh token if the access","type":"text"},{"type":"text","text":" "},{"type":"text","text":"token is expired. Otherwise, it returns the retrieved credentials as they are still valid. Renewed credentials"},{"type":"text","text":" "},{"type":"text","text":"will be stored in the Keychain. "},{"type":"strong","inlineContent":[{"type":"text","text":"This method is thread-safe"}]},{"type":"text","text":"."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanager\/credentials(withscope:minttl:parameters:headers:)-11d2f"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/credentials(withScope:minTTL:parameters:headers:)-11d2f","interfaceLanguage":"swift"},"seeAlsoSections":[{"title":"Related Documentation","anchor":"Related-Documentation","identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","https:\/\/auth0.com\/docs\/api\/authentication\/refresh-token\/refresh-token","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens"]}],"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"credentials"},{"kind":"text","text":"("},{"text":"withScope","kind":"externalParam"},{"text":" ","kind":"text"},{"kind":"internalParam","text":"scope"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"? = nil, "},{"text":"minTTL","kind":"externalParam"},{"kind":"text","text":": "},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"text":" = 0, ","kind":"text"},{"kind":"externalParam","text":"parameters"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"text":"] = [:], ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"] = [:]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"text":"Credentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"}],"platforms":["iOS"],"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"},{"text":".","type":"text"}],"type":"paragraph"}]},{"name":"parameters","content":[{"inlineContent":[{"text":"Additional parameters to use when renewing credentials.","type":"text"}],"type":"paragraph"}]},{"name":"headers","content":[{"inlineContent":[{"text":"Additional headers to use when renewing credentials.","type":"text"}],"type":"paragraph"}]}]},{"content":[{"anchor":"return-value","level":2,"text":"Return Value","type":"heading"},{"inlineContent":[{"type":"text","text":"The user’s credentials."}],"type":"paragraph"}],"kind":"content"},{"content":[{"text":"Usage","level":2,"type":"heading","anchor":"Usage"},{"type":"codeListing","code":["do {"," let credentials = try await credentialsManager.credentials()"," print(\"Obtained credentials: \\(credentials)\")","} catch {"," print(\"Failed with: \\(error)\")","}"],"syntax":"swift"},{"inlineContent":[{"text":"To avoid retrieving access tokens with too little time left, enforce a minimum TTL (in seconds):","type":"text"}],"type":"paragraph"},{"code":["let credentials = try await credentialsManager.credentials(minTTL: 60)"],"syntax":"swift","type":"codeListing"},{"inlineContent":[{"text":"You can specify custom parameters or headers for the renewal request:","type":"text"}],"type":"paragraph"},{"type":"codeListing","code":["let credentials = try await credentialsManager.credentials(parameters: [\"key\": \"value\"],"," headers: [\"key\": \"value\"])"],"syntax":"swift"},{"inlineContent":[{"text":"When renewing credentials you can get a downscoped access token by requesting fewer scopes than were requested","type":"text"},{"text":" ","type":"text"},{"text":"on login. If you specify fewer scopes, the credentials will be renewed immediately, regardless of whether they","type":"text"},{"text":" ","type":"text"},{"text":"are expired or not.","type":"text"}],"type":"paragraph"},{"syntax":"swift","code":["let credentials = try await credentialsManager.credentials(scope: \"openid offline_access\")"],"type":"codeListing"},{"name":"Throws","style":"note","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"},{"name":"Requires","type":"aside","style":"note","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, a ","type":"text"},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken"},{"text":" error","type":"text"},{"type":"text","text":" "},{"type":"text","text":"will be thrown."}]}]},{"name":"Warning","type":"aside","style":"warning","content":[{"type":"paragraph","inlineContent":[{"text":"Do not call ","type":"text"},{"type":"codeVoice","code":"store(credentials:)"},{"text":" afterward. The Credentials Manager automatically persists the","type":"text"},{"text":" ","type":"text"},{"text":"renewed credentials. Since this method is thread-safe and ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/store(credentials:)","type":"reference","isActive":true},{"text":" is not, calling it anyway can","type":"text"},{"text":" ","type":"text"},{"text":"cause concurrency issues.","type":"text"}]}]},{"name":"Important","type":"aside","style":"important","content":[{"inlineContent":[{"text":"To ensure that no concurrent renewal requests get made, do not call this method from multiple","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"Credentials Manager instances. The Credentials Manager cannot synchronize requests across instances."}],"type":"paragraph"}]}],"kind":"content"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"title":"CredentialsManager","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManager"}],"abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanager","navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}]},"https://auth0.com/docs/api/authentication/refresh-token/refresh-token":{"title":"Authentication API Endpoint","type":"link","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/refresh-token\/refresh-token","url":"https:\/\/auth0.com\/docs\/api\/authentication\/refresh-token\/refresh-token"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"Credentials","kind":"identifier"}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/credentials(withScope:minTTL:parameters:headers:)-11d2f":{"type":"topic","abstract":[{"type":"text","text":"Retrieves credentials from the Keychain and automatically renews them using the refresh token if the access"},{"type":"text","text":" "},{"type":"text","text":"token is expired. Otherwise, it returns the retrieved credentials as they are still valid. Renewed credentials"},{"type":"text","text":" "},{"type":"text","text":"will be stored in the Keychain. "},{"inlineContent":[{"type":"text","text":"This method is thread-safe"}],"type":"strong"},{"type":"text","text":"."}],"kind":"symbol","url":"\/documentation\/auth0\/credentialsmanager\/credentials(withscope:minttl:parameters:headers:)-11d2f","title":"credentials(withScope:minTTL:parameters:headers:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"credentials","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"withScope"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"minTTL"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"},{"text":", ","kind":"text"},{"text":"parameters","kind":"externalParam"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"text":"], ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"]) ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/credentials(withScope:minTTL:parameters:headers:)-11d2f"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/noRefreshToken":{"title":"noRefreshToken","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"noRefreshToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"}],"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":" "},{"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"}],"url":"\/documentation\/auth0\/credentialsmanagererror\/norefreshtoken"},"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","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"store"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"credentials"},{"kind":"text","text":": "},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","text":"Credentials"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"abstract":[{"type":"text","text":"Stores a "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","isActive":true},{"type":"text","text":" instance in the Keychain."}],"url":"\/documentation\/auth0\/credentialsmanager\/store(credentials:)"},"doc://com.auth0.Auth0/documentation/Auth0/RefreshTokens":{"title":"Refresh Tokens: Common Errors","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens","role":"article","kind":"article","abstract":[],"url":"\/documentation\/auth0\/refreshtokens"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"kind":"symbol","title":"cause","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier","text":"Error"},{"kind":"text","text":"?"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","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":"."}],"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"role":"symbol","title":"CredentialsManagerError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerError"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}],"abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","url":"\/documentation\/auth0\/credentialsmanagererror","type":"topic"},"https://auth0.com/docs/secure/tokens/refresh-tokens":{"title":"Refresh Tokens","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","type":"link","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","titleInlineContent":[{"text":"Refresh Tokens","type":"text"}]}}} \ 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 3c1e9b215..bd2235170 100644 --- a/docs/data/documentation/auth0/credentialsmanager/credentials(withscope:minttl:parameters:headers:)-7xldm.json +++ b/docs/data/documentation/auth0/credentialsmanager/credentials(withscope:minttl:parameters:headers:)-7xldm.json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"credentials"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withScope"},{"kind":"text","text":" "},{"kind":"internalParam","text":"scope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"? = nil, "},{"kind":"externalParam","text":"minTTL"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"},{"kind":"text","text":" = 0, "},{"kind":"externalParam","text":"parameters"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"] = [:], "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"] = [:]) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:7Combine12AnyPublisherV","text":"AnyPublisher"},{"kind":"text","text":"<"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"},{"kind":"text","text":", "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"},{"kind":"text","text":">"}],"platforms":["iOS"]}]},{"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 "},{"type":"codeVoice","code":"nil"},{"type":"text","text":", which will ask for the same scopes that were requested on login."}]}]},{"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":[{"text":"Additional headers to use when renewing credentials.","type":"text"}]}]}]},{"kind":"content","content":[{"text":"Return Value","type":"heading","level":2,"anchor":"return-value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A type-erased publisher."}]}]},{"kind":"content","content":[{"text":"Usage","level":2,"anchor":"Usage","type":"heading"},{"syntax":"swift","type":"codeListing","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, enforce a minimum TTL (in seconds):","type":"text"}]},{"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":"You can specify custom parameters or headers for the renewal request:"}]},{"syntax":"swift","type":"codeListing","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"},{"text":" ","type":"text"},{"text":"are expired or not.","type":"text"}]},{"syntax":"swift","type":"codeListing","code":["credentialsManager"," .credentials(scope: \"openid offline_access\")"," .sink(receiveCompletion: { print($0) },"," receiveValue: { print($0) })"," .store(in: &cancellables)"]},{"type":"aside","style":"note","name":"Requires","content":[{"inlineContent":[{"type":"text","text":"The scope "},{"type":"codeVoice","code":"offline_access"},{"type":"text","text":" to have been requested on login to get a refresh token from Auth0. If"},{"type":"text","text":" "},{"type":"text","text":"the credentials are expired and there is no refresh token, the subscription will complete with a"},{"type":"text","text":" "},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken","type":"reference"},{"type":"text","text":" error."}],"type":"paragraph"}]},{"type":"aside","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","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/store(credentials:)","isActive":true},{"type":"text","text":" is not, calling it anyway can"},{"type":"text","text":" "},{"type":"text","text":"cause concurrency issues."}]}]},{"type":"aside","style":"important","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"},{"text":"Credentials Manager instances. The Credentials Manager cannot synchronize requests across instances.","type":"text"}],"type":"paragraph"}]}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/credentials(withScope:minTTL:parameters:headers:)-7xldm"},"seeAlsoSections":[{"anchor":"Related-Documentation","title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","https:\/\/auth0.com\/docs\/api\/authentication\/refresh-token\/refresh-token","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens"]}],"abstract":[{"text":"Retrieves credentials from the Keychain and automatically renews them using the refresh token if the access","type":"text"},{"text":" ","type":"text"},{"text":"token is expired. Otherwise, the subscription will complete with the retrieved credentials as they are still","type":"text"},{"text":" ","type":"text"},{"text":"valid. Renewed credentials will be stored in the Keychain. ","type":"text"},{"type":"strong","inlineContent":[{"text":"This method is thread-safe","type":"text"}]},{"text":".","type":"text"}],"schemaVersion":{"patch":0,"major":0,"minor":3},"metadata":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"credentials","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withScope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"text":"minTTL","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"text":", ","kind":"text"},{"text":"parameters","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","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"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"]) -> ","kind":"text"},{"text":"AnyPublisher","kind":"typeIdentifier","preciseIdentifier":"s:7Combine12AnyPublisherV"},{"text":"<","kind":"text"},{"text":"Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"text":", ","kind":"text"},{"text":"CredentialsManagerError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"},{"text":">","kind":"text"}],"role":"symbol","symbolKind":"method","modules":[{"name":"Auth0"}],"externalID":"s:5Auth018CredentialsManagerV11credentials9withScope6minTTL10parameters7headers7Combine12AnyPublisherVyAA0B0CAA0bC5ErrorVGSSSg_SiSDySSypGSDyS2SGtF","extendedModule":"Auth0","title":"credentials(withScope:minTTL:parameters:headers:)","roleHeading":"Instance Method"},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"sections":[],"variants":[{"paths":["\/documentation\/auth0\/credentialsmanager\/credentials(withscope:minttl:parameters:headers:)-7xldm"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/noRefreshToken":{"url":"\/documentation\/auth0\/credentialsmanagererror\/norefreshtoken","abstract":[{"type":"text","text":"The stored "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","isActive":true},{"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":"."}],"fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"noRefreshToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"}],"kind":"symbol","type":"topic","title":"noRefreshToken","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"url":"\/documentation\/auth0\/credentialsmanagererror","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}],"title":"CredentialsManagerError","kind":"symbol","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManager","kind":"identifier"}],"navigatorTitle":[{"text":"CredentialsManager","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","abstract":[{"type":"text","text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain."}],"kind":"symbol","title":"CredentialsManager","url":"\/documentation\/auth0\/credentialsmanager","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"https://auth0.com/docs/api/authentication/refresh-token/refresh-token":{"type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/refresh-token\/refresh-token","title":"Authentication API Endpoint","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication\/refresh-token\/refresh-token"},"https://auth0.com/docs/secure/tokens/refresh-tokens":{"url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","title":"Refresh Tokens","type":"link","titleInlineContent":[{"type":"text","text":"Refresh Tokens"}],"identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/store(credentials:)":{"abstract":[{"type":"text","text":"Stores a "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","isActive":true},{"type":"text","text":" instance in the Keychain."}],"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/credentialsmanager\/store(credentials:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/store(credentials:)","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"store"},{"kind":"text","text":"("},{"kind":"externalParam","text":"credentials"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"title":"store(credentials:)"},"doc://com.auth0.Auth0/documentation/Auth0/RefreshTokens":{"url":"\/documentation\/auth0\/refreshtokens","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens","kind":"article","title":"Refresh Tokens: Common Errors","type":"topic","abstract":[],"role":"article"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"url":"\/documentation\/auth0\/credentials","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"role":"symbol","type":"topic","abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/credentials(withScope:minTTL:parameters:headers:)-7xldm":{"title":"credentials(withScope:minTTL:parameters:headers:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"credentials","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withScope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"text":"minTTL","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"text":", ","kind":"text"},{"text":"parameters","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","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"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"]) -> ","kind":"text"},{"text":"AnyPublisher","kind":"typeIdentifier","preciseIdentifier":"s:7Combine12AnyPublisherV"},{"text":"<","kind":"text"},{"text":"Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"text":", ","kind":"text"},{"text":"CredentialsManagerError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"},{"text":">","kind":"text"}],"url":"\/documentation\/auth0\/credentialsmanager\/credentials(withscope:minttl:parameters:headers:)-7xldm","abstract":[{"type":"text","text":"Retrieves credentials from the Keychain and automatically renews them using the refresh token if the access"},{"text":" ","type":"text"},{"text":"token is expired. Otherwise, the subscription will complete with the retrieved credentials as they are still","type":"text"},{"text":" ","type":"text"},{"text":"valid. Renewed credentials will be stored in the Keychain. ","type":"text"},{"type":"strong","inlineContent":[{"type":"text","text":"This method is thread-safe"}]},{"text":".","type":"text"}],"role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/credentials(withScope:minTTL:parameters:headers:)-7xldm","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"title":"cause","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","kind":"symbol","abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":"?"}],"role":"symbol","type":"topic"}}} \ No newline at end of file +{"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"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"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"? = nil, ","kind":"text"},{"text":"minTTL","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"text":" = 0, ","kind":"text"},{"kind":"externalParam","text":"parameters"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"text":"] = [:], ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"] = [:]) -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:7Combine12AnyPublisherV","text":"AnyPublisher"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","text":"Credentials"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","text":"CredentialsManagerError"},{"kind":"text","text":">"}]}]},{"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"},{"content":[{"type":"paragraph","inlineContent":[{"text":"Minimum time in seconds the access token must remain valid to avoid being renewed. Defaults to ","type":"text"},{"code":"0","type":"codeVoice"},{"text":".","type":"text"}]}],"name":"minTTL"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Additional parameters to use when renewing credentials."}]}],"name":"parameters"},{"content":[{"inlineContent":[{"type":"text","text":"Additional headers to use when renewing credentials."}],"type":"paragraph"}],"name":"headers"}],"kind":"parameters"},{"kind":"content","content":[{"type":"heading","text":"Return Value","anchor":"return-value","level":2},{"type":"paragraph","inlineContent":[{"type":"text","text":"A type-erased publisher."}]}]},{"kind":"content","content":[{"type":"heading","text":"Usage","anchor":"Usage","level":2},{"type":"codeListing","code":["credentialsManager"," .credentials()"," .sink(receiveCompletion: { completion in"," if case .failure(let error) = completion {"," print(\"Failed with: \\(error)\")"," }"," }, receiveValue: { credentials in"," print(\"Obtained credentials: \\(credentials)\")"," })"," .store(in: &cancellables)"],"syntax":"swift"},{"type":"paragraph","inlineContent":[{"type":"text","text":"To avoid retrieving access tokens with too little time left, enforce a minimum TTL (in seconds):"}]},{"type":"codeListing","code":["credentialsManager"," .credentials(minTTL: 60)"," .sink(receiveCompletion: { print($0) },"," receiveValue: { print($0) })"," .store(in: &cancellables)"],"syntax":"swift"},{"type":"paragraph","inlineContent":[{"text":"You can specify custom parameters or headers for the renewal request:","type":"text"}]},{"type":"codeListing","code":["credentialsManager"," .credentials(parameters: [\"key\": \"value\"],"," headers: [\"key\": \"value\"])"," .sink(receiveCompletion: { print($0) },"," receiveValue: { print($0) })"," .store(in: &cancellables)"],"syntax":"swift"},{"type":"paragraph","inlineContent":[{"type":"text","text":"When renewing credentials you can get a downscoped access token by requesting fewer scopes than were requested"},{"type":"text","text":" "},{"type":"text","text":"on login. If you specify fewer scopes, the credentials will be renewed immediately, regardless of whether they"},{"type":"text","text":" "},{"type":"text","text":"are expired or not."}]},{"type":"codeListing","code":["credentialsManager"," .credentials(scope: \"openid offline_access\")"," .sink(receiveCompletion: { print($0) },"," receiveValue: { print($0) })"," .store(in: &cancellables)"],"syntax":"swift"},{"content":[{"inlineContent":[{"type":"text","text":"The scope "},{"code":"offline_access","type":"codeVoice"},{"type":"text","text":" to have been requested on login to get a refresh token from Auth0. If"},{"type":"text","text":" "},{"type":"text","text":"the credentials are expired and there is no refresh token, the subscription will complete with a"},{"type":"text","text":" "},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken"},{"type":"text","text":" error."}],"type":"paragraph"}],"type":"aside","name":"Requires","style":"note"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Do not call "},{"code":"store(credentials:)","type":"codeVoice"},{"text":" afterward. The Credentials Manager automatically persists the","type":"text"},{"text":" ","type":"text"},{"text":"renewed credentials. Since this method is thread-safe and ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/store(credentials:)","isActive":true,"type":"reference"},{"type":"text","text":" is not, calling it anyway can"},{"type":"text","text":" "},{"type":"text","text":"cause concurrency issues."}]}],"type":"aside","name":"Warning","style":"warning"},{"content":[{"type":"paragraph","inlineContent":[{"text":"To ensure that no concurrent renewal requests get made, do not call this method from multiple","type":"text"},{"type":"text","text":" "},{"text":"Credentials Manager instances. The Credentials Manager cannot synchronize requests across instances.","type":"text"}]}],"type":"aside","name":"Important","style":"important"}]}],"sections":[],"abstract":[{"type":"text","text":"Retrieves credentials from the Keychain and automatically renews them using the refresh token if the access"},{"text":" ","type":"text"},{"type":"text","text":"token is expired. Otherwise, the subscription will complete with the retrieved credentials as they are still"},{"text":" ","type":"text"},{"text":"valid. Renewed credentials will be stored in the Keychain. ","type":"text"},{"type":"strong","inlineContent":[{"type":"text","text":"This method is thread-safe"}]},{"text":".","type":"text"}],"kind":"symbol","seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","https:\/\/auth0.com\/docs\/api\/authentication\/refresh-token\/refresh-token","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens"],"anchor":"Related-Documentation"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanager\/credentials(withscope:minttl:parameters:headers:)-7xldm"]}],"metadata":{"roleHeading":"Instance Method","symbolKind":"method","modules":[{"name":"Auth0"}],"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":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"minTTL"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"},{"kind":"text","text":", "},{"kind":"externalParam","text":"parameters"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"]) -> ","kind":"text"},{"preciseIdentifier":"s:7Combine12AnyPublisherV","text":"AnyPublisher","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"externalID":"s:5Auth018CredentialsManagerV11credentials9withScope6minTTL10parameters7headers7Combine12AnyPublisherVyAA0B0CAA0bC5ErrorVGSSSg_SiSDySSypGSDyS2SGtF","role":"symbol","extendedModule":"Auth0"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/credentials(withScope:minTTL:parameters:headers:)-7xldm"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/credentials(withScope:minTTL:parameters:headers:)-7xldm":{"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 automatically renews them using the refresh token if the access"},{"type":"text","text":" "},{"type":"text","text":"token is expired. Otherwise, the subscription will complete with the retrieved credentials as they are still"},{"type":"text","text":" "},{"type":"text","text":"valid. Renewed credentials will be stored in the Keychain. "},{"inlineContent":[{"type":"text","text":"This method is thread-safe"}],"type":"strong"},{"type":"text","text":"."}],"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"},{"text":"?, ","kind":"text"},{"text":"minTTL","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"parameters","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":"]) -> "},{"preciseIdentifier":"s:7Combine12AnyPublisherV","text":"AnyPublisher","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/credentials(withScope:minTTL:parameters:headers:)-7xldm","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"kind":"symbol","title":"cause","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier","text":"Error"},{"kind":"text","text":"?"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","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":"."}],"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"role":"symbol","title":"CredentialsManagerError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerError"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}],"abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","url":"\/documentation\/auth0\/credentialsmanagererror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/noRefreshToken":{"title":"noRefreshToken","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"noRefreshToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"}],"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":" "},{"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"}],"url":"\/documentation\/auth0\/credentialsmanagererror\/norefreshtoken"},"https://auth0.com/docs/api/authentication/refresh-token/refresh-token":{"titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication\/refresh-token\/refresh-token","type":"link","title":"Authentication API Endpoint","identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/refresh-token\/refresh-token"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"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/Credentials":{"title":"Credentials","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"Credentials","kind":"identifier"}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}]},"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","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"store"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"credentials"},{"kind":"text","text":": "},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","text":"Credentials"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"abstract":[{"type":"text","text":"Stores a "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","isActive":true},{"type":"text","text":" instance in the Keychain."}],"url":"\/documentation\/auth0\/credentialsmanager\/store(credentials:)"},"doc://com.auth0.Auth0/documentation/Auth0/RefreshTokens":{"title":"Refresh Tokens: Common Errors","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens","role":"article","kind":"article","abstract":[],"url":"\/documentation\/auth0\/refreshtokens"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"title":"CredentialsManager","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManager"}],"abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanager","navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentialsmanager/credentials(withscope:minttl:parameters:headers:callback:).json b/docs/data/documentation/auth0/credentialsmanager/credentials(withscope:minttl:parameters:headers:callback:).json index 8bd3efc59..e14f4bf6e 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":{"externalID":"s:5Auth018CredentialsManagerV11credentials9withScope6minTTL10parameters7headers8callbackySSSg_SiSDySSypGSDyS2SGys6ResultOyAA0B0CAA0bC5ErrorVGctF","symbolKind":"method","role":"symbol","modules":[{"name":"Auth0"}],"title":"credentials(withScope:minTTL:parameters:headers:callback:)","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"credentials"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withScope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"minTTL"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"kind":"text","text":", "},{"kind":"externalParam","text":"parameters"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"callback"},{"kind":"text","text":": ("},{"kind":"typeIdentifier","text":"CredentialsManagerResult","preciseIdentifier":"s:5Auth024CredentialsManagerResulta"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":">) -> "},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":")"}]},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/credentials(withScope:minTTL:parameters:headers:callback:)","interfaceLanguage":"swift"},"schemaVersion":{"patch":0,"major":0,"minor":3},"sections":[],"abstract":[{"text":"Retrieves credentials from the Keychain and automatically renews them using the refresh token if the access","type":"text"},{"text":" ","type":"text"},{"text":"token is expired. Otherwise, the retrieved credentials will be returned via the success case as they are still","type":"text"},{"text":" ","type":"text"},{"text":"valid. Renewed credentials will be stored in the Keychain. ","type":"text"},{"type":"strong","inlineContent":[{"text":"This method is thread-safe","type":"text"}]},{"text":".","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"credentials","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withScope","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"scope","kind":"internalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"? = nil, ","kind":"text"},{"text":"minTTL","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"text":" = 0, ","kind":"text"},{"text":"parameters","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"] = [:], ","kind":"text"},{"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"},{"text":"callback","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"@escaping","kind":"attribute"},{"text":" (","kind":"text"},{"preciseIdentifier":"s:5Auth024CredentialsManagerResulta","text":"CredentialsManagerResult","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerResult","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","kind":"typeIdentifier"},{"text":">) -> ","kind":"text"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"text":")","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]},{"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 "},{"type":"codeVoice","code":"nil"},{"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"},{"code":"0","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"}]},{"name":"parameters","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Additional parameters to use when renewing credentials."}]}]},{"name":"headers","content":[{"type":"paragraph","inlineContent":[{"text":"Additional headers to use when renewing credentials.","type":"text"}]}]},{"name":"callback","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"}]}]}]},{"kind":"content","content":[{"type":"heading","anchor":"Usage","text":"Usage","level":2},{"type":"codeListing","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":"paragraph","inlineContent":[{"type":"text","text":"To avoid retrieving access tokens with too little time left, enforce a minimum TTL (in seconds):"}]},{"type":"codeListing","syntax":"swift","code":["credentialsManager.credentials(minTTL: 60) { print($0) }"]},{"type":"paragraph","inlineContent":[{"type":"text","text":"You can specify custom parameters or headers for the renewal request:"}]},{"type":"codeListing","syntax":"swift","code":["credentialsManager.credentials(parameters: [\"key\": \"value\"],"," headers: [\"key\": \"value\"]) { print($0) }"]},{"type":"paragraph","inlineContent":[{"type":"text","text":"When renewing credentials you can get a downscoped access token by requesting fewer scopes than were requested"},{"type":"text","text":" "},{"type":"text","text":"on login. If you specify fewer scopes, the credentials will be renewed immediately, regardless of whether they"},{"type":"text","text":" "},{"type":"text","text":"are expired or not."}]},{"type":"codeListing","syntax":"swift","code":["credentialsManager.credentials(scope: \"openid offline_access\") { print($0) }"]},{"name":"Requires","type":"aside","content":[{"inlineContent":[{"type":"text","text":"The scope "},{"type":"codeVoice","code":"offline_access"},{"type":"text","text":" to have been requested on login to get a refresh token from Auth0. If"},{"type":"text","text":" "},{"type":"text","text":"the credentials are expired and there is no refresh token, the callback will be called with a"},{"type":"text","text":" "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken"},{"type":"text","text":" error."}],"type":"paragraph"}],"style":"note"},{"name":"Warning","type":"aside","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 "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/store(credentials:)"},{"type":"text","text":" is not, calling it anyway can"},{"type":"text","text":" "},{"type":"text","text":"cause concurrency issues."}],"type":"paragraph"}],"style":"warning"},{"name":"Important","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"}]}],"style":"important"}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanager\/credentials(withscope:minttl:parameters:headers:callback:)"]}],"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","https:\/\/auth0.com\/docs\/api\/authentication\/refresh-token\/refresh-token","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens"],"title":"Related Documentation","anchor":"Related-Documentation"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerResult":{"type":"topic","abstract":[{"type":"codeVoice","code":"Result"},{"type":"text","text":" wrapper for Credentials Manager operations."}],"kind":"symbol","role":"symbol","navigatorTitle":[{"text":"CredentialsManagerResult","kind":"identifier"}],"title":"CredentialsManagerResult","url":"\/documentation\/auth0\/credentialsmanagerresult","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerResult","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerResult"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManager","kind":"identifier"}],"navigatorTitle":[{"text":"CredentialsManager","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","abstract":[{"type":"text","text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain."}],"kind":"symbol","title":"CredentialsManager","url":"\/documentation\/auth0\/credentialsmanager","type":"topic"},"https://auth0.com/docs/api/authentication/refresh-token/refresh-token":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/refresh-token\/refresh-token","title":"Authentication API Endpoint","titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication\/refresh-token\/refresh-token","type":"link"},"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"}],"url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"url":"\/documentation\/auth0\/credentials","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"role":"symbol","type":"topic","abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/noRefreshToken":{"url":"\/documentation\/auth0\/credentialsmanagererror\/norefreshtoken","abstract":[{"type":"text","text":"The stored "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","isActive":true},{"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":"."}],"fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"noRefreshToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"}],"kind":"symbol","type":"topic","title":"noRefreshToken","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"title":"cause","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","kind":"symbol","abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":"?"}],"role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/store(credentials:)":{"abstract":[{"type":"text","text":"Stores a "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","isActive":true},{"type":"text","text":" instance in the Keychain."}],"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/credentialsmanager\/store(credentials:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/store(credentials:)","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"store"},{"kind":"text","text":"("},{"kind":"externalParam","text":"credentials"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"title":"store(credentials:)"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/credentials(withScope:minTTL:parameters:headers:callback:)":{"abstract":[{"type":"text","text":"Retrieves credentials from the Keychain and automatically renews them using the refresh token if the access"},{"type":"text","text":" "},{"type":"text","text":"token is expired. Otherwise, the retrieved credentials will be returned via the success case as they are still"},{"type":"text","text":" "},{"type":"text","text":"valid. Renewed credentials will be stored in the Keychain. "},{"type":"strong","inlineContent":[{"type":"text","text":"This method is thread-safe"}]},{"type":"text","text":"."}],"url":"\/documentation\/auth0\/credentialsmanager\/credentials(withscope:minttl:parameters:headers:callback:)","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/credentials(withScope:minTTL:parameters:headers:callback:)","title":"credentials(withScope:minTTL:parameters:headers:callback:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"credentials","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withScope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"text":"minTTL","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"text":", ","kind":"text"},{"text":"parameters","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","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"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"], ","kind":"text"},{"text":"callback","kind":"externalParam"},{"text":": (","kind":"text"},{"text":"CredentialsManagerResult","kind":"typeIdentifier","preciseIdentifier":"s:5Auth024CredentialsManagerResulta"},{"text":"<","kind":"text"},{"text":"Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"text":">) -> ","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":")","kind":"text"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/RefreshTokens":{"url":"\/documentation\/auth0\/refreshtokens","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens","kind":"article","title":"Refresh Tokens: Common Errors","type":"topic","abstract":[],"role":"article"}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanager\/credentials(withscope:minttl:parameters:headers:callback:)"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"abstract":[{"type":"text","text":"Retrieves credentials from the Keychain and automatically renews them using the refresh token if the access"},{"text":" ","type":"text"},{"type":"text","text":"token is expired. Otherwise, the retrieved credentials will be returned via the success case as they are still"},{"text":" ","type":"text"},{"type":"text","text":"valid. Renewed credentials will be stored in the Keychain. "},{"inlineContent":[{"type":"text","text":"This method is thread-safe"}],"type":"strong"},{"text":".","type":"text"}],"primaryContentSections":[{"declarations":[{"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"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"? = nil, ","kind":"text"},{"text":"minTTL","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"text":" = 0, ","kind":"text"},{"text":"parameters","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"] = [:], ","kind":"text"},{"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"},{"text":"callback","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"@escaping","kind":"attribute"},{"text":" (","kind":"text"},{"preciseIdentifier":"s:5Auth024CredentialsManagerResulta","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerResult","text":"CredentialsManagerResult","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","text":"Credentials","kind":"typeIdentifier"},{"text":">) -> ","kind":"text"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"text":")","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"},{"parameters":[{"content":[{"inlineContent":[{"text":"Space-separated list of scope values to request when renewing credentials. Defaults to ","type":"text"},{"type":"codeVoice","code":"nil"},{"text":", which will ask for the same scopes that were requested on login.","type":"text"}],"type":"paragraph"}],"name":"scope"},{"content":[{"inlineContent":[{"type":"text","text":"Minimum time in seconds the access token must remain valid to avoid being renewed. Defaults to "},{"type":"codeVoice","code":"0"},{"type":"text","text":"."}],"type":"paragraph"}],"name":"minTTL"},{"content":[{"inlineContent":[{"type":"text","text":"Additional parameters to use when renewing credentials."}],"type":"paragraph"}],"name":"parameters"},{"content":[{"inlineContent":[{"type":"text","text":"Additional headers to use when renewing credentials."}],"type":"paragraph"}],"name":"headers"},{"content":[{"inlineContent":[{"type":"text","text":"Callback that receives a "},{"type":"codeVoice","code":"Result"},{"type":"text","text":" containing either the user’s credentials or an error."}],"type":"paragraph"}],"name":"callback"}],"kind":"parameters"},{"content":[{"anchor":"Usage","level":2,"text":"Usage","type":"heading"},{"code":["credentialsManager.credentials { result in"," switch result {"," case .success(let credentials):"," print(\"Obtained credentials: \\(credentials)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }","}"],"syntax":"swift","type":"codeListing"},{"inlineContent":[{"text":"To avoid retrieving access tokens with too little time left, enforce a minimum TTL (in seconds):","type":"text"}],"type":"paragraph"},{"code":["credentialsManager.credentials(minTTL: 60) { print($0) }"],"syntax":"swift","type":"codeListing"},{"inlineContent":[{"text":"You can specify custom parameters or headers for the renewal request:","type":"text"}],"type":"paragraph"},{"code":["credentialsManager.credentials(parameters: [\"key\": \"value\"],"," headers: [\"key\": \"value\"]) { print($0) }"],"syntax":"swift","type":"codeListing"},{"inlineContent":[{"text":"When renewing credentials you can get a downscoped access token by requesting fewer scopes than were requested","type":"text"},{"text":" ","type":"text"},{"text":"on login. If you specify fewer scopes, the credentials will be renewed immediately, regardless of whether they","type":"text"},{"text":" ","type":"text"},{"text":"are expired or not.","type":"text"}],"type":"paragraph"},{"code":["credentialsManager.credentials(scope: \"openid offline_access\") { print($0) }"],"syntax":"swift","type":"codeListing"},{"content":[{"inlineContent":[{"type":"text","text":"The scope "},{"type":"codeVoice","code":"offline_access"},{"type":"text","text":" to have been requested on login to get a refresh token from Auth0. If"},{"type":"text","text":" "},{"type":"text","text":"the credentials are expired and there is no refresh token, the callback will be called with a"},{"type":"text","text":" "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken"},{"type":"text","text":" error."}],"type":"paragraph"}],"style":"note","name":"Requires","type":"aside"},{"content":[{"inlineContent":[{"type":"text","text":"Do not call "},{"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","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":"paragraph"}],"style":"warning","name":"Warning","type":"aside"},{"content":[{"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"}],"type":"paragraph"}],"style":"important","name":"Important","type":"aside"}],"kind":"content"}],"schemaVersion":{"minor":3,"patch":0,"major":0},"sections":[],"kind":"symbol","seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","https:\/\/auth0.com\/docs\/api\/authentication\/refresh-token\/refresh-token","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens"],"title":"Related Documentation","anchor":"Related-Documentation"}],"metadata":{"externalID":"s:5Auth018CredentialsManagerV11credentials9withScope6minTTL10parameters7headers8callbackySSSg_SiSDySSypGSDyS2SGys6ResultOyAA0B0CAA0bC5ErrorVGctF","modules":[{"name":"Auth0"}],"title":"credentials(withScope:minTTL:parameters:headers:callback:)","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"credentials","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withScope"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"minTTL","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"parameters","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"], ","kind":"text"},{"kind":"externalParam","text":"headers"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"], ","kind":"text"},{"text":"callback","kind":"externalParam"},{"text":": (","kind":"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"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"text":")","kind":"text"}],"roleHeading":"Instance Method","role":"symbol","symbolKind":"method"},"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":{"kind":"symbol","title":"cause","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier","text":"Error"},{"kind":"text","text":"?"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","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":"."}],"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi"},"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","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"store"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"credentials"},{"kind":"text","text":": "},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","text":"Credentials"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"abstract":[{"type":"text","text":"Stores a "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","isActive":true},{"type":"text","text":" instance in the Keychain."}],"url":"\/documentation\/auth0\/credentialsmanager\/store(credentials:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/credentials(withScope:minTTL:parameters:headers:callback:)":{"type":"topic","title":"credentials(withScope:minTTL:parameters:headers:callback:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/credentials(withScope:minTTL:parameters:headers:callback:)","kind":"symbol","abstract":[{"type":"text","text":"Retrieves credentials from the Keychain and automatically renews them using the refresh token if the access"},{"type":"text","text":" "},{"type":"text","text":"token is expired. Otherwise, the retrieved credentials will be returned via the success case as they are still"},{"type":"text","text":" "},{"type":"text","text":"valid. Renewed credentials will be stored in the Keychain. "},{"type":"strong","inlineContent":[{"type":"text","text":"This method is thread-safe"}]},{"type":"text","text":"."}],"url":"\/documentation\/auth0\/credentialsmanager\/credentials(withscope:minttl:parameters:headers:callback:)","role":"symbol","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"},{"text":"?, ","kind":"text"},{"text":"minTTL","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"parameters","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"], ","kind":"text"},{"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"},{"text":"callback","kind":"externalParam"},{"text":": (","kind":"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"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"text":")","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/RefreshTokens":{"title":"Refresh Tokens: Common Errors","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens","role":"article","kind":"article","abstract":[],"url":"\/documentation\/auth0\/refreshtokens"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/noRefreshToken":{"title":"noRefreshToken","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"noRefreshToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"}],"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":" "},{"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"}],"url":"\/documentation\/auth0\/credentialsmanagererror\/norefreshtoken"},"https://auth0.com/docs/secure/tokens/refresh-tokens":{"type":"link","titleInlineContent":[{"type":"text","text":"Refresh Tokens"}],"identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","title":"Refresh Tokens","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"title":"CredentialsManager","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManager"}],"abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanager","navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerResult":{"kind":"symbol","abstract":[{"code":"Result","type":"codeVoice"},{"text":" wrapper for Credentials Manager operations.","type":"text"}],"type":"topic","title":"CredentialsManagerResult","url":"\/documentation\/auth0\/credentialsmanagerresult","role":"symbol","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerResult"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerResult","navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerResult"}]},"https://auth0.com/docs/api/authentication/refresh-token/refresh-token":{"type":"link","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/refresh-token\/refresh-token","title":"Authentication API Endpoint","url":"https:\/\/auth0.com\/docs\/api\/authentication\/refresh-token\/refresh-token"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"Credentials","kind":"identifier"}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}]}}} \ 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 deleted file mode 100644 index e369f501e..000000000 --- a/docs/data/documentation/auth0/credentialsmanager/enablebiometrics(withtitle:canceltitle:fallbacktitle:evaluationpolicy:).json +++ /dev/null @@ -1 +0,0 @@ -{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanager\/enablebiometrics(withtitle:canceltitle:fallbacktitle:evaluationpolicy:)"]}],"schemaVersion":{"patch":0,"minor":3,"major":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"mutating","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"enableBiometrics","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withTitle","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"title","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"cancelTitle"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"? = nil, "},{"kind":"externalParam","text":"fallbackTitle"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"? = nil, "},{"kind":"externalParam","text":"evaluationPolicy"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:@E@LAPolicy","text":"LAPolicy"},{"kind":"text","text":" = .deviceOwnerAuthenticationWithBiometrics)"}],"platforms":["iOS"]}]},{"kind":"parameters","parameters":[{"name":"title","content":[{"inlineContent":[{"text":"Main message to display when Face ID or Touch ID is used.","type":"text"}],"type":"paragraph"}]},{"name":"cancelTitle","content":[{"type":"paragraph","inlineContent":[{"text":"Cancel message to display when Face ID or Touch ID is used.","type":"text"}]}]},{"name":"fallbackTitle","content":[{"type":"paragraph","inlineContent":[{"text":"Fallback message to display when Face ID or Touch ID is used after a failed match.","type":"text"}]}]},{"name":"evaluationPolicy","content":[{"inlineContent":[{"type":"text","text":"Policy to be used for authentication policy evaluation."}],"type":"paragraph"}]}]},{"kind":"content","content":[{"level":2,"type":"heading","text":"Usage","anchor":"Usage"},{"syntax":"swift","code":["credentialsManager.enableBiometrics(withTitle: \"Unlock with Face ID\")"],"type":"codeListing"},{"inlineContent":[{"type":"text","text":"If needed, you can specify a particular "},{"type":"codeVoice","code":"LAPolicy"},{"type":"text","text":" to be used. For example, you might want to support Face ID or"},{"type":"text","text":" "},{"type":"text","text":"Touch ID, but also allow fallback to passcode."}],"type":"paragraph"},{"syntax":"swift","code":["credentialsManager.enableBiometrics(withTitle: \"Unlock with Face ID or passcode\", "," evaluationPolicy: .deviceOwnerAuthentication)"],"type":"codeListing"},{"style":"important","name":"Important","type":"aside","content":[{"inlineContent":[{"text":"Access to the ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/user","type":"reference"},{"text":" property will not be protected by biometric authentication.","type":"text"}],"type":"paragraph"}]}]}],"metadata":{"externalID":"s:5Auth018CredentialsManagerV16enableBiometrics9withTitle06cancelG008fallbackG016evaluationPolicyySS_SSSgAISo8LAPolicyVtF","role":"symbol","symbolKind":"method","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"enableBiometrics"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withTitle"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"cancelTitle","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"fallbackTitle","kind":"externalParam"},{"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"}],"roleHeading":"Instance Method","title":"enableBiometrics(withTitle:cancelTitle:fallbackTitle:evaluationPolicy:)"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/enableBiometrics(withTitle:cancelTitle:fallbackTitle:evaluationPolicy:)"},"sections":[],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"abstract":[{"type":"text","text":"Enables biometric authentication for additional security during credentials retrieval."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManager","kind":"identifier"}],"navigatorTitle":[{"text":"CredentialsManager","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","abstract":[{"type":"text","text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain."}],"kind":"symbol","title":"CredentialsManager","url":"\/documentation\/auth0\/credentialsmanager","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/enableBiometrics(withTitle:cancelTitle:fallbackTitle:evaluationPolicy:)":{"url":"\/documentation\/auth0\/credentialsmanager\/enablebiometrics(withtitle:canceltitle:fallbacktitle:evaluationpolicy:)","kind":"symbol","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:)","title":"enableBiometrics(withTitle:cancelTitle:fallbackTitle:evaluationPolicy:)","type":"topic","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"enableBiometrics","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withTitle","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"cancelTitle","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"fallbackTitle","kind":"externalParam"},{"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"}],"role":"symbol"},"https://auth0.com/docs/secure/tokens/id-tokens":{"identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens","title":"ID token","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens","titleInlineContent":[{"type":"text","text":"ID token"}],"type":"link"},"doc://com.auth0.Auth0/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."},{"type":"text","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"},{"type":"text","text":"."}],"title":"user","url":"\/documentation\/auth0\/credentialsmanager\/user","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"user","kind":"identifier"},{"text":": ","kind":"text"},{"text":"UserInfo","kind":"typeIdentifier","preciseIdentifier":"s:5Auth08UserInfoV"},{"text":"?","kind":"text"}],"type":"topic","kind":"symbol","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentialsmanager/enablebiometrics(withtitle:canceltitle:fallbacktitle:evaluationpolicy:policy:).json b/docs/data/documentation/auth0/credentialsmanager/enablebiometrics(withtitle:canceltitle:fallbacktitle:evaluationpolicy:policy:).json new file mode 100644 index 000000000..6a42c575b --- /dev/null +++ b/docs/data/documentation/auth0/credentialsmanager/enablebiometrics(withtitle:canceltitle:fallbacktitle:evaluationpolicy:policy:).json @@ -0,0 +1 @@ +{"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/enableBiometrics(withTitle:cancelTitle:fallbackTitle:evaluationPolicy:policy:)"},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"mutating","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"enableBiometrics","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withTitle","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"title","kind":"internalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"cancelTitle"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"? = nil, "},{"kind":"externalParam","text":"fallbackTitle"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"? = nil, ","kind":"text"},{"text":"evaluationPolicy","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:@E@LAPolicy","text":"LAPolicy","kind":"typeIdentifier"},{"kind":"text","text":" = .deviceOwnerAuthenticationWithBiometrics, "},{"kind":"externalParam","text":"policy"},{"kind":"text","text":": "},{"text":"BiometricPolicy","preciseIdentifier":"s:5Auth015BiometricPolicyO","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/BiometricPolicy","kind":"typeIdentifier"},{"kind":"text","text":" = .default)"}]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"title","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Main message to display when Face ID or Touch ID is used."}]}]},{"name":"cancelTitle","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Cancel message to display when Face ID or Touch ID is used."}]}]},{"name":"fallbackTitle","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Fallback message to display when Face ID or Touch ID is used after a failed match."}]}]},{"name":"evaluationPolicy","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Policy to be used for authentication policy evaluation."}]}]},{"name":"policy","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/BiometricPolicy"},{"type":"text","text":" that controls when biometric authentication is required. Defaults to "},{"type":"codeVoice","code":".default"},{"type":"text","text":"."}]}]}]},{"content":[{"anchor":"Usage","text":"Usage","type":"heading","level":2},{"syntax":"swift","type":"codeListing","code":["credentialsManager.enableBiometrics(withTitle: \"Unlock with Face ID\")"]},{"inlineContent":[{"text":"If needed, you can specify a particular ","type":"text"},{"code":"LAPolicy","type":"codeVoice"},{"text":" to be used. For example, you might want to support Face ID or","type":"text"},{"text":" ","type":"text"},{"text":"Touch ID, but also allow fallback to passcode.","type":"text"}],"type":"paragraph"},{"syntax":"swift","type":"codeListing","code":["credentialsManager.enableBiometrics(withTitle: \"Unlock with Face ID or passcode\", "," evaluationPolicy: .deviceOwnerAuthentication)"]},{"inlineContent":[{"text":"You can also configure a ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/BiometricPolicy","type":"reference"},{"text":" to control when biometric authentication is required:","type":"text"}],"type":"paragraph"},{"syntax":"swift","type":"codeListing","code":["\/\/ Require authentication only once per 5-minute session","credentialsManager.enableBiometrics(withTitle: \"Unlock with Face ID\","," policy: .session(timeoutInSeconds: 300))"]},{"name":"Important","type":"aside","style":"important","content":[{"inlineContent":[{"text":"Access to the ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/user","type":"reference","isActive":true},{"text":" property will not be protected by biometric authentication.","type":"text"}],"type":"paragraph"}]}],"kind":"content"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanager\/enablebiometrics(withtitle:canceltitle:fallbacktitle:evaluationpolicy:policy:)"]}],"kind":"symbol","metadata":{"modules":[{"name":"Auth0"}],"title":"enableBiometrics(withTitle:cancelTitle:fallbackTitle:evaluationPolicy:policy:)","roleHeading":"Instance Method","symbolKind":"method","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"enableBiometrics"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withTitle"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"cancelTitle"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"fallbackTitle"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"evaluationPolicy"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"LAPolicy","preciseIdentifier":"c:@E@LAPolicy"},{"kind":"text","text":", "},{"kind":"externalParam","text":"policy"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"BiometricPolicy","preciseIdentifier":"s:5Auth015BiometricPolicyO"},{"kind":"text","text":")"}],"externalID":"s:5Auth018CredentialsManagerV16enableBiometrics9withTitle06cancelG008fallbackG016evaluationPolicy6policyySS_SSSgAJSo8LAPolicyVAA09BiometricK0OtF"},"schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"type":"text","text":"Enables biometric authentication for additional security during credentials retrieval."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"title":"CredentialsManager","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManager"}],"abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanager","navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}]},"https://auth0.com/docs/secure/tokens/id-tokens":{"title":"ID token","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens","type":"link","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens","titleInlineContent":[{"type":"text","text":"ID token"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/user":{"kind":"symbol","abstract":[{"text":"Retrieves the user information from the Keychain synchronously, without checking if the credentials are expired.","type":"text"},{"text":" ","type":"text"},{"text":"The user information is read from the stored ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens","isActive":true,"type":"reference"},{"type":"text","text":"."}],"type":"topic","title":"user","url":"\/documentation\/auth0\/credentialsmanager\/user","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"user","kind":"identifier"},{"text":": ","kind":"text"},{"text":"UserInfo","preciseIdentifier":"s:5Auth08UserInfoV","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/user"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/enableBiometrics(withTitle:cancelTitle:fallbackTitle:evaluationPolicy:policy:)":{"title":"enableBiometrics(withTitle:cancelTitle:fallbackTitle:evaluationPolicy:policy:)","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/enableBiometrics(withTitle:cancelTitle:fallbackTitle:evaluationPolicy:policy:)","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"enableBiometrics"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withTitle"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"text":"cancelTitle","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"fallbackTitle"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"evaluationPolicy"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:@E@LAPolicy","text":"LAPolicy"},{"kind":"text","text":", "},{"text":"policy","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015BiometricPolicyO","text":"BiometricPolicy"},{"kind":"text","text":")"}],"abstract":[{"type":"text","text":"Enables biometric authentication for additional security during credentials retrieval."}],"url":"\/documentation\/auth0\/credentialsmanager\/enablebiometrics(withtitle:canceltitle:fallbacktitle:evaluationpolicy:policy:)"},"doc://com.auth0.Auth0/documentation/Auth0/BiometricPolicy":{"kind":"symbol","abstract":[{"text":"Defines the policy for when a biometric prompt should be shown when using the Credentials Manager.","type":"text"}],"type":"topic","url":"\/documentation\/auth0\/biometricpolicy","title":"BiometricPolicy","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"BiometricPolicy","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/BiometricPolicy","navigatorTitle":[{"text":"BiometricPolicy","kind":"identifier"}]}}} \ 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 92b4fa6c3..7aa23292d 100644 --- a/docs/data/documentation/auth0/credentialsmanager/hasvalid(minttl:).json +++ b/docs/data/documentation/auth0/credentialsmanager/hasvalid(minttl:).json @@ -1 +1 @@ -{"kind":"symbol","primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"hasValid"},{"kind":"text","text":"("},{"kind":"externalParam","text":"minTTL"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"},{"kind":"text","text":" = 0) -> "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}]}],"kind":"declarations"},{"parameters":[{"name":"minTTL","content":[{"type":"paragraph","inlineContent":[{"text":"Minimum lifetime in seconds the access token must have left. Defaults to ","type":"text"},{"code":"0","type":"codeVoice"},{"text":".","type":"text"}]}]}],"kind":"parameters"},{"content":[{"level":2,"anchor":"return-value","text":"Return Value","type":"heading"},{"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":[{"text":"Usage","anchor":"Usage","type":"heading","level":2},{"syntax":"swift","type":"codeListing","code":["guard credentialsManager.hasValid() else {"," \/\/ No valid credentials exist, present the login page","}","\/\/ Retrieve the stored credentials"]}],"kind":"content"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/hasValid(minTTL:)"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanager\/hasvalid(minttl:)"]}],"metadata":{"title":"hasValid(minTTL:)","roleHeading":"Instance Method","symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"hasValid","kind":"identifier"},{"text":"(","kind":"text"},{"text":"minTTL","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"externalID":"s:5Auth018CredentialsManagerV8hasValid6minTTLSbSi_tF","modules":[{"name":"Auth0"}],"role":"symbol"},"schemaVersion":{"minor":3,"major":0,"patch":0},"seeAlsoSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/expiresIn"],"title":"Related Documentation","anchor":"Related-Documentation"}],"abstract":[{"text":"Checks that there are credentials stored, and that the access token has not expired and will not expire within","type":"text"},{"text":" ","type":"text"},{"text":"the specified TTL. If you are not using refresh tokens, use this method instead of ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/canRenew()","type":"reference","isActive":true},{"text":" to","type":"text"},{"text":" ","type":"text"},{"text":"check for stored credentials when your app starts up.","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManager","kind":"identifier"}],"navigatorTitle":[{"text":"CredentialsManager","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","abstract":[{"type":"text","text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain."}],"kind":"symbol","title":"CredentialsManager","url":"\/documentation\/auth0\/credentialsmanager","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/expiresIn":{"url":"\/documentation\/auth0\/credentials\/expiresin","role":"symbol","title":"expiresIn","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/expiresIn","kind":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"expiresIn","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation4DateV","text":"Date","kind":"typeIdentifier"}],"type":"topic","abstract":[{"text":"When the access token expires.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/canRenew()":{"kind":"symbol","url":"\/documentation\/auth0\/credentialsmanager\/canrenew()","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/canRenew()","title":"canRenew()","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"canRenew","kind":"identifier"},{"text":"() -> ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"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","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/hasValid(minTTL:)","isActive":true},{"type":"text","text":" to check for stored credentials when your app"},{"type":"text","text":" "},{"type":"text","text":"starts up."}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/hasValid(minTTL:)":{"url":"\/documentation\/auth0\/credentialsmanager\/hasvalid(minttl:)","abstract":[{"text":"Checks that there are credentials stored, and that the access token has not expired and will not expire within","type":"text"},{"text":" ","type":"text"},{"text":"the specified TTL. If you are not using refresh tokens, use this method instead of ","type":"text"},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/canRenew()"},{"text":" to","type":"text"},{"text":" ","type":"text"},{"text":"check for stored credentials when your app starts up.","type":"text"}],"role":"symbol","title":"hasValid(minTTL:)","type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/hasValid(minTTL:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"hasValid","kind":"identifier"},{"text":"(","kind":"text"},{"text":"minTTL","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}]}}} \ No newline at end of file +{"metadata":{"symbolKind":"method","roleHeading":"Instance Method","externalID":"s:5Auth018CredentialsManagerV8hasValid6minTTLSbSi_tF","title":"hasValid(minTTL:)","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"hasValid"},{"kind":"text","text":"("},{"kind":"externalParam","text":"minTTL"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"role":"symbol"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanager\/hasvalid(minttl:)"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/hasValid(minTTL:)","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"type":"text","text":"Checks that there are credentials stored, and that the access token has not expired and will not expire within"},{"type":"text","text":" "},{"type":"text","text":"the specified TTL. If you are not using refresh tokens, use this method instead of "},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/canRenew()"},{"type":"text","text":" to"},{"type":"text","text":" "},{"type":"text","text":"check for stored credentials when your app starts up."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"seeAlsoSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/expiresIn"],"title":"Related Documentation","anchor":"Related-Documentation"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"hasValid","kind":"identifier"},{"text":"(","kind":"text"},{"text":"minTTL","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Int","preciseIdentifier":"s:Si","kind":"typeIdentifier"},{"text":" = 0) -> ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"platforms":["iOS"],"languages":["swift"]}]},{"parameters":[{"content":[{"inlineContent":[{"text":"Minimum lifetime in seconds the access token must have left. Defaults to ","type":"text"},{"code":"0","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"}],"name":"minTTL"}],"kind":"parameters"},{"content":[{"level":2,"type":"heading","anchor":"return-value","text":"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":[{"level":2,"type":"heading","anchor":"Usage","text":"Usage"},{"type":"codeListing","syntax":"swift","code":["guard credentialsManager.hasValid() else {"," \/\/ No valid credentials exist, present the login page","}","\/\/ Retrieve the stored credentials"]}],"kind":"content"}],"schemaVersion":{"patch":0,"minor":3,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/hasValid(minTTL:)":{"kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"hasValid"},{"kind":"text","text":"("},{"text":"minTTL","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Int","preciseIdentifier":"s:Si","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"title":"hasValid(minTTL:)","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Checks that there are credentials stored, and that the access token has not expired and will not expire within"},{"type":"text","text":" "},{"type":"text","text":"the specified TTL. If you are not using refresh tokens, use this method instead of "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/canRenew()","isActive":true},{"type":"text","text":" to"},{"type":"text","text":" "},{"type":"text","text":"check for stored credentials when your app starts up."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/hasValid(minTTL:)","url":"\/documentation\/auth0\/credentialsmanager\/hasvalid(minttl:)"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/canRenew()":{"url":"\/documentation\/auth0\/credentialsmanager\/canrenew()","abstract":[{"type":"text","text":"Checks that there are credentials stored, and that the credentials contain a refresh token. If you are using"},{"type":"text","text":" "},{"type":"text","text":"refresh tokens, use this method instead of "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/hasValid(minTTL:)","isActive":true},{"type":"text","text":" to check for stored credentials when your app"},{"type":"text","text":" "},{"type":"text","text":"starts up."}],"title":"canRenew()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"canRenew"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/canRenew()","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"title":"CredentialsManager","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManager"}],"abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanager","navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/expiresIn":{"kind":"symbol","title":"expiresIn","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"expiresIn","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation4DateV","text":"Date","kind":"typeIdentifier"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/expiresIn","abstract":[{"text":"When the access token expires.","type":"text"}],"url":"\/documentation\/auth0\/credentials\/expiresin"}}} \ 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 43a437c55..2cef806fe 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 @@ -{"sections":[],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"init","kind":"keyword"},{"text":"(","kind":"text"},{"text":"authentication","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth014AuthenticationP","text":"Authentication","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication"},{"text":", ","kind":"text"},{"text":"storeKey","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" = \"credentials\", ","kind":"text"},{"text":"storage","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"CredentialsStorage","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","preciseIdentifier":"s:5Auth018CredentialsStorageP"},{"text":" = SimpleKeychain())","kind":"text"}]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"authentication","content":[{"type":"paragraph","inlineContent":[{"text":"Auth0 Authentication API client.","type":"text"}]}]},{"name":"storeKey","content":[{"inlineContent":[{"text":"Key used to store user credentials in the Keychain. Defaults to ‘credentials’.","type":"text"}],"type":"paragraph"}]},{"name":"storage","content":[{"inlineContent":[{"text":"The ","type":"text"},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage"},{"text":" instance used to manage credentials storage. Defaults to a standard ","type":"text"},{"code":"SimpleKeychain","type":"codeVoice"},{"text":" instance.","type":"text"}],"type":"paragraph"}]}]}],"metadata":{"externalID":"s:5Auth018CredentialsManagerV14authentication8storeKey7storageAcA14Authentication_p_SSAA0B7Storage_ptcfc","modules":[{"name":"Auth0"}],"role":"symbol","symbolKind":"init","title":"init(authentication:storeKey:storage:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"authentication"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Authentication","preciseIdentifier":"s:5Auth014AuthenticationP"},{"kind":"text","text":", "},{"kind":"externalParam","text":"storeKey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"storage"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CredentialsStorage","preciseIdentifier":"s:5Auth018CredentialsStorageP"},{"kind":"text","text":")"}],"roleHeading":"Initializer"},"abstract":[{"type":"text","text":"Creates a new "},{"type":"codeVoice","code":"CredentialsManager"},{"type":"text","text":" instance."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/init(authentication:storeKey:storage:)","interfaceLanguage":"swift"},"schemaVersion":{"minor":3,"patch":0,"major":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanager\/init(authentication:storekey:storage:)"]}],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage":{"title":"CredentialsStorage","kind":"symbol","navigatorTitle":[{"text":"CredentialsStorage","kind":"identifier"}],"role":"symbol","url":"\/documentation\/auth0\/credentialsstorage","abstract":[{"text":"Generic storage API for storing credentials.","type":"text"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsStorage","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManager","kind":"identifier"}],"navigatorTitle":[{"text":"CredentialsManager","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","abstract":[{"type":"text","text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain."}],"kind":"symbol","title":"CredentialsManager","url":"\/documentation\/auth0\/credentialsmanager","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/init(authentication:storeKey:storage:)":{"fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"authentication","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Authentication","kind":"typeIdentifier","preciseIdentifier":"s:5Auth014AuthenticationP"},{"text":", ","kind":"text"},{"text":"storeKey","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"storage","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"CredentialsStorage","kind":"typeIdentifier","preciseIdentifier":"s:5Auth018CredentialsStorageP"},{"text":")","kind":"text"}],"type":"topic","title":"init(authentication:storeKey:storage:)","url":"\/documentation\/auth0\/credentialsmanager\/init(authentication:storekey:storage:)","role":"symbol","abstract":[{"type":"text","text":"Creates a new "},{"type":"codeVoice","code":"CredentialsManager"},{"text":" instance.","type":"text"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/init(authentication:storeKey:storage:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"type":"topic","role":"symbol","title":"Authentication","abstract":[{"text":"Client for the ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"text":".","type":"text"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"https://auth0.com/docs/api/authentication":{"type":"link","title":"Auth0 Authentication API","titleInlineContent":[{"text":"Auth0 Authentication API","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication","identifier":"https:\/\/auth0.com\/docs\/api\/authentication"}}} \ No newline at end of file +{"metadata":{"symbolKind":"init","title":"init(authentication:storeKey:storage:)","externalID":"s:5Auth018CredentialsManagerV14authentication8storeKey7storageAcA14Authentication_p_SSAA0B7Storage_ptcfc","roleHeading":"Initializer","modules":[{"name":"Auth0"}],"fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"authentication"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Authentication","preciseIdentifier":"s:5Auth014AuthenticationP"},{"kind":"text","text":", "},{"kind":"externalParam","text":"storeKey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"storage"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CredentialsStorage","preciseIdentifier":"s:5Auth018CredentialsStorageP"},{"kind":"text","text":")"}],"role":"symbol"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanager\/init(authentication:storekey:storage:)"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/init(authentication:storeKey:storage:)","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"type":"text","text":"Creates a new "},{"type":"codeVoice","code":"CredentialsManager"},{"type":"text","text":" instance."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"authentication"},{"kind":"text","text":": "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","kind":"typeIdentifier","text":"Authentication","preciseIdentifier":"s:5Auth014AuthenticationP"},{"kind":"text","text":", "},{"kind":"externalParam","text":"storeKey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" = \"credentials\", "},{"kind":"externalParam","text":"storage"},{"kind":"text","text":": "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","kind":"typeIdentifier","text":"CredentialsStorage","preciseIdentifier":"s:5Auth018CredentialsStorageP"},{"kind":"text","text":" = SimpleKeychain())"}]}],"kind":"declarations"},{"parameters":[{"content":[{"inlineContent":[{"text":"Auth0 Authentication API client.","type":"text"}],"type":"paragraph"}],"name":"authentication"},{"content":[{"inlineContent":[{"text":"Key used to store user credentials in the Keychain. Defaults to ‘credentials’.","type":"text"}],"type":"paragraph"}],"name":"storeKey"},{"content":[{"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"},{"code":"SimpleKeychain","type":"codeVoice"},{"text":" instance.","type":"text"}],"type":"paragraph"}],"name":"storage"}],"kind":"parameters"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/init(authentication:storeKey:storage:)":{"url":"\/documentation\/auth0\/credentialsmanager\/init(authentication:storekey:storage:)","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"authentication","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Authentication","preciseIdentifier":"s:5Auth014AuthenticationP","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"storeKey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"storage"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CredentialsStorage","preciseIdentifier":"s:5Auth018CredentialsStorageP"},{"kind":"text","text":")"}],"title":"init(authentication:storeKey:storage:)","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Creates a new "},{"type":"codeVoice","code":"CredentialsManager"},{"type":"text","text":" instance."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/init(authentication:storeKey:storage:)","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","abstract":[{"type":"text","text":"Client for the "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","isActive":true},{"type":"text","text":"."}],"type":"topic","title":"Authentication","url":"\/documentation\/auth0\/authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"https://auth0.com/docs/api/authentication":{"title":"Auth0 Authentication API","url":"https:\/\/auth0.com\/docs\/api\/authentication","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"title":"CredentialsManager","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManager"}],"abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanager","navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage":{"title":"CredentialsStorage","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","role":"symbol","kind":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsStorage","kind":"identifier"}],"abstract":[{"text":"Generic storage API for storing credentials.","type":"text"}],"url":"\/documentation\/auth0\/credentialsstorage","navigatorTitle":[{"text":"CredentialsStorage","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentialsmanager/isbiometricsessionvalid().json b/docs/data/documentation/auth0/credentialsmanager/isbiometricsessionvalid().json new file mode 100644 index 000000000..432767959 --- /dev/null +++ b/docs/data/documentation/auth0/credentialsmanager/isbiometricsessionvalid().json @@ -0,0 +1 @@ +{"metadata":{"externalID":"s:5Auth018CredentialsManagerV23isBiometricSessionValidSbyF","symbolKind":"method","title":"isBiometricSessionValid()","role":"symbol","roleHeading":"Instance Method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isBiometricSessionValid","kind":"identifier"},{"text":"() -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"modules":[{"name":"Auth0"}]},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanager\/isbiometricsessionvalid()"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/isBiometricSessionValid()","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"type":"text","text":"Checks if the current biometric session is valid based on the configured policy."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"isBiometricSessionValid","kind":"identifier"},{"text":"() -> ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}]}],"kind":"declarations"},{"content":[{"type":"heading","anchor":"return-value","level":2,"text":"Return Value"},{"type":"paragraph","inlineContent":[{"text":"","type":"text"},{"code":"true","type":"codeVoice"},{"text":" if the session is valid and biometric authentication can be skipped, ","type":"text"},{"type":"codeVoice","code":"false"},{"type":"text","text":" otherwise."}]}],"kind":"content"},{"kind":"content","content":[{"type":"heading","text":"Usage","anchor":"Usage","level":2},{"type":"codeListing","code":["let isValid = credentialsManager.isBiometricSessionValid()"],"syntax":"swift"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"title":"CredentialsManager","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManager"}],"abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanager","navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/isBiometricSessionValid()":{"url":"\/documentation\/auth0\/credentialsmanager\/isbiometricsessionvalid()","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"isBiometricSessionValid"},{"kind":"text","text":"() -> "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"title":"isBiometricSessionValid()","type":"topic","role":"symbol","abstract":[{"text":"Checks if the current biometric session is valid based on the configured policy.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/isBiometricSessionValid()","kind":"symbol"}}} \ 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 2e1c063e7..459c41eba 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 @@ -{"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"metadata":{"title":"renew(parameters:headers:)","role":"symbol","modules":[{"name":"Auth0"}],"externalID":"s:5Auth018CredentialsManagerV5renew10parameters7headersAA0B0CSDySSypG_SDyS2SGtYaKF","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"renew"},{"kind":"text","text":"("},{"kind":"externalParam","text":"parameters"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"}],"extendedModule":"Auth0","roleHeading":"Instance Method","symbolKind":"method"},"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","https:\/\/auth0.com\/docs\/api\/authentication\/refresh-token\/refresh-token","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens"],"anchor":"Related-Documentation"}],"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:)-3jl3m","interfaceLanguage":"swift"},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"renew","kind":"identifier"},{"text":"(","kind":"text"},{"text":"parameters","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"] = [:], ","kind":"text"},{"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"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"},{"parameters":[{"name":"parameters","content":[{"type":"paragraph","inlineContent":[{"text":"Additional parameters to use.","type":"text"}]}]},{"name":"headers","content":[{"type":"paragraph","inlineContent":[{"text":"Additional headers to use.","type":"text"}]}]}],"kind":"parameters"},{"content":[{"type":"heading","text":"Usage","anchor":"Usage","level":2},{"type":"codeListing","syntax":"swift","code":["do {"," let credentials = try await credentialsManager.renew()"," print(\"Renewed credentials: \\(credentials)\")","} catch {"," print(\"Failed with: \\(error)\")","}"]},{"type":"paragraph","inlineContent":[{"type":"text","text":"You can specify custom parameters or headers for the renewal request:"}]},{"type":"codeListing","syntax":"swift","code":["let credentials = try await credentialsManager.renew(parameters: [\"key\": \"value\"],"," headers: [\"key\": \"value\"])"]},{"name":"Requires","type":"aside","style":"note","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The scope "},{"type":"codeVoice","code":"offline_access"},{"type":"text","text":" to have been requested on login to get a refresh token from Auth0. If"},{"type":"text","text":" "},{"type":"text","text":"there is no refresh token, a "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken","isActive":true},{"type":"text","text":" error will be thrown."}]}]},{"name":"Warning","type":"aside","style":"warning","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Do not call "},{"type":"codeVoice","code":"store(credentials:)"},{"type":"text","text":" afterward. The Credentials Manager automatically persists the"},{"type":"text","text":" "},{"type":"text","text":"renewed credentials. Since this method is thread-safe and "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/store(credentials:)","isActive":true},{"type":"text","text":" is not, calling it anyway can"},{"type":"text","text":" "},{"type":"text","text":"cause concurrency issues."}]}]},{"name":"Important","type":"aside","style":"important","content":[{"inlineContent":[{"type":"text","text":"To ensure that no concurrent renewal requests get made, do not call this method from multiple"},{"type":"text","text":" "},{"type":"text","text":"Credentials Manager instances. The Credentials Manager cannot synchronize requests across instances."}],"type":"paragraph"}]}],"kind":"content"}],"kind":"symbol","abstract":[{"type":"text","text":"Renews credentials using the refresh token and stores them in the Keychain. "},{"type":"strong","inlineContent":[{"type":"text","text":"This method is thread-safe"}]},{"type":"text","text":"."}],"variants":[{"paths":["\/documentation\/auth0\/credentialsmanager\/renew(parameters:headers:)-3jl3m"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"url":"\/documentation\/auth0\/credentials","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"role":"symbol","type":"topic","abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"title":"cause","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","kind":"symbol","abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":"?"}],"role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/renew(parameters:headers:)-3jl3m":{"title":"renew(parameters:headers:)","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"}],"kind":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/renew(parameters:headers:)-3jl3m","url":"\/documentation\/auth0\/credentialsmanager\/renew(parameters:headers:)-3jl3m","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"renew"},{"kind":"text","text":"("},{"kind":"externalParam","text":"parameters"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManager","kind":"identifier"}],"navigatorTitle":[{"text":"CredentialsManager","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","abstract":[{"type":"text","text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain."}],"kind":"symbol","title":"CredentialsManager","url":"\/documentation\/auth0\/credentialsmanager","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/store(credentials:)":{"abstract":[{"type":"text","text":"Stores a "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","isActive":true},{"type":"text","text":" instance in the Keychain."}],"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/credentialsmanager\/store(credentials:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/store(credentials:)","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"store"},{"kind":"text","text":"("},{"kind":"externalParam","text":"credentials"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"title":"store(credentials:)"},"https://auth0.com/docs/api/authentication/refresh-token/refresh-token":{"type":"link","url":"https:\/\/auth0.com\/docs\/api\/authentication\/refresh-token\/refresh-token","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"title":"Authentication API Endpoint","identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/refresh-token\/refresh-token"},"doc://com.auth0.Auth0/documentation/Auth0/RefreshTokens":{"url":"\/documentation\/auth0\/refreshtokens","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens","kind":"article","title":"Refresh Tokens: Common Errors","type":"topic","abstract":[],"role":"article"},"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","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/noRefreshToken":{"url":"\/documentation\/auth0\/credentialsmanagererror\/norefreshtoken","abstract":[{"type":"text","text":"The stored "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","isActive":true},{"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":"."}],"fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"noRefreshToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"}],"kind":"symbol","type":"topic","title":"noRefreshToken","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken"}}} \ No newline at end of file +{"metadata":{"symbolKind":"method","title":"renew(parameters:headers:)","externalID":"s:5Auth018CredentialsManagerV5renew10parameters7headersAA0B0CSDySSypG_SDyS2SGtYaKF","extendedModule":"Auth0","roleHeading":"Instance Method","modules":[{"name":"Auth0"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"renew","kind":"identifier"},{"text":"(","kind":"text"},{"text":"parameters","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"], ","kind":"text"},{"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"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"}],"role":"symbol"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanager\/renew(parameters:headers:)-3jl3m"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/renew(parameters:headers:)-3jl3m"},"kind":"symbol","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"}]},{"type":"text","text":"."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","https:\/\/auth0.com\/docs\/api\/authentication\/refresh-token\/refresh-token","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens"],"anchor":"Related-Documentation"}],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"renew"},{"kind":"text","text":"("},{"kind":"externalParam","text":"parameters"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"] = [:], "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"] = [:]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"parameters","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Additional parameters to use."}]}]},{"name":"headers","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Additional headers to use."}]}]}]},{"kind":"content","content":[{"type":"heading","level":2,"text":"Usage","anchor":"Usage"},{"type":"codeListing","syntax":"swift","code":["do {"," let credentials = try await credentialsManager.renew()"," print(\"Renewed credentials: \\(credentials)\")","} catch {"," print(\"Failed with: \\(error)\")","}"]},{"inlineContent":[{"type":"text","text":"You can specify custom parameters or headers for the renewal request:"}],"type":"paragraph"},{"type":"codeListing","syntax":"swift","code":["let credentials = try await credentialsManager.renew(parameters: [\"key\": \"value\"],"," headers: [\"key\": \"value\"])"]},{"type":"aside","style":"note","name":"Requires","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The scope "},{"type":"codeVoice","code":"offline_access"},{"type":"text","text":" to have been requested on login to get a refresh token from Auth0. If"},{"type":"text","text":" "},{"type":"text","text":"there is no refresh token, a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken"},{"type":"text","text":" error will be thrown."}]}]},{"type":"aside","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"},{"type":"text","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"},{"text":"Credentials Manager instances. The Credentials Manager cannot synchronize requests across instances.","type":"text"}]}],"style":"important"}]}],"schemaVersion":{"major":0,"patch":0,"minor":3},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/renew(parameters:headers:)-3jl3m":{"type":"topic","title":"renew(parameters:headers:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/renew(parameters:headers:)-3jl3m","kind":"symbol","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:)-3jl3m","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"renew"},{"kind":"text","text":"("},{"kind":"externalParam","text":"parameters"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" : "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","text":"Credentials"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"title":"CredentialsManager","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManager"}],"abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanager","navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}]},"https://auth0.com/docs/api/authentication/refresh-token/refresh-token":{"title":"Authentication API Endpoint","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/refresh-token\/refresh-token","titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication\/refresh-token\/refresh-token"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/noRefreshToken":{"title":"noRefreshToken","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"noRefreshToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"}],"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":" "},{"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"}],"url":"\/documentation\/auth0\/credentialsmanagererror\/norefreshtoken"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"Credentials","kind":"identifier"}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}]},"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","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"store"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"credentials"},{"kind":"text","text":": "},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","text":"Credentials"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"abstract":[{"type":"text","text":"Stores a "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","isActive":true},{"type":"text","text":" instance in the Keychain."}],"url":"\/documentation\/auth0\/credentialsmanager\/store(credentials:)"},"doc://com.auth0.Auth0/documentation/Auth0/RefreshTokens":{"title":"Refresh Tokens: Common Errors","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens","role":"article","kind":"article","abstract":[],"url":"\/documentation\/auth0\/refreshtokens"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"kind":"symbol","title":"cause","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier","text":"Error"},{"kind":"text","text":"?"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","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":"."}],"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi"},"https://auth0.com/docs/secure/tokens/refresh-tokens":{"title":"Refresh Tokens","type":"link","titleInlineContent":[{"type":"text","text":"Refresh Tokens"}],"identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/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/renew(parameters:headers:)-7yn20.json b/docs/data/documentation/auth0/credentialsmanager/renew(parameters:headers:)-7yn20.json index d982d2ee8..8d64359db 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 @@ -{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanager\/renew(parameters:headers:)-7yn20"]}],"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/renew(parameters:headers:)-7yn20","interfaceLanguage":"swift"},"schemaVersion":{"major":0,"patch":0,"minor":3},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"renew","kind":"identifier"},{"text":"(","kind":"text"},{"text":"parameters","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","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"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"] = [:]) -> ","kind":"text"},{"text":"AnyPublisher","kind":"typeIdentifier","preciseIdentifier":"s:7Combine12AnyPublisherV"},{"text":"<","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","text":"Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"text":", ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","text":"CredentialsManagerError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"},{"text":">","kind":"text"}],"platforms":["iOS"]}]},{"parameters":[{"name":"parameters","content":[{"inlineContent":[{"text":"Additional parameters to use.","type":"text"}],"type":"paragraph"}]},{"name":"headers","content":[{"inlineContent":[{"type":"text","text":"Additional headers to use."}],"type":"paragraph"}]}],"kind":"parameters"},{"content":[{"type":"heading","text":"Usage","anchor":"Usage","level":2},{"type":"codeListing","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":"paragraph","inlineContent":[{"type":"text","text":"You can specify custom parameters or headers for the renewal request:"}]},{"type":"codeListing","code":["credentialsManager"," .renew(parameters: [\"key\": \"value\"],"," headers: [\"key\": \"value\"])"," .sink(receiveCompletion: { print($0) },"," receiveValue: { print($0) })"," .store(in: &cancellables)"],"syntax":"swift"},{"type":"aside","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The scope "},{"type":"codeVoice","code":"offline_access"},{"type":"text","text":" to have been requested on login 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":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken","isActive":true},{"type":"text","text":" "},{"type":"text","text":"error."}]}],"style":"note","name":"Requires"},{"type":"aside","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"},{"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"}]}],"style":"warning","name":"Warning"},{"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."}]}],"style":"important","name":"Important"}],"kind":"content"}],"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"}],"metadata":{"modules":[{"name":"Auth0"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"renew","kind":"identifier"},{"text":"(","kind":"text"},{"text":"parameters","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"], ","kind":"text"},{"text":"headers","kind":"externalParam"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"]) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:7Combine12AnyPublisherV","text":"AnyPublisher"},{"kind":"text","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"}],"roleHeading":"Instance Method","title":"renew(parameters:headers:)","symbolKind":"method","externalID":"s:5Auth018CredentialsManagerV5renew10parameters7headers7Combine12AnyPublisherVyAA0B0CAA0bC5ErrorVGSDySSypG_SDyS2SGtF","role":"symbol","extendedModule":"Auth0"},"sections":[],"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\/refresh-token","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens"],"anchor":"Related-Documentation","title":"Related Documentation"}],"references":{"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","abstract":[{"type":"text","text":"Renews credentials using the refresh token and stores them in the Keychain. "},{"type":"strong","inlineContent":[{"type":"text","text":"This method is thread-safe"}]},{"type":"text","text":"."}],"kind":"symbol","url":"\/documentation\/auth0\/credentialsmanager\/renew(parameters:headers:)-7yn20","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"renew"},{"kind":"text","text":"("},{"kind":"externalParam","text":"parameters"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" : "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"]) -> "},{"preciseIdentifier":"s:7Combine12AnyPublisherV","kind":"typeIdentifier","text":"AnyPublisher"},{"kind":"text","text":"<"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","text":"Credentials"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","kind":"typeIdentifier","text":"CredentialsManagerError"},{"kind":"text","text":">"}],"title":"renew(parameters:headers:)"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/store(credentials:)":{"abstract":[{"type":"text","text":"Stores a "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","isActive":true},{"type":"text","text":" instance in the Keychain."}],"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/credentialsmanager\/store(credentials:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/store(credentials:)","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"store"},{"kind":"text","text":"("},{"kind":"externalParam","text":"credentials"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"title":"store(credentials:)"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManager","kind":"identifier"}],"navigatorTitle":[{"text":"CredentialsManager","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","abstract":[{"type":"text","text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain."}],"kind":"symbol","title":"CredentialsManager","url":"\/documentation\/auth0\/credentialsmanager","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"title":"cause","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","kind":"symbol","abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":"?"}],"role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/RefreshTokens":{"url":"\/documentation\/auth0\/refreshtokens","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens","kind":"article","title":"Refresh Tokens: Common Errors","type":"topic","abstract":[],"role":"article"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"url":"\/documentation\/auth0\/credentialsmanagererror","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}],"title":"CredentialsManagerError","kind":"symbol","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}]},"https://auth0.com/docs/api/authentication/refresh-token/refresh-token":{"url":"https:\/\/auth0.com\/docs\/api\/authentication\/refresh-token\/refresh-token","identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/refresh-token\/refresh-token","titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}],"type":"link","title":"Authentication API Endpoint"},"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","titleInlineContent":[{"type":"text","text":"Refresh Tokens"}],"type":"link","title":"Refresh Tokens"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"url":"\/documentation\/auth0\/credentials","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"role":"symbol","type":"topic","abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/noRefreshToken":{"url":"\/documentation\/auth0\/credentialsmanagererror\/norefreshtoken","abstract":[{"type":"text","text":"The stored "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","isActive":true},{"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":"."}],"fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"noRefreshToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"}],"kind":"symbol","type":"topic","title":"noRefreshToken","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"metadata":{"extendedModule":"Auth0","symbolKind":"method","modules":[{"name":"Auth0"}],"title":"renew(parameters:headers:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"renew"},{"kind":"text","text":"("},{"kind":"externalParam","text":"parameters"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"]) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:7Combine12AnyPublisherV","text":"AnyPublisher"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"},{"kind":"text","text":">"}],"externalID":"s:5Auth018CredentialsManagerV5renew10parameters7headers7Combine12AnyPublisherVyAA0B0CAA0bC5ErrorVGSDySSypG_SDyS2SGtF","role":"symbol","roleHeading":"Instance Method"},"sections":[],"abstract":[{"type":"text","text":"Renews credentials using the refresh token and stores them in the Keychain. "},{"type":"strong","inlineContent":[{"type":"text","text":"This method is thread-safe"}]},{"type":"text","text":"."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanager\/renew(parameters:headers:)-7yn20"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/renew(parameters:headers:)-7yn20","interfaceLanguage":"swift"},"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","https:\/\/auth0.com\/docs\/api\/authentication\/refresh-token\/refresh-token","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens"],"anchor":"Related-Documentation"}],"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"renew"},{"kind":"text","text":"("},{"kind":"externalParam","text":"parameters"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"] = [:], "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"] = [:]) -> "},{"kind":"typeIdentifier","text":"AnyPublisher","preciseIdentifier":"s:7Combine12AnyPublisherV"},{"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":", "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","kind":"typeIdentifier","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"},{"kind":"text","text":">"}]}],"kind":"declarations"},{"parameters":[{"content":[{"inlineContent":[{"text":"Additional parameters to use.","type":"text"}],"type":"paragraph"}],"name":"parameters"},{"content":[{"inlineContent":[{"text":"Additional headers to use.","type":"text"}],"type":"paragraph"}],"name":"headers"}],"kind":"parameters"},{"content":[{"level":2,"type":"heading","anchor":"Usage","text":"Usage"},{"type":"codeListing","syntax":"swift","code":["credentialsManager"," .renew()"," .sink(receiveCompletion: { completion in"," if case .failure(let error) = completion {"," print(\"Failed with: \\(error)\")"," }"," }, receiveValue: { credentials in"," print(\"Renewed credentials: \\(credentials)\")"," })"," .store(in: &cancellables)"]},{"type":"paragraph","inlineContent":[{"type":"text","text":"You can specify custom parameters or headers for the renewal request:"}]},{"type":"codeListing","syntax":"swift","code":["credentialsManager"," .renew(parameters: [\"key\": \"value\"],"," headers: [\"key\": \"value\"])"," .sink(receiveCompletion: { print($0) },"," receiveValue: { print($0) })"," .store(in: &cancellables)"]},{"type":"aside","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"},{"text":" ","type":"text"},{"text":"there is no refresh token, the subscription will complete with a ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken","isActive":true,"type":"reference"},{"text":" ","type":"text"},{"text":"error.","type":"text"}],"type":"paragraph"}],"name":"Requires","style":"note"},{"type":"aside","content":[{"inlineContent":[{"text":"Do not call ","type":"text"},{"code":"store(credentials:)","type":"codeVoice"},{"text":" afterward. The Credentials Manager automatically persists the","type":"text"},{"text":" ","type":"text"},{"text":"renewed credentials. Since this method is thread-safe and ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/store(credentials:)","isActive":true,"type":"reference"},{"text":" is not, calling it anyway can","type":"text"},{"text":" ","type":"text"},{"text":"cause concurrency issues.","type":"text"}],"type":"paragraph"}],"name":"Warning","style":"warning"},{"type":"aside","content":[{"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"}],"type":"paragraph"}],"name":"Important","style":"important"}],"kind":"content"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"title":"CredentialsManager","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManager"}],"abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanager","navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"https://auth0.com/docs/api/authentication/refresh-token/refresh-token":{"title":"Authentication API Endpoint","url":"https:\/\/auth0.com\/docs\/api\/authentication\/refresh-token\/refresh-token","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/refresh-token\/refresh-token","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"Credentials","kind":"identifier"}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/noRefreshToken":{"title":"noRefreshToken","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"noRefreshToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"}],"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":" "},{"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"}],"url":"\/documentation\/auth0\/credentialsmanagererror\/norefreshtoken"},"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","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"store"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"credentials"},{"kind":"text","text":": "},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","text":"Credentials"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"abstract":[{"type":"text","text":"Stores a "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","isActive":true},{"type":"text","text":" instance in the Keychain."}],"url":"\/documentation\/auth0\/credentialsmanager\/store(credentials:)"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/renew(parameters:headers:)-7yn20":{"url":"\/documentation\/auth0\/credentialsmanager\/renew(parameters:headers:)-7yn20","title":"renew(parameters:headers:)","abstract":[{"type":"text","text":"Renews credentials using the refresh token and stores them in the Keychain. "},{"type":"strong","inlineContent":[{"type":"text","text":"This method is thread-safe"}]},{"type":"text","text":"."}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"renew"},{"kind":"text","text":"("},{"kind":"externalParam","text":"parameters"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" : "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"]) -> "},{"preciseIdentifier":"s:7Combine12AnyPublisherV","kind":"typeIdentifier","text":"AnyPublisher"},{"kind":"text","text":"<"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","text":"Credentials"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","kind":"typeIdentifier","text":"CredentialsManagerError"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/renew(parameters:headers:)-7yn20","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/RefreshTokens":{"title":"Refresh Tokens: Common Errors","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens","role":"article","kind":"article","abstract":[],"url":"\/documentation\/auth0\/refreshtokens"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"kind":"symbol","title":"cause","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier","text":"Error"},{"kind":"text","text":"?"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","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":"."}],"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"role":"symbol","title":"CredentialsManagerError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerError"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}],"abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","url":"\/documentation\/auth0\/credentialsmanagererror","type":"topic"},"https://auth0.com/docs/secure/tokens/refresh-tokens":{"title":"Refresh Tokens","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","type":"link","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","titleInlineContent":[{"type":"text","text":"Refresh Tokens"}]}}} \ 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 c7f8eb0da..177fe3546 100644 --- a/docs/data/documentation/auth0/credentialsmanager/renew(parameters:headers:callback:).json +++ b/docs/data/documentation/auth0/credentialsmanager/renew(parameters:headers:callback:).json @@ -1 +1 @@ -{"metadata":{"title":"renew(parameters:headers:callback:)","modules":[{"name":"Auth0"}],"symbolKind":"method","externalID":"s:5Auth018CredentialsManagerV5renew10parameters7headers8callbackySDySSypG_SDyS2SGys6ResultOyAA0B0CAA0bC5ErrorVGctF","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"renew"},{"kind":"text","text":"("},{"kind":"externalParam","text":"parameters"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"callback"},{"kind":"text","text":": ("},{"kind":"typeIdentifier","text":"CredentialsManagerResult","preciseIdentifier":"s:5Auth024CredentialsManagerResulta"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":">) -> "},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":")"}],"role":"symbol"},"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"renew"},{"kind":"text","text":"("},{"kind":"externalParam","text":"parameters"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"] = [:], "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"] = [:], "},{"kind":"externalParam","text":"callback"},{"kind":"text","text":": "},{"kind":"attribute","text":"@escaping"},{"kind":"text","text":" ("},{"kind":"typeIdentifier","text":"CredentialsManagerResult","preciseIdentifier":"s:5Auth024CredentialsManagerResulta","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerResult"},{"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":"Void","preciseIdentifier":"s:s4Voida","kind":"typeIdentifier"},{"text":")","kind":"text"}],"languages":["swift"]}]},{"kind":"parameters","parameters":[{"name":"parameters","content":[{"inlineContent":[{"text":"Additional parameters to use.","type":"text"}],"type":"paragraph"}]},{"name":"headers","content":[{"type":"paragraph","inlineContent":[{"text":"Additional headers to use.","type":"text"}]}]},{"name":"callback","content":[{"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"}],"type":"paragraph"}]}]},{"mentions":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens"],"kind":"mentions"},{"content":[{"anchor":"Usage","level":2,"type":"heading","text":"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":"You can specify custom parameters or headers for the renewal request:"}],"type":"paragraph"},{"syntax":"swift","code":["credentialsManager.renew(parameters: [\"key\": \"value\"],"," headers: [\"key\": \"value\"]) { print($0) }"],"type":"codeListing"},{"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":"there is no refresh token, the callback will be called with a "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken","type":"reference","isActive":true},{"type":"text","text":" error."}]}],"style":"note","type":"aside","name":"Requires"},{"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"},{"text":" ","type":"text"},{"text":"renewed credentials. Since this method is thread-safe and ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/store(credentials:)","isActive":true,"type":"reference"},{"text":" is not, calling it anyway can","type":"text"},{"text":" ","type":"text"},{"text":"cause concurrency issues.","type":"text"}]}],"style":"warning","type":"aside","name":"Warning"},{"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","type":"aside","name":"Important"}],"kind":"content"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/renew(parameters:headers:callback:)"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanager\/renew(parameters:headers:callback:)"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"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":"."}],"kind":"symbol","seeAlsoSections":[{"title":"Related Documentation","anchor":"Related-Documentation","identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","https:\/\/auth0.com\/docs\/api\/authentication\/refresh-token\/refresh-token","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"references":{"https://auth0.com/docs/api/authentication/refresh-token/refresh-token":{"url":"https:\/\/auth0.com\/docs\/api\/authentication\/refresh-token\/refresh-token","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/refresh-token\/refresh-token","type":"link","title":"Authentication API Endpoint"},"https://auth0.com/docs/secure/tokens/refresh-tokens":{"titleInlineContent":[{"type":"text","text":"Refresh Tokens"}],"title":"Refresh Tokens","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/renew(parameters:headers:callback:)":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/renew(parameters:headers:callback:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"renew","kind":"identifier"},{"text":"(","kind":"text"},{"text":"parameters","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","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"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"], ","kind":"text"},{"text":"callback","kind":"externalParam"},{"text":": (","kind":"text"},{"text":"CredentialsManagerResult","kind":"typeIdentifier","preciseIdentifier":"s:5Auth024CredentialsManagerResulta"},{"text":"<","kind":"text"},{"text":"Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"text":">) -> ","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":")","kind":"text"}],"title":"renew(parameters:headers:callback:)","url":"\/documentation\/auth0\/credentialsmanager\/renew(parameters:headers:callback:)","role":"symbol","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"}]},{"type":"text","text":"."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/noRefreshToken":{"url":"\/documentation\/auth0\/credentialsmanagererror\/norefreshtoken","abstract":[{"type":"text","text":"The stored "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","isActive":true},{"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":"."}],"fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"noRefreshToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"}],"kind":"symbol","type":"topic","title":"noRefreshToken","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManager","kind":"identifier"}],"navigatorTitle":[{"text":"CredentialsManager","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","abstract":[{"type":"text","text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain."}],"kind":"symbol","title":"CredentialsManager","url":"\/documentation\/auth0\/credentialsmanager","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerResult":{"type":"topic","abstract":[{"type":"codeVoice","code":"Result"},{"type":"text","text":" wrapper for Credentials Manager operations."}],"kind":"symbol","role":"symbol","navigatorTitle":[{"text":"CredentialsManagerResult","kind":"identifier"}],"title":"CredentialsManagerResult","url":"\/documentation\/auth0\/credentialsmanagerresult","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerResult","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerResult"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"title":"cause","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","kind":"symbol","abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":"?"}],"role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"url":"\/documentation\/auth0\/credentials","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"role":"symbol","type":"topic","abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/RefreshTokens":{"url":"\/documentation\/auth0\/refreshtokens","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens","kind":"article","title":"Refresh Tokens: Common Errors","type":"topic","abstract":[],"role":"article"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/store(credentials:)":{"abstract":[{"type":"text","text":"Stores a "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","isActive":true},{"type":"text","text":" instance in the Keychain."}],"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/credentialsmanager\/store(credentials:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/store(credentials:)","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"store"},{"kind":"text","text":"("},{"kind":"externalParam","text":"credentials"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"title":"store(credentials:)"}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanager\/renew(parameters:headers:callback:)"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"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"}],"primaryContentSections":[{"declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"renew","kind":"identifier"},{"text":"(","kind":"text"},{"text":"parameters","kind":"externalParam"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"] = [:], ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"] = [:], ","kind":"text"},{"kind":"externalParam","text":"callback"},{"kind":"text","text":": "},{"kind":"attribute","text":"@escaping"},{"kind":"text","text":" ("},{"kind":"typeIdentifier","text":"CredentialsManagerResult","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerResult","preciseIdentifier":"s:5Auth024CredentialsManagerResulta"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Credentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"text":">) -> ","kind":"text"},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"text":")","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"parameters","content":[{"inlineContent":[{"type":"text","text":"Additional parameters to use."}],"type":"paragraph"}]},{"name":"headers","content":[{"inlineContent":[{"type":"text","text":"Additional headers to use."}],"type":"paragraph"}]},{"name":"callback","content":[{"inlineContent":[{"text":"Callback that receives a ","type":"text"},{"type":"codeVoice","code":"Result"},{"text":" containing either the renewed user’s credentials or an error.","type":"text"}],"type":"paragraph"}]}]},{"mentions":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens"],"kind":"mentions"},{"kind":"content","content":[{"level":2,"text":"Usage","type":"heading","anchor":"Usage"},{"code":["credentialsManager.renew { result in"," switch result {"," case .success(let credentials):"," print(\"Renewed credentials: \\(credentials)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }","}"],"syntax":"swift","type":"codeListing"},{"inlineContent":[{"type":"text","text":"You can specify custom parameters or headers for the renewal request:"}],"type":"paragraph"},{"code":["credentialsManager.renew(parameters: [\"key\": \"value\"],"," headers: [\"key\": \"value\"]) { print($0) }"],"syntax":"swift","type":"codeListing"},{"name":"Requires","type":"aside","content":[{"inlineContent":[{"type":"text","text":"The scope "},{"code":"offline_access","type":"codeVoice"},{"type":"text","text":" to have been requested on login to get a refresh token from Auth0. If"},{"type":"text","text":" "},{"type":"text","text":"there is no refresh token, the callback will be called with a "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken","type":"reference","isActive":true},{"type":"text","text":" error."}],"type":"paragraph"}],"style":"note"},{"name":"Warning","type":"aside","content":[{"inlineContent":[{"type":"text","text":"Do not call "},{"code":"store(credentials:)","type":"codeVoice"},{"type":"text","text":" afterward. The Credentials Manager automatically persists the"},{"type":"text","text":" "},{"type":"text","text":"renewed credentials. Since this method is thread-safe and "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/store(credentials:)","type":"reference","isActive":true},{"type":"text","text":" is not, calling it anyway can"},{"type":"text","text":" "},{"type":"text","text":"cause concurrency issues."}],"type":"paragraph"}],"style":"warning"},{"name":"Important","type":"aside","content":[{"inlineContent":[{"type":"text","text":"To ensure that no concurrent renewal requests get made, do not call this method from multiple"},{"type":"text","text":" "},{"type":"text","text":"Credentials Manager instances. The Credentials Manager cannot synchronize requests across instances."}],"type":"paragraph"}],"style":"important"}]}],"sections":[],"kind":"symbol","schemaVersion":{"minor":3,"patch":0,"major":0},"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","https:\/\/auth0.com\/docs\/api\/authentication\/refresh-token\/refresh-token","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens"],"anchor":"Related-Documentation"}],"metadata":{"externalID":"s:5Auth018CredentialsManagerV5renew10parameters7headers8callbackySDySSypG_SDyS2SGys6ResultOyAA0B0CAA0bC5ErrorVGctF","symbolKind":"method","title":"renew(parameters:headers:callback:)","role":"symbol","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"renew"},{"kind":"text","text":"("},{"kind":"externalParam","text":"parameters"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"], "},{"text":"callback","kind":"externalParam"},{"text":": (","kind":"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"},{"text":"Void","preciseIdentifier":"s:s4Voida","kind":"typeIdentifier"},{"text":")","kind":"text"}],"modules":[{"name":"Auth0"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/renew(parameters:headers:callback:)","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/RefreshTokens":{"title":"Refresh Tokens: Common Errors","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens","role":"article","kind":"article","abstract":[],"url":"\/documentation\/auth0\/refreshtokens"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"kind":"symbol","title":"cause","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier","text":"Error"},{"kind":"text","text":"?"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","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":"."}],"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/noRefreshToken":{"title":"noRefreshToken","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"noRefreshToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"}],"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":" "},{"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"}],"url":"\/documentation\/auth0\/credentialsmanagererror\/norefreshtoken"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerResult":{"kind":"symbol","abstract":[{"code":"Result","type":"codeVoice"},{"text":" wrapper for Credentials Manager operations.","type":"text"}],"type":"topic","title":"CredentialsManagerResult","url":"\/documentation\/auth0\/credentialsmanagerresult","role":"symbol","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerResult"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerResult","navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerResult"}]},"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","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"store"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"credentials"},{"kind":"text","text":": "},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","text":"Credentials"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"abstract":[{"type":"text","text":"Stores a "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","isActive":true},{"type":"text","text":" instance in the Keychain."}],"url":"\/documentation\/auth0\/credentialsmanager\/store(credentials:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"https://auth0.com/docs/secure/tokens/refresh-tokens":{"title":"Refresh Tokens","type":"link","titleInlineContent":[{"text":"Refresh Tokens","type":"text"}],"identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens"},"https://auth0.com/docs/api/authentication/refresh-token/refresh-token":{"title":"Authentication API Endpoint","type":"link","titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}],"identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/refresh-token\/refresh-token","url":"https:\/\/auth0.com\/docs\/api\/authentication\/refresh-token\/refresh-token"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"title":"CredentialsManager","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManager"}],"abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanager","navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/renew(parameters:headers:callback:)":{"type":"topic","abstract":[{"text":"Renews credentials using the refresh token and stores them in the Keychain. ","type":"text"},{"inlineContent":[{"type":"text","text":"This method is thread-safe"}],"type":"strong"},{"text":".","type":"text"}],"title":"renew(parameters:headers:callback:)","kind":"symbol","url":"\/documentation\/auth0\/credentialsmanager\/renew(parameters:headers:callback:)","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"renew"},{"kind":"text","text":"("},{"kind":"externalParam","text":"parameters"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"callback"},{"kind":"text","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":">) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"kind":"text","text":")"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/renew(parameters:headers:callback:)"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"Credentials","kind":"identifier"}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}]}}} \ 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 509934419..3deed54d5 100644 --- a/docs/data/documentation/auth0/credentialsmanager/revoke(headers:)-6wgai.json +++ b/docs/data/documentation/auth0/credentialsmanager/revoke(headers:)-6wgai.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"abstract":[{"type":"text","text":"Calls the "},{"code":"\/oauth\/revoke","type":"codeVoice"},{"type":"text","text":" endpoint to revoke the refresh token and then clears the credentials if the request"},{"type":"text","text":" "},{"type":"text","text":"was successful. Otherwise, the credentials are not cleared and an error is thrown."}],"seeAlsoSections":[{"anchor":"Related-Documentation","title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","https:\/\/auth0.com\/docs\/api\/authentication\/revoke-refresh-token\/revoke-refresh-token"]}],"sections":[],"primaryContentSections":[{"declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"revoke","kind":"identifier"},{"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"},{"text":"async","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"},{"parameters":[{"content":[{"inlineContent":[{"text":"Additional headers to use when revoking the refresh token.","type":"text"}],"type":"paragraph"}],"name":"headers"}],"kind":"parameters"},{"content":[{"type":"heading","anchor":"Usage","level":2,"text":"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":"You can specify custom headers for the refresh token revocation:"}]},{"type":"codeListing","syntax":"swift","code":["try await credentialsManager.revoke(headers: [\"key\": \"value\"])"]},{"type":"paragraph","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":"aside","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"An error of type "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"},{"type":"text","text":"."}]}],"name":"Throws","style":"note"}],"kind":"content"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanager\/revoke(headers:)-6wgai"]}],"metadata":{"extendedModule":"Auth0","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"revoke"},{"kind":"text","text":"("},{"kind":"externalParam","text":"headers"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"]) ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"}],"modules":[{"name":"Auth0"}],"title":"revoke(headers:)","symbolKind":"method","role":"symbol","externalID":"s:5Auth018CredentialsManagerV6revoke7headersySDyS2SG_tYaKF"},"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/revoke(headers:)-6wgai"},"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"https://auth0.com/docs/secure/tokens/refresh-tokens":{"type":"link","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","titleInlineContent":[{"text":"Refresh Tokens","type":"text"}],"title":"Refresh Tokens","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens"},"https://auth0.com/docs/api/authentication/revoke-refresh-token/revoke-refresh-token":{"titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication\/revoke-refresh-token\/revoke-refresh-token","identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/revoke-refresh-token\/revoke-refresh-token","title":"Authentication API Endpoint","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManager","kind":"identifier"}],"navigatorTitle":[{"text":"CredentialsManager","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","abstract":[{"type":"text","text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain."}],"kind":"symbol","title":"CredentialsManager","url":"\/documentation\/auth0\/credentialsmanager","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"url":"\/documentation\/auth0\/credentialsmanagererror","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}],"title":"CredentialsManagerError","kind":"symbol","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/revoke(headers:)-6wgai":{"type":"topic","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"revoke"},{"kind":"text","text":"("},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"role":"symbol","kind":"symbol","abstract":[{"text":"Calls the ","type":"text"},{"code":"\/oauth\/revoke","type":"codeVoice"},{"text":" endpoint to revoke the refresh token and then clears the credentials if the request","type":"text"},{"text":" ","type":"text"},{"text":"was successful. Otherwise, the credentials are not cleared and an error is thrown.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/revoke(headers:)-6wgai","url":"\/documentation\/auth0\/credentialsmanager\/revoke(headers:)-6wgai","title":"revoke(headers:)"}}} \ No newline at end of file +{"metadata":{"symbolKind":"method","roleHeading":"Instance Method","externalID":"s:5Auth018CredentialsManagerV6revoke7headersySDyS2SG_tYaKF","extendedModule":"Auth0","title":"revoke(headers:)","modules":[{"name":"Auth0"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"revoke","kind":"identifier"},{"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"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"}],"role":"symbol"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanager\/revoke(headers:)-6wgai"]}],"identifier":{"interfaceLanguage":"swift","url":"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"},{"type":"text","text":" "},{"type":"text","text":"was successful. Otherwise, the credentials are not cleared and an error is thrown."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","https:\/\/auth0.com\/docs\/api\/authentication\/revoke-refresh-token\/revoke-refresh-token"],"anchor":"Related-Documentation"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"revoke","kind":"identifier"},{"text":"(","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"] = [:]) ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"}],"languages":["swift"],"platforms":["iOS"]}]},{"parameters":[{"name":"headers","content":[{"inlineContent":[{"text":"Additional headers to use when revoking the refresh token.","type":"text"}],"type":"paragraph"}]}],"kind":"parameters"},{"kind":"content","content":[{"type":"heading","text":"Usage","anchor":"Usage","level":2},{"type":"codeListing","code":["do {"," try await credentialsManager.revoke()"," print(\"Revoked refresh token and cleared credentials\")","} catch {"," print(\"Failed with: \\(error)\")","}"],"syntax":"swift"},{"type":"paragraph","inlineContent":[{"text":"You can specify custom headers for the refresh token revocation:","type":"text"}]},{"type":"codeListing","code":["try await credentialsManager.revoke(headers: [\"key\": \"value\"])"],"syntax":"swift"},{"type":"paragraph","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":"aside","name":"Throws","style":"note","content":[{"inlineContent":[{"text":"An error of type ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","type":"reference"},{"text":".","type":"text"}],"type":"paragraph"}]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"https://auth0.com/docs/api/authentication/revoke-refresh-token/revoke-refresh-token":{"title":"Authentication API Endpoint","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/revoke-refresh-token\/revoke-refresh-token","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication\/revoke-refresh-token\/revoke-refresh-token"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"role":"symbol","title":"CredentialsManagerError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerError"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}],"abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","url":"\/documentation\/auth0\/credentialsmanagererror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/revoke(headers:)-6wgai":{"type":"topic","title":"revoke(headers:)","identifier":"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"},{"type":"text","text":" "},{"type":"text","text":"was successful. Otherwise, the credentials are not cleared and an error is thrown."}],"url":"\/documentation\/auth0\/credentialsmanager\/revoke(headers:)-6wgai","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"revoke"},{"kind":"text","text":"("},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" : "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"title":"CredentialsManager","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManager"}],"abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanager","navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"https://auth0.com/docs/secure/tokens/refresh-tokens":{"title":"Refresh Tokens","type":"link","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","titleInlineContent":[{"type":"text","text":"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 f818a5ae3..b8ecf84ff 100644 --- a/docs/data/documentation/auth0/credentialsmanager/revoke(headers:)-9mzo6.json +++ b/docs/data/documentation/auth0/credentialsmanager/revoke(headers:)-9mzo6.json @@ -1 +1 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/revoke(headers:)-9mzo6","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"revoke","kind":"identifier"},{"text":"(","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"] = [:]) -> ","kind":"text"},{"text":"AnyPublisher","kind":"typeIdentifier","preciseIdentifier":"s:7Combine12AnyPublisherV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"kind":"text","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":[{"type":"paragraph","inlineContent":[{"text":"Additional headers to use when revoking the refresh token.","type":"text"}]}]}]},{"kind":"content","content":[{"text":"Return Value","level":2,"anchor":"return-value","type":"heading"},{"inlineContent":[{"type":"text","text":"A type-erased publisher."}],"type":"paragraph"}]},{"kind":"content","content":[{"text":"Usage","type":"heading","level":2,"anchor":"Usage"},{"code":["credentialsManager"," .revoke()"," .sink(receiveCompletion: { completion in"," switch completion {"," case .finished:"," print(\"Revoked refresh token and cleared credentials\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }, receiveValue: {})"," .store(in: &cancellables)"],"type":"codeListing","syntax":"swift"},{"type":"paragraph","inlineContent":[{"type":"text","text":"You can specify custom headers for the refresh token revocation:"}]},{"code":["credentialsManager"," .revoke(headers: [\"key\": \"value\"])"," .sink(receiveCompletion: { print($0) },"," receiveValue: {})"," .store(in: &cancellables)"],"type":"codeListing","syntax":"swift"},{"type":"paragraph","inlineContent":[{"type":"text","text":"If no refresh token is available the endpoint is not called, the credentials are cleared, and the subscription"},{"type":"text","text":" "},{"type":"text","text":"completes without an error."}]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanager\/revoke(headers:)-9mzo6"]}],"abstract":[{"type":"text","text":"Calls the "},{"type":"codeVoice","code":"\/oauth\/revoke"},{"type":"text","text":" endpoint to revoke the refresh token and then clears the credentials if the request"},{"type":"text","text":" "},{"type":"text","text":"was successful. Otherwise, the credentials are not cleared and the subscription completes with an error."}],"sections":[],"seeAlsoSections":[{"title":"Related Documentation","anchor":"Related-Documentation","identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","https:\/\/auth0.com\/docs\/api\/authentication\/revoke-refresh-token\/revoke-refresh-token"]}],"schemaVersion":{"minor":3,"major":0,"patch":0},"metadata":{"modules":[{"name":"Auth0"}],"symbolKind":"method","role":"symbol","title":"revoke(headers:)","externalID":"s:5Auth018CredentialsManagerV6revoke7headers7Combine12AnyPublisherVyytAA0bC5ErrorVGSDyS2SG_tF","roleHeading":"Instance Method","extendedModule":"Auth0","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"revoke"},{"kind":"text","text":"("},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" : "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"]) -> "},{"preciseIdentifier":"s:7Combine12AnyPublisherV","kind":"typeIdentifier","text":"AnyPublisher"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:s4Voida","kind":"typeIdentifier","text":"Void"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","kind":"typeIdentifier","text":"CredentialsManagerError"},{"kind":"text","text":">"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/revoke(headers:)-9mzo6":{"url":"\/documentation\/auth0\/credentialsmanager\/revoke(headers:)-9mzo6","kind":"symbol","role":"symbol","abstract":[{"text":"Calls the ","type":"text"},{"code":"\/oauth\/revoke","type":"codeVoice"},{"text":" endpoint to revoke the refresh token and then clears the credentials if the request","type":"text"},{"text":" ","type":"text"},{"text":"was successful. Otherwise, the credentials are not cleared and the subscription completes with an error.","type":"text"}],"title":"revoke(headers:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"revoke"},{"kind":"text","text":"("},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" : "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"]) -> "},{"preciseIdentifier":"s:7Combine12AnyPublisherV","kind":"typeIdentifier","text":"AnyPublisher"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/revoke(headers:)-9mzo6","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManager","kind":"identifier"}],"navigatorTitle":[{"text":"CredentialsManager","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","abstract":[{"type":"text","text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain."}],"kind":"symbol","title":"CredentialsManager","url":"\/documentation\/auth0\/credentialsmanager","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"url":"\/documentation\/auth0\/credentialsmanagererror","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}],"title":"CredentialsManagerError","kind":"symbol","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}]},"https://auth0.com/docs/secure/tokens/refresh-tokens":{"titleInlineContent":[{"type":"text","text":"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"},"https://auth0.com/docs/api/authentication/revoke-refresh-token/revoke-refresh-token":{"type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/revoke-refresh-token\/revoke-refresh-token","url":"https:\/\/auth0.com\/docs\/api\/authentication\/revoke-refresh-token\/revoke-refresh-token","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"title":"Authentication API Endpoint"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"metadata":{"role":"symbol","modules":[{"name":"Auth0"}],"title":"revoke(headers:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"revoke","kind":"identifier"},{"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"},{"kind":"text","text":"]) -> "},{"kind":"typeIdentifier","text":"AnyPublisher","preciseIdentifier":"s:7Combine12AnyPublisherV"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"externalID":"s:5Auth018CredentialsManagerV6revoke7headers7Combine12AnyPublisherVyytAA0bC5ErrorVGSDyS2SG_tF","extendedModule":"Auth0","roleHeading":"Instance Method","symbolKind":"method"},"sections":[],"abstract":[{"type":"text","text":"Calls the "},{"type":"codeVoice","code":"\/oauth\/revoke"},{"type":"text","text":" endpoint to revoke the refresh token and then clears the credentials if the request"},{"type":"text","text":" "},{"text":"was successful. Otherwise, the credentials are not cleared and the subscription completes with an error.","type":"text"}],"variants":[{"paths":["\/documentation\/auth0\/credentialsmanager\/revoke(headers:)-9mzo6"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/revoke(headers:)-9mzo6","interfaceLanguage":"swift"},"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","https:\/\/auth0.com\/docs\/api\/authentication\/revoke-refresh-token\/revoke-refresh-token"],"anchor":"Related-Documentation"}],"kind":"symbol","schemaVersion":{"major":0,"patch":0,"minor":3},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"revoke","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"headers"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"] = [:]) -> "},{"kind":"typeIdentifier","text":"AnyPublisher","preciseIdentifier":"s:7Combine12AnyPublisherV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"CredentialsManagerError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"},{"kind":"text","text":">"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"headers","content":[{"inlineContent":[{"text":"Additional headers to use when revoking the refresh token.","type":"text"}],"type":"paragraph"}]}]},{"content":[{"anchor":"return-value","level":2,"text":"Return Value","type":"heading"},{"inlineContent":[{"text":"A type-erased publisher.","type":"text"}],"type":"paragraph"}],"kind":"content"},{"content":[{"anchor":"Usage","text":"Usage","type":"heading","level":2},{"syntax":"swift","type":"codeListing","code":["credentialsManager"," .revoke()"," .sink(receiveCompletion: { completion in"," switch completion {"," case .finished:"," print(\"Revoked refresh token and cleared credentials\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }, receiveValue: {})"," .store(in: &cancellables)"]},{"type":"paragraph","inlineContent":[{"text":"You can specify custom headers for the refresh token revocation:","type":"text"}]},{"syntax":"swift","type":"codeListing","code":["credentialsManager"," .revoke(headers: [\"key\": \"value\"])"," .sink(receiveCompletion: { print($0) },"," receiveValue: {})"," .store(in: &cancellables)"]},{"type":"paragraph","inlineContent":[{"type":"text","text":"If no refresh token is available the endpoint is not called, the credentials are cleared, and the subscription"},{"type":"text","text":" "},{"type":"text","text":"completes without an error."}]}],"kind":"content"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"https://auth0.com/docs/api/authentication/revoke-refresh-token/revoke-refresh-token":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/revoke-refresh-token\/revoke-refresh-token","titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication\/revoke-refresh-token\/revoke-refresh-token","title":"Authentication API Endpoint","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"title":"CredentialsManager","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManager"}],"abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanager","navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/revoke(headers:)-9mzo6":{"role":"symbol","title":"revoke(headers:)","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"revoke","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"headers"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"]) -> "},{"kind":"typeIdentifier","text":"AnyPublisher","preciseIdentifier":"s:7Combine12AnyPublisherV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":", "},{"text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"abstract":[{"text":"Calls the ","type":"text"},{"type":"codeVoice","code":"\/oauth\/revoke"},{"text":" endpoint to revoke the refresh token and then clears the credentials if the request","type":"text"},{"text":" ","type":"text"},{"text":"was successful. Otherwise, the credentials are not cleared and the subscription completes with an error.","type":"text"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/revoke(headers:)-9mzo6","url":"\/documentation\/auth0\/credentialsmanager\/revoke(headers:)-9mzo6","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"role":"symbol","title":"CredentialsManagerError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerError"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}],"abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","url":"\/documentation\/auth0\/credentialsmanagererror","type":"topic"},"https://auth0.com/docs/secure/tokens/refresh-tokens":{"url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","titleInlineContent":[{"text":"Refresh Tokens","type":"text"}],"title":"Refresh Tokens","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","type":"link"}}} \ 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 417b81502..800271c4c 100644 --- a/docs/data/documentation/auth0/credentialsmanager/revoke(headers:_:).json +++ b/docs/data/documentation/auth0/credentialsmanager/revoke(headers:_:).json @@ -1 +1 @@ -{"metadata":{"symbolKind":"method","modules":[{"name":"Auth0"}],"roleHeading":"Instance Method","externalID":"s:5Auth018CredentialsManagerV6revoke7headers_ySDyS2SG_ys6ResultOyytAA0bC5ErrorVGctF","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"revoke"},{"kind":"text","text":"("},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" : "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"], ("},{"preciseIdentifier":"s:5Auth024CredentialsManagerResulta","kind":"typeIdentifier","text":"CredentialsManagerResult"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:s4Voida","kind":"typeIdentifier","text":"Void"},{"kind":"text","text":">) -> "},{"preciseIdentifier":"s:s4Voida","kind":"typeIdentifier","text":"Void"},{"kind":"text","text":")"}],"title":"revoke(headers:_:)"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/revoke(headers:_:)","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"kind":"symbol","seeAlsoSections":[{"anchor":"Related-Documentation","title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","https:\/\/auth0.com\/docs\/api\/authentication\/revoke-refresh-token\/revoke-refresh-token"]}],"variants":[{"paths":["\/documentation\/auth0\/credentialsmanager\/revoke(headers:_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"revoke","kind":"identifier"},{"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"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"callback","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"@escaping","kind":"attribute"},{"text":" (","kind":"text"},{"preciseIdentifier":"s:5Auth024CredentialsManagerResulta","text":"CredentialsManagerResult","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerResult","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"text":">) -> ","kind":"text"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"text":")","kind":"text"}]}]},{"parameters":[{"content":[{"inlineContent":[{"text":"Additional headers to use when revoking the refresh token.","type":"text"}],"type":"paragraph"}],"name":"headers"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Callback that receives a "},{"code":"Result","type":"codeVoice"},{"type":"text","text":" containing either an empty success case or an error."}]}],"name":"callback"}],"kind":"parameters"},{"kind":"content","content":[{"level":2,"text":"Usage","anchor":"Usage","type":"heading"},{"syntax":"swift","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)\")"," }","}"]},{"inlineContent":[{"type":"text","text":"You can specify custom headers for the refresh token revocation:"}],"type":"paragraph"},{"syntax":"swift","type":"codeListing","code":["credentialsManager.revoke(headers: [\"key\": \"value\"]) { print($0) }"]},{"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"},{"text":"invoked with a success case.","type":"text"}],"type":"paragraph"}]}],"abstract":[{"type":"text","text":"Calls the "},{"code":"\/oauth\/revoke","type":"codeVoice"},{"type":"text","text":" endpoint to revoke the refresh token and then clears the credentials if the request"},{"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,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/revokeFailed","type":"reference"},{"type":"text","text":" error."}],"sections":[],"schemaVersion":{"minor":3,"patch":0,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManager","kind":"identifier"}],"navigatorTitle":[{"text":"CredentialsManager","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","abstract":[{"type":"text","text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain."}],"kind":"symbol","title":"CredentialsManager","url":"\/documentation\/auth0\/credentialsmanager","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/revokeFailed":{"type":"topic","title":"revokeFailed","kind":"symbol","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/revokeFailed","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"revokeFailed"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","kind":"typeIdentifier","text":"CredentialsManagerError"}],"url":"\/documentation\/auth0\/credentialsmanagererror\/revokefailed","abstract":[{"text":"The revocation of the refresh token failed.","type":"text"},{"text":" ","type":"text"},{"text":"The underlying ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","isActive":true,"type":"reference"},{"text":" can be accessed via the ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true,"type":"reference"},{"text":" property.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/revoke(headers:_:)":{"type":"topic","abstract":[{"type":"text","text":"Calls the "},{"code":"\/oauth\/revoke","type":"codeVoice"},{"type":"text","text":" endpoint to revoke the refresh token and then clears the credentials if the request"},{"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,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/revokeFailed","type":"reference"},{"type":"text","text":" error."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/revoke(headers:_:)","url":"\/documentation\/auth0\/credentialsmanager\/revoke(headers:_:)","kind":"symbol","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"revoke","kind":"identifier"},{"text":"(","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"], (","kind":"text"},{"text":"CredentialsManagerResult","kind":"typeIdentifier","preciseIdentifier":"s:5Auth024CredentialsManagerResulta"},{"text":"<","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":">) -> ","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":")","kind":"text"}],"title":"revoke(headers:_:)"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"https://auth0.com/docs/api/authentication/revoke-refresh-token/revoke-refresh-token":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/revoke-refresh-token\/revoke-refresh-token","title":"Authentication API Endpoint","type":"link","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication\/revoke-refresh-token\/revoke-refresh-token"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"title":"cause","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","kind":"symbol","abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":"?"}],"role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerResult":{"type":"topic","abstract":[{"type":"codeVoice","code":"Result"},{"type":"text","text":" wrapper for Credentials Manager operations."}],"kind":"symbol","role":"symbol","navigatorTitle":[{"text":"CredentialsManagerResult","kind":"identifier"}],"title":"CredentialsManagerResult","url":"\/documentation\/auth0\/credentialsmanagerresult","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerResult","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerResult"},"https://auth0.com/docs/secure/tokens/refresh-tokens":{"type":"link","title":"Refresh Tokens","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","titleInlineContent":[{"text":"Refresh Tokens","type":"text"}]}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"metadata":{"symbolKind":"method","modules":[{"name":"Auth0"}],"title":"revoke(headers:_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"revoke"},{"kind":"text","text":"("},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" : "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"], ("},{"preciseIdentifier":"s:5Auth024CredentialsManagerResulta","kind":"typeIdentifier","text":"CredentialsManagerResult"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:s4Voida","kind":"typeIdentifier","text":"Void"},{"kind":"text","text":">) -> "},{"preciseIdentifier":"s:s4Voida","kind":"typeIdentifier","text":"Void"},{"kind":"text","text":")"}],"externalID":"s:5Auth018CredentialsManagerV6revoke7headers_ySDyS2SG_ys6ResultOyytAA0bC5ErrorVGctF","role":"symbol","roleHeading":"Instance Method"},"sections":[],"abstract":[{"text":"Calls the ","type":"text"},{"code":"\/oauth\/revoke","type":"codeVoice"},{"text":" endpoint to revoke the refresh token and then clears the credentials if the request","type":"text"},{"text":" ","type":"text"},{"text":"was successful. Otherwise, the credentials will not be cleared and the callback will be called with a failure","type":"text"},{"text":" ","type":"text"},{"text":"result containing a ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/revokeFailed","type":"reference"},{"text":" error.","type":"text"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanager\/revoke(headers:_:)"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/revoke(headers:_:)","interfaceLanguage":"swift"},"seeAlsoSections":[{"anchor":"Related-Documentation","title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","https:\/\/auth0.com\/docs\/api\/authentication\/revoke-refresh-token\/revoke-refresh-token"]}],"kind":"symbol","schemaVersion":{"minor":3,"patch":0,"major":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"revoke"},{"kind":"text","text":"("},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"] = [:], "},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"callback"},{"kind":"text","text":": "},{"kind":"attribute","text":"@escaping"},{"kind":"text","text":" ("},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerResult","text":"CredentialsManagerResult","preciseIdentifier":"s:5Auth024CredentialsManagerResulta"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":">) -> "},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":")"}],"languages":["swift"],"platforms":["iOS"]}]},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"type":"text","text":"Additional headers to use when revoking the refresh token."}],"type":"paragraph"}],"name":"headers"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Callback that receives a "},{"code":"Result","type":"codeVoice"},{"type":"text","text":" containing either an empty success case or an error."}]}],"name":"callback"}]},{"content":[{"level":2,"anchor":"Usage","text":"Usage","type":"heading"},{"syntax":"swift","code":["credentialsManager.revoke { result in"," switch result {"," case .success:"," print(\"Revoked refresh token and cleared credentials\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }","}"],"type":"codeListing"},{"inlineContent":[{"type":"text","text":"You can specify custom headers for the refresh token revocation:"}],"type":"paragraph"},{"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":" "},{"type":"text","text":"invoked with a success case."}],"type":"paragraph"}],"kind":"content"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"kind":"symbol","title":"cause","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier","text":"Error"},{"kind":"text","text":"?"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","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":"."}],"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/revoke(headers:_:)":{"url":"\/documentation\/auth0\/credentialsmanager\/revoke(headers:_:)","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"},{"text":" ","type":"text"},{"text":"was successful. Otherwise, the credentials will not be cleared and the callback will be called with a failure","type":"text"},{"text":" ","type":"text"},{"text":"result containing a ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/revokeFailed","type":"reference"},{"text":" error.","type":"text"}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"revoke"},{"kind":"text","text":"("},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"], ("},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth024CredentialsManagerResulta","text":"CredentialsManagerResult"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"kind":"text","text":">) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"text":")","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/revoke(headers:_:)","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerResult":{"kind":"symbol","abstract":[{"code":"Result","type":"codeVoice"},{"text":" wrapper for Credentials Manager operations.","type":"text"}],"type":"topic","title":"CredentialsManagerResult","url":"\/documentation\/auth0\/credentialsmanagerresult","role":"symbol","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerResult"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerResult","navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerResult"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"},"https://auth0.com/docs/api/authentication/revoke-refresh-token/revoke-refresh-token":{"type":"link","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication\/revoke-refresh-token\/revoke-refresh-token","title":"Authentication API Endpoint","identifier":"https:\/\/auth0.com\/docs\/api\/authentication\/revoke-refresh-token\/revoke-refresh-token"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"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","title":"Refresh Tokens","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/revokeFailed":{"type":"topic","abstract":[{"type":"text","text":"The revocation of the refresh token 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","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true},{"type":"text","text":" property."}],"title":"revokeFailed","kind":"symbol","url":"\/documentation\/auth0\/credentialsmanagererror\/revokefailed","role":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"revokeFailed"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/revokeFailed"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"title":"CredentialsManager","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManager"}],"abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanager","navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentialsmanager/ssocredentials(parameters:headers:)-151ni.json b/docs/data/documentation/auth0/credentialsmanager/ssocredentials(parameters:headers:)-151ni.json index d0ab35c98..9dfb93a58 100644 --- a/docs/data/documentation/auth0/credentialsmanager/ssocredentials(parameters:headers:)-151ni.json +++ b/docs/data/documentation/auth0/credentialsmanager/ssocredentials(parameters:headers:)-151ni.json @@ -1 +1 @@ -{"sections":[],"abstract":[{"text":"Exchanges the refresh token for a session transfer token that can be used to perform web single sign-on (SSO).","type":"text"},{"text":" ","type":"text"},{"type":"strong","inlineContent":[{"text":"This method is thread-safe","type":"text"}]},{"text":".","type":"text"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/ssoCredentials(parameters:headers:)-151ni"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanager\/ssocredentials(parameters:headers:)-151ni"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"schemaVersion":{"minor":3,"patch":0,"major":0},"seeAlsoSections":[{"title":"Related Documentation","anchor":"Related-Documentation","identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","https:\/\/auth0.com\/docs\/api\/authentication#refresh-token","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens"]}],"metadata":{"externalID":"s:5Auth018CredentialsManagerV03ssoB010parameters7headers7Combine12AnyPublisherVyAA14SSOCredentialsVAA0bC5ErrorVGSDySSypG_SDyS2SGtF","extendedModule":"Auth0","modules":[{"name":"Auth0"}],"title":"ssoCredentials(parameters:headers:)","roleHeading":"Instance Method","symbolKind":"method","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ssoCredentials","kind":"identifier"},{"text":"(","kind":"text"},{"text":"parameters","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","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"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"]) -> ","kind":"text"},{"text":"AnyPublisher","kind":"typeIdentifier","preciseIdentifier":"s:7Combine12AnyPublisherV"},{"text":"<","kind":"text"},{"text":"SSOCredentials","kind":"typeIdentifier","preciseIdentifier":"s:5Auth014SSOCredentialsV"},{"text":", ","kind":"text"},{"text":"CredentialsManagerError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"},{"text":">","kind":"text"}]},"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ssoCredentials","kind":"identifier"},{"text":"(","kind":"text"},{"text":"parameters","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"] = [:], ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"] = [:]) -> ","kind":"text"},{"text":"AnyPublisher","preciseIdentifier":"s:7Combine12AnyPublisherV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"SSOCredentials","preciseIdentifier":"s:5Auth014SSOCredentialsV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials"},{"text":", ","kind":"text"},{"text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"},{"text":">","kind":"text"}],"languages":["swift"]}]},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"text":"Additional parameters to use.","type":"text"}]}],"name":"parameters"},{"content":[{"type":"paragraph","inlineContent":[{"text":"Additional headers to use.","type":"text"}]}],"name":"headers"}]},{"content":[{"text":"Availability","level":2,"type":"heading","anchor":"Availability"},{"type":"paragraph","inlineContent":[{"text":"This feature is currently available in","type":"text"},{"text":" ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","isActive":true,"type":"reference"},{"text":".","type":"text"},{"text":" ","type":"text"},{"text":"Please reach out to Auth0 support to get it enabled for your tenant.","type":"text"}]},{"text":"Usage","level":2,"type":"heading","anchor":"Usage"},{"syntax":"swift","code":["credentialsManager"," .ssoCredentials()"," .sink(receiveCompletion: { completion in"," if case .failure(let error) = completion {"," print(\"Failed with: \\(error)\")"," }"," }, receiveValue: { ssoCredentials in"," print(\"Obtained SSO credentials: \\(ssoCredentials)\")"," })"," .store(in: &cancellables)"],"type":"codeListing"},{"type":"paragraph","inlineContent":[{"type":"text","text":"If you need to specify custom parameters or headers:"}]},{"syntax":"swift","code":["credentialsManager"," .ssoCredentials(parameters: [\"key\": \"value\"],"," headers: [\"key\": \"value\"])"," .sink(receiveCompletion: { print($0) },"," receiveValue: { print($0) })"," .store(in: &cancellables)"],"type":"codeListing"},{"type":"paragraph","inlineContent":[{"type":"text","text":"When opening your website on any browser or web view, add the session transfer token to the URL as a query"},{"type":"text","text":" "},{"type":"text","text":"parameter. Then your website can redirect the user to Auth0’s "},{"type":"codeVoice","code":"\/authorize"},{"type":"text","text":" endpoint, passing along the query"},{"type":"text","text":" "},{"type":"text","text":"parameter with the session transfer token. For example,"},{"type":"text","text":" "},{"type":"codeVoice","code":"https:\/\/example.com\/login?session_transfer_token=THE_TOKEN"},{"type":"text","text":"."}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"If you’re using "},{"type":"codeVoice","code":"WKWebView"},{"type":"text","text":" to open your website, you can place the session transfer token inside a cookie"},{"type":"text","text":" "},{"type":"text","text":"instead. It will be automatically sent to the "},{"type":"codeVoice","code":"\/authorize"},{"type":"text","text":" endpoint."}]},{"syntax":"swift","code":["let cookie = HTTPCookie(properties: ["," .domain: \"YOUR_AUTH0_DOMAIN\", \/\/ Or custom domain, if your website is using one"," .path: \"\/\","," .name: \"auth0_session_transfer_token\","," .value: ssoCredentials.sessionTransferToken,"," .expires: ssoCredentials.expiresIn,"," .secure: true","])!","","webView.configuration.websiteDataStore.httpCookieStore.setCookie(cookie)"],"type":"codeListing"},{"style":"important","content":[{"inlineContent":[{"text":"Make sure the cookie’s domain matches the Auth0 domain your ","type":"text"},{"inlineContent":[{"type":"text","text":"website"}],"type":"emphasis"},{"text":" is using, regardless of the","type":"text"},{"text":" ","type":"text"},{"text":"one your mobile app is using. Otherwise, the ","type":"text"},{"code":"\/authorize","type":"codeVoice"},{"text":" endpoint will not receive the cookie. If your website","type":"text"},{"text":" ","type":"text"},{"text":"is using the provided Auth0 domain (like ","type":"text"},{"code":"example.us.auth0.com","type":"codeVoice"},{"text":"), set the cookie’s domain to this value. On the","type":"text"},{"text":" ","type":"text"},{"text":"other hand, if your website is using a custom domain, use this value instead.","type":"text"}],"type":"paragraph"}],"type":"aside","name":"Important"},{"style":"note","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":"there is no refresh token, the callback will be called with a "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken","isActive":true},{"type":"text","text":" error."}]}],"type":"aside","name":"Requires"},{"style":"important","content":[{"type":"paragraph","inlineContent":[{"text":"To ensure that no concurrent renewal requests get made, do not call this method from multiple","type":"text"},{"text":" ","type":"text"},{"text":"Credentials Manager instances. The Credentials Manager cannot synchronize requests across instances.","type":"text"}]}],"type":"aside","name":"Important"}],"kind":"content"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"url":"\/documentation\/auth0\/credentials","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"role":"symbol","type":"topic","abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/SSOCredentials":{"url":"\/documentation\/auth0\/ssocredentials","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"SSOCredentials","kind":"identifier"}],"abstract":[{"type":"text","text":"Credentials obtained from Auth0 to perform web single sign-on (SSO)."}],"role":"symbol","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials","title":"SSOCredentials","type":"topic","navigatorTitle":[{"text":"SSOCredentials","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManager","kind":"identifier"}],"navigatorTitle":[{"text":"CredentialsManager","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","abstract":[{"type":"text","text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain."}],"kind":"symbol","title":"CredentialsManager","url":"\/documentation\/auth0\/credentialsmanager","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"title":"cause","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","kind":"symbol","abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":"?"}],"role":"symbol","type":"topic"},"https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access":{"identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","type":"link","title":"Early Access","url":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","titleInlineContent":[{"type":"text","text":"Early Access"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"url":"\/documentation\/auth0\/credentialsmanagererror","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}],"title":"CredentialsManagerError","kind":"symbol","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/noRefreshToken":{"url":"\/documentation\/auth0\/credentialsmanagererror\/norefreshtoken","abstract":[{"type":"text","text":"The stored "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","isActive":true},{"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":"."}],"fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"noRefreshToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"}],"kind":"symbol","type":"topic","title":"noRefreshToken","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken"},"https://auth0.com/docs/secure/tokens/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","titleInlineContent":[{"type":"text","text":"Refresh Tokens"}]},"https://auth0.com/docs/api/authentication#refresh-token":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication#refresh-token","type":"link","title":"Authentication API Endpoint","url":"https:\/\/auth0.com\/docs\/api\/authentication#refresh-token","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/ssoCredentials(parameters:headers:)-151ni":{"url":"\/documentation\/auth0\/credentialsmanager\/ssocredentials(parameters:headers:)-151ni","abstract":[{"type":"text","text":"Exchanges the refresh token for a session transfer token that can be used to perform web single sign-on (SSO)."},{"type":"text","text":" "},{"type":"strong","inlineContent":[{"text":"This method is thread-safe","type":"text"}]},{"type":"text","text":"."}],"role":"symbol","title":"ssoCredentials(parameters:headers:)","type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/ssoCredentials(parameters:headers:)-151ni","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"ssoCredentials"},{"kind":"text","text":"("},{"kind":"externalParam","text":"parameters"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"]) -> "},{"kind":"typeIdentifier","text":"AnyPublisher","preciseIdentifier":"s:7Combine12AnyPublisherV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"SSOCredentials","preciseIdentifier":"s:5Auth014SSOCredentialsV"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"},{"kind":"text","text":">"}]},"doc://com.auth0.Auth0/documentation/Auth0/RefreshTokens":{"url":"\/documentation\/auth0\/refreshtokens","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens","kind":"article","title":"Refresh Tokens: Common Errors","type":"topic","abstract":[],"role":"article"}}} \ No newline at end of file +{"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/ssoCredentials(parameters:headers:)-151ni","interfaceLanguage":"swift"},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"ssoCredentials"},{"kind":"text","text":"("},{"kind":"externalParam","text":"parameters"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"] = [:], "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"] = [:]) -> "},{"kind":"typeIdentifier","text":"AnyPublisher","preciseIdentifier":"s:7Combine12AnyPublisherV"},{"kind":"text","text":"<"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials","kind":"typeIdentifier","text":"SSOCredentials","preciseIdentifier":"s:5Auth014SSOCredentialsV"},{"kind":"text","text":", "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","kind":"typeIdentifier","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"},{"kind":"text","text":">"}]}],"kind":"declarations"},{"parameters":[{"content":[{"inlineContent":[{"text":"Additional parameters to use.","type":"text"}],"type":"paragraph"}],"name":"parameters"},{"content":[{"inlineContent":[{"text":"Additional headers to use.","type":"text"}],"type":"paragraph"}],"name":"headers"}],"kind":"parameters"},{"content":[{"level":2,"type":"heading","anchor":"Availability","text":"Availability"},{"type":"paragraph","inlineContent":[{"type":"text","text":"This feature is currently available in"},{"type":"text","text":" "},{"identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","type":"reference","isActive":true},{"type":"text","text":"."},{"type":"text","text":" "},{"type":"text","text":"Please reach out to Auth0 support to get it enabled for your tenant."}]},{"level":2,"type":"heading","anchor":"Usage","text":"Usage"},{"type":"codeListing","syntax":"swift","code":["credentialsManager"," .ssoCredentials()"," .sink(receiveCompletion: { completion in"," if case .failure(let error) = completion {"," print(\"Failed with: \\(error)\")"," }"," }, receiveValue: { ssoCredentials in"," print(\"Obtained SSO credentials: \\(ssoCredentials)\")"," })"," .store(in: &cancellables)"]},{"type":"paragraph","inlineContent":[{"type":"text","text":"If you need to specify custom parameters or headers:"}]},{"code":["credentialsManager"," .ssoCredentials(parameters: [\"key\": \"value\"],"," headers: [\"key\": \"value\"])"," .sink(receiveCompletion: { print($0) },"," receiveValue: { print($0) })"," .store(in: &cancellables)"],"type":"codeListing","syntax":"swift"},{"inlineContent":[{"text":"When opening your website on any browser or web view, add the session transfer token to the URL as a query","type":"text"},{"text":" ","type":"text"},{"text":"parameter. Then your website can redirect the user to Auth0’s ","type":"text"},{"code":"\/authorize","type":"codeVoice"},{"text":" endpoint, passing along the query","type":"text"},{"text":" ","type":"text"},{"text":"parameter with the session transfer token. For example,","type":"text"},{"text":" ","type":"text"},{"code":"https:\/\/example.com\/login?session_transfer_token=THE_TOKEN","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"},{"inlineContent":[{"type":"text","text":"If you’re using "},{"type":"codeVoice","code":"WKWebView"},{"type":"text","text":" to open your website, you can place the session transfer token inside a cookie"},{"type":"text","text":" "},{"type":"text","text":"instead. It will be automatically sent to the "},{"type":"codeVoice","code":"\/authorize"},{"type":"text","text":" endpoint."}],"type":"paragraph"},{"code":["let cookie = HTTPCookie(properties: ["," .domain: \"YOUR_AUTH0_DOMAIN\", \/\/ Or custom domain, if your website is using one"," .path: \"\/\","," .name: \"auth0_session_transfer_token\","," .value: ssoCredentials.sessionTransferToken,"," .expires: ssoCredentials.expiresIn,"," .secure: true","])!","","webView.configuration.websiteDataStore.httpCookieStore.setCookie(cookie)"],"type":"codeListing","syntax":"swift"},{"name":"Important","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Make sure the cookie’s domain matches the Auth0 domain your "},{"type":"emphasis","inlineContent":[{"text":"website","type":"text"}]},{"type":"text","text":" is using, regardless of the"},{"type":"text","text":" "},{"type":"text","text":"one your mobile app is using. Otherwise, the "},{"type":"codeVoice","code":"\/authorize"},{"type":"text","text":" endpoint will not receive the cookie. If your website"},{"type":"text","text":" "},{"type":"text","text":"is using the provided Auth0 domain (like "},{"type":"codeVoice","code":"example.us.auth0.com"},{"type":"text","text":"), set the cookie’s domain to this value. On the"},{"type":"text","text":" "},{"type":"text","text":"other hand, if your website is using a custom domain, use this value instead."}]}],"type":"aside","style":"important"},{"name":"Requires","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The scope "},{"type":"codeVoice","code":"offline_access"},{"type":"text","text":" to have been requested on login to get a refresh token from Auth0. If"},{"type":"text","text":" "},{"type":"text","text":"there is no refresh token, the callback will be called with a "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken","isActive":true},{"type":"text","text":" error."}]}],"type":"aside","style":"note"},{"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"},{"type":"text","text":" "},{"type":"text","text":"Credentials Manager instances. The Credentials Manager cannot synchronize requests across instances."}]}],"type":"aside","style":"important"}],"kind":"content"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanager\/ssocredentials(parameters:headers:)-151ni"]}],"kind":"symbol","metadata":{"roleHeading":"Instance Method","extendedModule":"Auth0","title":"ssoCredentials(parameters:headers:)","role":"symbol","symbolKind":"method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"ssoCredentials"},{"kind":"text","text":"("},{"kind":"externalParam","text":"parameters"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"]) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:7Combine12AnyPublisherV","text":"AnyPublisher"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth014SSOCredentialsV","text":"SSOCredentials"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"},{"kind":"text","text":">"}],"externalID":"s:5Auth018CredentialsManagerV03ssoB010parameters7headers7Combine12AnyPublisherVyAA14SSOCredentialsVAA0bC5ErrorVGSDySSypG_SDyS2SGtF","modules":[{"name":"Auth0"}]},"schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"type":"text","text":"Exchanges the refresh token for a session transfer token that can be used to perform web single sign-on (SSO)."},{"type":"text","text":" "},{"type":"strong","inlineContent":[{"type":"text","text":"This method is thread-safe"}]},{"type":"text","text":"."}],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","https:\/\/auth0.com\/docs\/api\/authentication#refresh-token","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens"],"anchor":"Related-Documentation"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"role":"symbol","title":"CredentialsManagerError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerError"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}],"abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","url":"\/documentation\/auth0\/credentialsmanagererror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/noRefreshToken":{"title":"noRefreshToken","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"noRefreshToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"}],"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":" "},{"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"}],"url":"\/documentation\/auth0\/credentialsmanagererror\/norefreshtoken"},"doc://com.auth0.Auth0/documentation/Auth0/RefreshTokens":{"title":"Refresh Tokens: Common Errors","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens","role":"article","kind":"article","abstract":[],"url":"\/documentation\/auth0\/refreshtokens"},"doc://com.auth0.Auth0/documentation/Auth0/SSOCredentials":{"title":"SSOCredentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials","navigatorTitle":[{"kind":"identifier","text":"SSOCredentials"}],"url":"\/documentation\/auth0\/ssocredentials","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"SSOCredentials"}],"abstract":[{"type":"text","text":"Credentials obtained from Auth0 to perform web single sign-on (SSO)."}],"kind":"symbol","role":"symbol","type":"topic"},"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","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/ssoCredentials(parameters:headers:)-151ni":{"role":"symbol","title":"ssoCredentials(parameters:headers:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"ssoCredentials"},{"kind":"text","text":"("},{"kind":"externalParam","text":"parameters"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"]) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:7Combine12AnyPublisherV","text":"AnyPublisher"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth014SSOCredentialsV","text":"SSOCredentials"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"},{"kind":"text","text":">"}],"abstract":[{"type":"text","text":"Exchanges the refresh token for a session transfer token that can be used to perform web single sign-on (SSO)."},{"type":"text","text":" "},{"type":"strong","inlineContent":[{"type":"text","text":"This method is thread-safe"}]},{"type":"text","text":"."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/ssoCredentials(parameters:headers:)-151ni","url":"\/documentation\/auth0\/credentialsmanager\/ssocredentials(parameters:headers:)-151ni","type":"topic"},"https://auth0.com/docs/api/authentication#refresh-token":{"titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"url":"https:\/\/auth0.com\/docs\/api\/authentication#refresh-token","type":"link","title":"Authentication API Endpoint","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#refresh-token"},"https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access":{"title":"Early Access","type":"link","titleInlineContent":[{"type":"text","text":"Early Access"}],"identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","url":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"title":"CredentialsManager","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManager"}],"abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanager","navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}]},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"kind":"symbol","title":"cause","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier","text":"Error"},{"kind":"text","text":"?"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","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":"."}],"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"Credentials","kind":"identifier"}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentialsmanager/ssocredentials(parameters:headers:)-8vdt4.json b/docs/data/documentation/auth0/credentialsmanager/ssocredentials(parameters:headers:)-8vdt4.json index 3cb575102..3e274eb00 100644 --- a/docs/data/documentation/auth0/credentialsmanager/ssocredentials(parameters:headers:)-8vdt4.json +++ b/docs/data/documentation/auth0/credentialsmanager/ssocredentials(parameters:headers:)-8vdt4.json @@ -1 +1 @@ -{"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"],"anchor":"Related-Documentation"}],"schemaVersion":{"minor":3,"major":0,"patch":0},"abstract":[{"type":"text","text":"Exchanges the refresh token for a session transfer token that can be used to perform web single sign-on (SSO)."},{"type":"text","text":" "},{"type":"strong","inlineContent":[{"type":"text","text":"This method is thread-safe"}]},{"type":"text","text":"."}],"metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"ssoCredentials"},{"kind":"text","text":"("},{"kind":"externalParam","text":"parameters"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" : "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"preciseIdentifier":"s:5Auth014SSOCredentialsV","kind":"typeIdentifier","text":"SSOCredentials"}],"modules":[{"name":"Auth0"}],"roleHeading":"Instance Method","extendedModule":"Auth0","symbolKind":"method","externalID":"s:5Auth018CredentialsManagerV03ssoB010parameters7headersAA14SSOCredentialsVSDySSypG_SDyS2SGtYaKF","role":"symbol","title":"ssoCredentials(parameters:headers:)"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanager\/ssocredentials(parameters:headers:)-8vdt4"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"ssoCredentials"},{"kind":"text","text":"("},{"kind":"externalParam","text":"parameters"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"] = [:], "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"] = [:]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials","text":"SSOCredentials","preciseIdentifier":"s:5Auth014SSOCredentialsV"}],"platforms":["iOS"]}]},{"parameters":[{"name":"parameters","content":[{"inlineContent":[{"text":"Additional parameters to use.","type":"text"}],"type":"paragraph"}]},{"name":"headers","content":[{"inlineContent":[{"type":"text","text":"Additional headers to use."}],"type":"paragraph"}]}],"kind":"parameters"},{"content":[{"text":"Return Value","type":"heading","anchor":"return-value","level":2},{"inlineContent":[{"type":"text","text":"SSO credentials contaning a session transfer token."}],"type":"paragraph"}],"kind":"content"},{"content":[{"anchor":"Availability","level":2,"text":"Availability","type":"heading"},{"inlineContent":[{"type":"text","text":"This feature is currently available in"},{"type":"text","text":" "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access"},{"type":"text","text":"."},{"type":"text","text":" "},{"type":"text","text":"Please reach out to Auth0 support to get it enabled for your tenant."}],"type":"paragraph"},{"anchor":"Usage","level":2,"text":"Usage","type":"heading"},{"syntax":"swift","code":["do {"," let ssoCredentials = try await credentialsManager.ssoCredentials()"," print(\"Obtained SSO credentials: \\(ssoCredentials)\")","} catch {"," print(\"Failed with: \\(error)\")","}"],"type":"codeListing"},{"inlineContent":[{"type":"text","text":"If you need to specify custom parameters or headers:"}],"type":"paragraph"},{"syntax":"swift","code":["let ssoCredentials = try await credentialsManager.ssoCredentials(parameters: [\"key\": \"value\"],"," headers: [\"key\": \"value\"])"],"type":"codeListing"},{"inlineContent":[{"text":"When opening your website on any browser or web view, add the session transfer token to the URL as a query","type":"text"},{"text":" ","type":"text"},{"text":"parameter. Then your website can redirect the user to Auth0’s ","type":"text"},{"type":"codeVoice","code":"\/authorize"},{"text":" endpoint, passing along the query","type":"text"},{"text":" ","type":"text"},{"text":"parameter with the session transfer token. For example,","type":"text"},{"text":" ","type":"text"},{"type":"codeVoice","code":"https:\/\/example.com\/login?session_transfer_token=THE_TOKEN"},{"text":".","type":"text"}],"type":"paragraph"},{"inlineContent":[{"type":"text","text":"If you’re using "},{"type":"codeVoice","code":"WKWebView"},{"type":"text","text":" to open your website, you can place the session transfer token inside a cookie"},{"type":"text","text":" "},{"type":"text","text":"instead. It will be automatically sent to the "},{"type":"codeVoice","code":"\/authorize"},{"type":"text","text":" endpoint."}],"type":"paragraph"},{"syntax":"swift","code":["let cookie = HTTPCookie(properties: ["," .domain: \"YOUR_AUTH0_DOMAIN\", \/\/ Or custom domain, if your website is using one"," .path: \"\/\","," .name: \"auth0_session_transfer_token\","," .value: ssoCredentials.sessionTransferToken,"," .expires: ssoCredentials.expiresIn,"," .secure: true","])!","","webView.configuration.websiteDataStore.httpCookieStore.setCookie(cookie)"],"type":"codeListing"},{"content":[{"type":"paragraph","inlineContent":[{"text":"Make sure the cookie’s domain matches the Auth0 domain your ","type":"text"},{"inlineContent":[{"type":"text","text":"website"}],"type":"emphasis"},{"text":" is using, regardless of the","type":"text"},{"text":" ","type":"text"},{"text":"one your mobile app is using. Otherwise, the ","type":"text"},{"code":"\/authorize","type":"codeVoice"},{"text":" endpoint will not receive the cookie. If your website","type":"text"},{"text":" ","type":"text"},{"text":"is using the provided Auth0 domain (like ","type":"text"},{"code":"example.us.auth0.com","type":"codeVoice"},{"text":"), set the cookie’s domain to this value. On the","type":"text"},{"text":" ","type":"text"},{"text":"other hand, if your website is using a custom domain, use this value instead.","type":"text"}]}],"style":"important","name":"Important","type":"aside"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"An error of type "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","type":"reference","isActive":true},{"type":"text","text":"."}]}],"style":"note","name":"Throws","type":"aside"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The scope "},{"type":"codeVoice","code":"offline_access"},{"type":"text","text":" to have been requested on login to get a refresh token from Auth0. If"},{"type":"text","text":" "},{"type":"text","text":"there is no refresh token, the callback will be called with a "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken","type":"reference","isActive":true},{"type":"text","text":" error."}]}],"style":"note","name":"Requires","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"}]}],"style":"important","name":"Important","type":"aside"}],"kind":"content"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"kind":"symbol","sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/ssoCredentials(parameters:headers:)-8vdt4","interfaceLanguage":"swift"},"references":{"https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access":{"title":"Early Access","type":"link","titleInlineContent":[{"text":"Early Access","type":"text"}],"identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","url":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManager","kind":"identifier"}],"navigatorTitle":[{"text":"CredentialsManager","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","abstract":[{"type":"text","text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain."}],"kind":"symbol","title":"CredentialsManager","url":"\/documentation\/auth0\/credentialsmanager","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/noRefreshToken":{"url":"\/documentation\/auth0\/credentialsmanagererror\/norefreshtoken","abstract":[{"type":"text","text":"The stored "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","isActive":true},{"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":"."}],"fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"noRefreshToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"}],"kind":"symbol","type":"topic","title":"noRefreshToken","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"url":"\/documentation\/auth0\/credentialsmanagererror","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}],"title":"CredentialsManagerError","kind":"symbol","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"title":"cause","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","kind":"symbol","abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":"?"}],"role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/SSOCredentials":{"url":"\/documentation\/auth0\/ssocredentials","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"SSOCredentials","kind":"identifier"}],"abstract":[{"type":"text","text":"Credentials obtained from Auth0 to perform web single sign-on (SSO)."}],"role":"symbol","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials","title":"SSOCredentials","type":"topic","navigatorTitle":[{"text":"SSOCredentials","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"url":"\/documentation\/auth0\/credentials","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"role":"symbol","type":"topic","abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/RefreshTokens":{"url":"\/documentation\/auth0\/refreshtokens","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens","kind":"article","title":"Refresh Tokens: Common Errors","type":"topic","abstract":[],"role":"article"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/ssoCredentials(parameters:headers:)-8vdt4":{"abstract":[{"type":"text","text":"Exchanges the refresh token for a session transfer token that can be used to perform web single sign-on (SSO)."},{"type":"text","text":" "},{"type":"strong","inlineContent":[{"type":"text","text":"This method is thread-safe"}]},{"type":"text","text":"."}],"url":"\/documentation\/auth0\/credentialsmanager\/ssocredentials(parameters:headers:)-8vdt4","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/ssoCredentials(parameters:headers:)-8vdt4","title":"ssoCredentials(parameters:headers:)","type":"topic","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ssoCredentials","kind":"identifier"},{"text":"(","kind":"text"},{"text":"parameters","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","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"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"]) ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"SSOCredentials","kind":"typeIdentifier","preciseIdentifier":"s:5Auth014SSOCredentialsV"}],"kind":"symbol","role":"symbol"},"https://auth0.com/docs/secure/tokens/refresh-tokens":{"title":"Refresh Tokens","type":"link","titleInlineContent":[{"text":"Refresh Tokens","type":"text"}],"identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens"},"https://auth0.com/docs/api/authentication#refresh-token":{"title":"Authentication API Endpoint","type":"link","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"identifier":"https:\/\/auth0.com\/docs\/api\/authentication#refresh-token","url":"https:\/\/auth0.com\/docs\/api\/authentication#refresh-token"}}} \ No newline at end of file +{"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/ssoCredentials(parameters:headers:)-8vdt4","interfaceLanguage":"swift"},"kind":"symbol","metadata":{"modules":[{"name":"Auth0"}],"title":"ssoCredentials(parameters:headers:)","roleHeading":"Instance Method","symbolKind":"method","role":"symbol","extendedModule":"Auth0","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ssoCredentials"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"parameters"},{"kind":"text","text":": ["},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"text":"], ","kind":"text"},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"preciseIdentifier":"s:5Auth014SSOCredentialsV","kind":"typeIdentifier","text":"SSOCredentials"}],"externalID":"s:5Auth018CredentialsManagerV03ssoB010parameters7headersAA14SSOCredentialsVSDySSypG_SDyS2SGtYaKF"},"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"],"anchor":"Related-Documentation"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanager\/ssocredentials(parameters:headers:)-8vdt4"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ssoCredentials","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"parameters"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"] = [:], "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"] = [:]) "},{"kind":"keyword","text":"async"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth014SSOCredentialsV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials","text":"SSOCredentials"}],"platforms":["iOS"]}]},{"parameters":[{"name":"parameters","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Additional parameters to use."}]}]},{"name":"headers","content":[{"inlineContent":[{"type":"text","text":"Additional headers to use."}],"type":"paragraph"}]}],"kind":"parameters"},{"kind":"content","content":[{"type":"heading","level":2,"text":"Return Value","anchor":"return-value"},{"inlineContent":[{"type":"text","text":"SSO credentials contaning a session transfer token."}],"type":"paragraph"}]},{"kind":"content","content":[{"type":"heading","level":2,"text":"Availability","anchor":"Availability"},{"inlineContent":[{"type":"text","text":"This feature is currently available in"},{"type":"text","text":" "},{"identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","type":"reference","isActive":true},{"type":"text","text":"."},{"type":"text","text":" "},{"type":"text","text":"Please reach out to Auth0 support to get it enabled for your tenant."}],"type":"paragraph"},{"type":"heading","level":2,"text":"Usage","anchor":"Usage"},{"syntax":"swift","code":["do {"," let ssoCredentials = try await credentialsManager.ssoCredentials()"," print(\"Obtained SSO credentials: \\(ssoCredentials)\")","} catch {"," print(\"Failed with: \\(error)\")","}"],"type":"codeListing"},{"inlineContent":[{"type":"text","text":"If you need to specify custom parameters or headers:"}],"type":"paragraph"},{"syntax":"swift","code":["let ssoCredentials = try await credentialsManager.ssoCredentials(parameters: [\"key\": \"value\"],"," headers: [\"key\": \"value\"])"],"type":"codeListing"},{"inlineContent":[{"type":"text","text":"When opening your website on any browser or web view, add the session transfer token to the URL as a query"},{"type":"text","text":" "},{"type":"text","text":"parameter. Then your website can redirect the user to Auth0’s "},{"type":"codeVoice","code":"\/authorize"},{"type":"text","text":" endpoint, passing along the query"},{"type":"text","text":" "},{"type":"text","text":"parameter with the session transfer token. For example,"},{"type":"text","text":" "},{"code":"https:\/\/example.com\/login?session_transfer_token=THE_TOKEN","type":"codeVoice"},{"type":"text","text":"."}],"type":"paragraph"},{"inlineContent":[{"type":"text","text":"If you’re using "},{"code":"WKWebView","type":"codeVoice"},{"type":"text","text":" to open your website, you can place the session transfer token inside a cookie"},{"type":"text","text":" "},{"type":"text","text":"instead. It will be automatically sent to the "},{"code":"\/authorize","type":"codeVoice"},{"type":"text","text":" endpoint."}],"type":"paragraph"},{"syntax":"swift","code":["let cookie = HTTPCookie(properties: ["," .domain: \"YOUR_AUTH0_DOMAIN\", \/\/ Or custom domain, if your website is using one"," .path: \"\/\","," .name: \"auth0_session_transfer_token\","," .value: ssoCredentials.sessionTransferToken,"," .expires: ssoCredentials.expiresIn,"," .secure: true","])!","","webView.configuration.websiteDataStore.httpCookieStore.setCookie(cookie)"],"type":"codeListing"},{"name":"Important","style":"important","type":"aside","content":[{"inlineContent":[{"type":"text","text":"Make sure the cookie’s domain matches the Auth0 domain your "},{"type":"emphasis","inlineContent":[{"type":"text","text":"website"}]},{"type":"text","text":" is using, regardless of the"},{"type":"text","text":" "},{"type":"text","text":"one your mobile app is using. Otherwise, the "},{"type":"codeVoice","code":"\/authorize"},{"type":"text","text":" endpoint will not receive the cookie. If your website"},{"type":"text","text":" "},{"type":"text","text":"is using the provided Auth0 domain (like "},{"type":"codeVoice","code":"example.us.auth0.com"},{"type":"text","text":"), set the cookie’s domain to this value. On the"},{"type":"text","text":" "},{"type":"text","text":"other hand, if your website is using a custom domain, use this value instead."}],"type":"paragraph"}]},{"name":"Throws","style":"note","type":"aside","content":[{"inlineContent":[{"type":"text","text":"An error of type "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","isActive":true},{"type":"text","text":"."}],"type":"paragraph"}]},{"name":"Requires","style":"note","type":"aside","content":[{"inlineContent":[{"type":"text","text":"The scope "},{"type":"codeVoice","code":"offline_access"},{"type":"text","text":" to have been requested on login to get a refresh token from Auth0. If"},{"type":"text","text":" "},{"type":"text","text":"there is no refresh token, the callback will be called with a "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken","isActive":true},{"type":"text","text":" error."}],"type":"paragraph"}]},{"name":"Important","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"}]}]}],"abstract":[{"type":"text","text":"Exchanges the refresh token for a session transfer token that can be used to perform web single sign-on (SSO)."},{"type":"text","text":" "},{"type":"strong","inlineContent":[{"type":"text","text":"This method is thread-safe"}]},{"type":"text","text":"."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/SSOCredentials":{"title":"SSOCredentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials","navigatorTitle":[{"kind":"identifier","text":"SSOCredentials"}],"url":"\/documentation\/auth0\/ssocredentials","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"SSOCredentials"}],"abstract":[{"type":"text","text":"Credentials obtained from Auth0 to perform web single sign-on (SSO)."}],"kind":"symbol","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"kind":"symbol","title":"cause","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier","text":"Error"},{"kind":"text","text":"?"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","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":"."}],"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0/RefreshTokens":{"title":"Refresh Tokens: Common Errors","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens","role":"article","kind":"article","abstract":[],"url":"\/documentation\/auth0\/refreshtokens"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access":{"title":"Early Access","type":"link","titleInlineContent":[{"type":"text","text":"Early Access"}],"identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","url":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/ssoCredentials(parameters:headers:)-8vdt4":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/ssoCredentials(parameters:headers:)-8vdt4","title":"ssoCredentials(parameters:headers:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"ssoCredentials"},{"kind":"text","text":"("},{"kind":"externalParam","text":"parameters"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"]) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth014SSOCredentialsV","text":"SSOCredentials"}],"role":"symbol","url":"\/documentation\/auth0\/credentialsmanager\/ssocredentials(parameters:headers:)-8vdt4","abstract":[{"type":"text","text":"Exchanges the refresh token for a session transfer token that can be used to perform web single sign-on (SSO)."},{"type":"text","text":" "},{"inlineContent":[{"type":"text","text":"This method is thread-safe"}],"type":"strong"},{"type":"text","text":"."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/noRefreshToken":{"title":"noRefreshToken","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"noRefreshToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"}],"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":" "},{"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"}],"url":"\/documentation\/auth0\/credentialsmanagererror\/norefreshtoken"},"https://auth0.com/docs/api/authentication#refresh-token":{"title":"Authentication API Endpoint","type":"link","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"identifier":"https:\/\/auth0.com\/docs\/api\/authentication#refresh-token","url":"https:\/\/auth0.com\/docs\/api\/authentication#refresh-token"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"title":"CredentialsManager","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManager"}],"abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanager","navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"role":"symbol","title":"CredentialsManagerError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerError"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}],"abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","url":"\/documentation\/auth0\/credentialsmanagererror","type":"topic"},"https://auth0.com/docs/secure/tokens/refresh-tokens":{"title":"Refresh Tokens","type":"link","titleInlineContent":[{"type":"text","text":"Refresh Tokens"}],"identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"Credentials","kind":"identifier"}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentialsmanager/ssocredentials(parameters:headers:callback:).json b/docs/data/documentation/auth0/credentialsmanager/ssocredentials(parameters:headers:callback:).json index 6de01e91a..b07ead5a2 100644 --- a/docs/data/documentation/auth0/credentialsmanager/ssocredentials(parameters:headers:callback:).json +++ b/docs/data/documentation/auth0/credentialsmanager/ssocredentials(parameters:headers:callback:).json @@ -1 +1 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/ssoCredentials(parameters:headers:callback:)","interfaceLanguage":"swift"},"metadata":{"title":"ssoCredentials(parameters:headers:callback:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"ssoCredentials"},{"kind":"text","text":"("},{"kind":"externalParam","text":"parameters"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"callback"},{"kind":"text","text":": ("},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth024CredentialsManagerResulta","text":"CredentialsManagerResult"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth014SSOCredentialsV","text":"SSOCredentials"},{"text":">) -> ","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":")","kind":"text"}],"modules":[{"name":"Auth0"}],"roleHeading":"Instance Method","symbolKind":"method","externalID":"s:5Auth018CredentialsManagerV03ssoB010parameters7headers8callbackySDySSypG_SDyS2SGys6ResultOyAA14SSOCredentialsVAA0bC5ErrorVGctF","role":"symbol"},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"ssoCredentials"},{"kind":"text","text":"("},{"text":"parameters","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"] = [:], ","kind":"text"},{"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"},{"text":"callback","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"@escaping","kind":"attribute"},{"text":" (","kind":"text"},{"preciseIdentifier":"s:5Auth024CredentialsManagerResulta","text":"CredentialsManagerResult","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerResult"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth014SSOCredentialsV","text":"SSOCredentials","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials"},{"text":">) -> ","kind":"text"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"text":")","kind":"text"}],"platforms":["iOS"]}]},{"parameters":[{"content":[{"type":"paragraph","inlineContent":[{"text":"Additional parameters to use.","type":"text"}]}],"name":"parameters"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Additional headers to use."}]}],"name":"headers"},{"content":[{"inlineContent":[{"type":"text","text":"Callback that receives a "},{"type":"codeVoice","code":"Result"},{"type":"text","text":" containing either the SSO credentials or an error."}],"type":"paragraph"}],"name":"callback"}],"kind":"parameters"},{"kind":"content","content":[{"level":2,"anchor":"Availability","text":"Availability","type":"heading"},{"inlineContent":[{"type":"text","text":"This feature is currently available in"},{"type":"text","text":" "},{"type":"reference","isActive":true,"identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access"},{"type":"text","text":"."},{"type":"text","text":" "},{"type":"text","text":"Please reach out to Auth0 support to get it enabled for your tenant."}],"type":"paragraph"},{"level":2,"anchor":"Usage","text":"Usage","type":"heading"},{"syntax":"swift","code":["credentialsManager.ssoCredentials { result in"," switch result {"," case .success(let ssoCredentials):"," print(\"Obtained SSO credentials: \\(ssoCredentials)\")"," 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"},{"syntax":"swift","code":["credentialsManager.ssoCredentials(parameters: [\"key\": \"value\"],"," headers: [\"key\": \"value\"]) { print($0) }"],"type":"codeListing"},{"inlineContent":[{"type":"text","text":"When opening your website on any browser or web view, add the session transfer token to the URL as a query"},{"type":"text","text":" "},{"type":"text","text":"parameter. Then your website can redirect the user to Auth0’s "},{"type":"codeVoice","code":"\/authorize"},{"type":"text","text":" endpoint, passing along the query"},{"type":"text","text":" "},{"type":"text","text":"parameter with the session transfer token. For example,"},{"type":"text","text":" "},{"type":"codeVoice","code":"https:\/\/example.com\/login?session_transfer_token=THE_TOKEN"},{"type":"text","text":"."}],"type":"paragraph"},{"inlineContent":[{"text":"If you’re using ","type":"text"},{"code":"WKWebView","type":"codeVoice"},{"text":" to open your website, you can place the session transfer token inside a cookie","type":"text"},{"text":" ","type":"text"},{"text":"instead. It will be automatically sent to the ","type":"text"},{"code":"\/authorize","type":"codeVoice"},{"text":" endpoint.","type":"text"}],"type":"paragraph"},{"syntax":"swift","code":["let cookie = HTTPCookie(properties: ["," .domain: \"YOUR_AUTH0_DOMAIN\", \/\/ Or custom domain, if your website is using one"," .path: \"\/\","," .name: \"auth0_session_transfer_token\","," .value: ssoCredentials.sessionTransferToken,"," .expires: ssoCredentials.expiresIn,"," .secure: true","])!","","webView.configuration.websiteDataStore.httpCookieStore.setCookie(cookie)"],"type":"codeListing"},{"name":"Important","content":[{"inlineContent":[{"type":"text","text":"Make sure the cookie’s domain matches the Auth0 domain your "},{"type":"emphasis","inlineContent":[{"text":"website","type":"text"}]},{"type":"text","text":" is using, regardless of the"},{"type":"text","text":" "},{"type":"text","text":"one your mobile app is using. Otherwise, the "},{"code":"\/authorize","type":"codeVoice"},{"type":"text","text":" endpoint will not receive the cookie. If your website"},{"type":"text","text":" "},{"type":"text","text":"is using the provided Auth0 domain (like "},{"code":"example.us.auth0.com","type":"codeVoice"},{"type":"text","text":"), set the cookie’s domain to this value. On the"},{"type":"text","text":" "},{"type":"text","text":"other hand, if your website is using a custom domain, use this value instead."}],"type":"paragraph"}],"style":"important","type":"aside"},{"style":"note","type":"aside","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The scope "},{"type":"codeVoice","code":"offline_access"},{"type":"text","text":" to have been requested on login to get a refresh token from Auth0. If"},{"type":"text","text":" "},{"type":"text","text":"there is no refresh token, the callback will be called with a "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken","type":"reference","isActive":true},{"type":"text","text":" error."}]}],"name":"Requires"},{"style":"important","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."}]}],"name":"Important"}]}],"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/credentialsmanager\/ssocredentials(parameters:headers:callback:)"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"seeAlsoSections":[{"anchor":"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"],"title":"Related Documentation"}],"abstract":[{"type":"text","text":"Exchanges the refresh token for a session transfer token that can be used to perform web single sign-on (SSO)."},{"type":"text","text":" "},{"type":"strong","inlineContent":[{"text":"This method is thread-safe","type":"text"}]},{"type":"text","text":"."}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access":{"url":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","title":"Early Access","type":"link","titleInlineContent":[{"type":"text","text":"Early Access"}],"identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access"},"doc://com.auth0.Auth0/documentation/Auth0/RefreshTokens":{"url":"\/documentation\/auth0\/refreshtokens","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens","kind":"article","title":"Refresh Tokens: Common Errors","type":"topic","abstract":[],"role":"article"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/SSOCredentials":{"url":"\/documentation\/auth0\/ssocredentials","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"SSOCredentials","kind":"identifier"}],"abstract":[{"type":"text","text":"Credentials obtained from Auth0 to perform web single sign-on (SSO)."}],"role":"symbol","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials","title":"SSOCredentials","type":"topic","navigatorTitle":[{"text":"SSOCredentials","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerResult":{"type":"topic","abstract":[{"type":"codeVoice","code":"Result"},{"type":"text","text":" wrapper for Credentials Manager operations."}],"kind":"symbol","role":"symbol","navigatorTitle":[{"text":"CredentialsManagerResult","kind":"identifier"}],"title":"CredentialsManagerResult","url":"\/documentation\/auth0\/credentialsmanagerresult","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerResult","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerResult"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/noRefreshToken":{"url":"\/documentation\/auth0\/credentialsmanagererror\/norefreshtoken","abstract":[{"type":"text","text":"The stored "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","isActive":true},{"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":"."}],"fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"noRefreshToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"}],"kind":"symbol","type":"topic","title":"noRefreshToken","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"title":"cause","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","kind":"symbol","abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":"?"}],"role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/ssoCredentials(parameters:headers:callback:)":{"url":"\/documentation\/auth0\/credentialsmanager\/ssocredentials(parameters:headers:callback:)","abstract":[{"text":"Exchanges the refresh token for a session transfer token that can be used to perform web single sign-on (SSO).","type":"text"},{"text":" ","type":"text"},{"inlineContent":[{"type":"text","text":"This method is thread-safe"}],"type":"strong"},{"text":".","type":"text"}],"type":"topic","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ssoCredentials","kind":"identifier"},{"text":"(","kind":"text"},{"text":"parameters","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","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"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"], ","kind":"text"},{"text":"callback","kind":"externalParam"},{"text":": (","kind":"text"},{"text":"CredentialsManagerResult","kind":"typeIdentifier","preciseIdentifier":"s:5Auth024CredentialsManagerResulta"},{"text":"<","kind":"text"},{"text":"SSOCredentials","kind":"typeIdentifier","preciseIdentifier":"s:5Auth014SSOCredentialsV"},{"text":">) -> ","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":")","kind":"text"}],"role":"symbol","title":"ssoCredentials(parameters:headers:callback:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/ssoCredentials(parameters:headers:callback:)"},"https://auth0.com/docs/api/authentication#refresh-token":{"url":"https:\/\/auth0.com\/docs\/api\/authentication#refresh-token","type":"link","titleInlineContent":[{"type":"text","text":"Authentication API Endpoint"}],"identifier":"https:\/\/auth0.com\/docs\/api\/authentication#refresh-token","title":"Authentication API Endpoint"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"url":"\/documentation\/auth0\/credentials","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"role":"symbol","type":"topic","abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManager","kind":"identifier"}],"navigatorTitle":[{"text":"CredentialsManager","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","abstract":[{"type":"text","text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain."}],"kind":"symbol","title":"CredentialsManager","url":"\/documentation\/auth0\/credentialsmanager","type":"topic"},"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"}],"url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens"}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanager\/ssocredentials(parameters:headers:callback:)"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"abstract":[{"type":"text","text":"Exchanges the refresh token for a session transfer token that can be used to perform web single sign-on (SSO)."},{"text":" ","type":"text"},{"inlineContent":[{"text":"This method is thread-safe","type":"text"}],"type":"strong"},{"type":"text","text":"."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"ssoCredentials"},{"kind":"text","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"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"] = [:], "},{"text":"callback","kind":"externalParam"},{"kind":"text","text":": "},{"text":"@escaping","kind":"attribute"},{"kind":"text","text":" ("},{"text":"CredentialsManagerResult","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerResult","kind":"typeIdentifier","preciseIdentifier":"s:5Auth024CredentialsManagerResulta"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth014SSOCredentialsV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials","kind":"typeIdentifier","text":"SSOCredentials"},{"kind":"text","text":">) -> "},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":")","kind":"text"}],"platforms":["iOS"]}]},{"kind":"parameters","parameters":[{"name":"parameters","content":[{"inlineContent":[{"type":"text","text":"Additional parameters to use."}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"text":"Additional headers to use.","type":"text"}]}],"name":"headers"},{"content":[{"type":"paragraph","inlineContent":[{"text":"Callback that receives a ","type":"text"},{"code":"Result","type":"codeVoice"},{"type":"text","text":" containing either the SSO credentials or an error."}]}],"name":"callback"}]},{"content":[{"anchor":"Availability","text":"Availability","type":"heading","level":2},{"inlineContent":[{"text":"This feature is currently available in","type":"text"},{"type":"text","text":" "},{"identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","type":"reference","isActive":true},{"text":".","type":"text"},{"type":"text","text":" "},{"type":"text","text":"Please reach out to Auth0 support to get it enabled for your tenant."}],"type":"paragraph"},{"anchor":"Usage","level":2,"text":"Usage","type":"heading"},{"syntax":"swift","code":["credentialsManager.ssoCredentials { result in"," switch result {"," case .success(let ssoCredentials):"," print(\"Obtained SSO credentials: \\(ssoCredentials)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }","}"],"type":"codeListing"},{"inlineContent":[{"text":"If you need to specify custom parameters or headers:","type":"text"}],"type":"paragraph"},{"syntax":"swift","type":"codeListing","code":["credentialsManager.ssoCredentials(parameters: [\"key\": \"value\"],"," headers: [\"key\": \"value\"]) { print($0) }"]},{"inlineContent":[{"type":"text","text":"When opening your website on any browser or web view, add the session transfer token to the URL as a query"},{"type":"text","text":" "},{"type":"text","text":"parameter. Then your website can redirect the user to Auth0’s "},{"type":"codeVoice","code":"\/authorize"},{"text":" endpoint, passing along the query","type":"text"},{"text":" ","type":"text"},{"text":"parameter with the session transfer token. For example,","type":"text"},{"text":" ","type":"text"},{"code":"https:\/\/example.com\/login?session_transfer_token=THE_TOKEN","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"},{"inlineContent":[{"text":"If you’re using ","type":"text"},{"code":"WKWebView","type":"codeVoice"},{"text":" to open your website, you can place the session transfer token inside a cookie","type":"text"},{"text":" ","type":"text"},{"text":"instead. It will be automatically sent to the ","type":"text"},{"type":"codeVoice","code":"\/authorize"},{"text":" endpoint.","type":"text"}],"type":"paragraph"},{"syntax":"swift","type":"codeListing","code":["let cookie = HTTPCookie(properties: ["," .domain: \"YOUR_AUTH0_DOMAIN\", \/\/ Or custom domain, if your website is using one"," .path: \"\/\","," .name: \"auth0_session_transfer_token\","," .value: ssoCredentials.sessionTransferToken,"," .expires: ssoCredentials.expiresIn,"," .secure: true","])!","","webView.configuration.websiteDataStore.httpCookieStore.setCookie(cookie)"]},{"content":[{"inlineContent":[{"type":"text","text":"Make sure the cookie’s domain matches the Auth0 domain your "},{"type":"emphasis","inlineContent":[{"type":"text","text":"website"}]},{"text":" is using, regardless of the","type":"text"},{"text":" ","type":"text"},{"text":"one your mobile app is using. Otherwise, the ","type":"text"},{"code":"\/authorize","type":"codeVoice"},{"type":"text","text":" endpoint will not receive the cookie. If your website"},{"text":" ","type":"text"},{"text":"is using the provided Auth0 domain (like ","type":"text"},{"type":"codeVoice","code":"example.us.auth0.com"},{"text":"), set the cookie’s domain to this value. On the","type":"text"},{"type":"text","text":" "},{"text":"other hand, if your website is using a custom domain, use this value instead.","type":"text"}],"type":"paragraph"}],"style":"important","name":"Important","type":"aside"},{"type":"aside","name":"Requires","content":[{"inlineContent":[{"text":"The scope ","type":"text"},{"code":"offline_access","type":"codeVoice"},{"text":" to have been requested on login to get a refresh token from Auth0. If","type":"text"},{"text":" ","type":"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"},{"text":" error.","type":"text"}],"type":"paragraph"}],"style":"note"},{"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"},{"text":"Credentials Manager instances. The Credentials Manager cannot synchronize requests across instances.","type":"text"}]}],"style":"important"}],"kind":"content"}],"kind":"symbol","schemaVersion":{"major":0,"patch":0,"minor":3},"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"],"anchor":"Related-Documentation"}],"metadata":{"role":"symbol","modules":[{"name":"Auth0"}],"title":"ssoCredentials(parameters:headers:callback:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"ssoCredentials","kind":"identifier"},{"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":"], "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"callback"},{"kind":"text","text":": ("},{"text":"CredentialsManagerResult","preciseIdentifier":"s:5Auth024CredentialsManagerResulta","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"SSOCredentials","preciseIdentifier":"s:5Auth014SSOCredentialsV","kind":"typeIdentifier"},{"text":">) -> ","kind":"text"},{"text":"Void","preciseIdentifier":"s:s4Voida","kind":"typeIdentifier"},{"text":")","kind":"text"}],"externalID":"s:5Auth018CredentialsManagerV03ssoB010parameters7headers8callbackySDySSypG_SDyS2SGys6ResultOyAA14SSOCredentialsVAA0bC5ErrorVGctF","roleHeading":"Instance Method","symbolKind":"method"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/ssoCredentials(parameters:headers:callback:)"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/noRefreshToken":{"title":"noRefreshToken","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"noRefreshToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"}],"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":" "},{"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"}],"url":"\/documentation\/auth0\/credentialsmanagererror\/norefreshtoken"},"doc://com.auth0.Auth0/documentation/Auth0/RefreshTokens":{"title":"Refresh Tokens: Common Errors","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens","role":"article","kind":"article","abstract":[],"url":"\/documentation\/auth0\/refreshtokens"},"https://auth0.com/docs/api/authentication#refresh-token":{"title":"Authentication API Endpoint","titleInlineContent":[{"text":"Authentication API Endpoint","type":"text"}],"type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/authentication#refresh-token","url":"https:\/\/auth0.com\/docs\/api\/authentication#refresh-token"},"doc://com.auth0.Auth0/documentation/Auth0/SSOCredentials":{"title":"SSOCredentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials","navigatorTitle":[{"kind":"identifier","text":"SSOCredentials"}],"url":"\/documentation\/auth0\/ssocredentials","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"SSOCredentials"}],"abstract":[{"type":"text","text":"Credentials obtained from Auth0 to perform web single sign-on (SSO)."}],"kind":"symbol","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerResult":{"kind":"symbol","abstract":[{"code":"Result","type":"codeVoice"},{"text":" wrapper for Credentials Manager operations.","type":"text"}],"type":"topic","title":"CredentialsManagerResult","url":"\/documentation\/auth0\/credentialsmanagerresult","role":"symbol","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerResult"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerResult","navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerResult"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"https://auth0.com/docs/secure/tokens/refresh-tokens":{"title":"Refresh Tokens","titleInlineContent":[{"text":"Refresh Tokens","type":"text"}],"type":"link","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens"},"https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access":{"title":"Early Access","titleInlineContent":[{"text":"Early Access","type":"text"}],"type":"link","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","url":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/ssoCredentials(parameters:headers:callback:)":{"type":"topic","abstract":[{"text":"Exchanges the refresh token for a session transfer token that can be used to perform web single sign-on (SSO).","type":"text"},{"text":" ","type":"text"},{"inlineContent":[{"type":"text","text":"This method is thread-safe"}],"type":"strong"},{"text":".","type":"text"}],"title":"ssoCredentials(parameters:headers:callback:)","kind":"symbol","url":"\/documentation\/auth0\/credentialsmanager\/ssocredentials(parameters:headers:callback:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ssoCredentials","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"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"callback"},{"kind":"text","text":": ("},{"text":"CredentialsManagerResult","preciseIdentifier":"s:5Auth024CredentialsManagerResulta","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth014SSOCredentialsV","kind":"typeIdentifier","text":"SSOCredentials"},{"text":">) -> ","kind":"text"},{"text":"Void","preciseIdentifier":"s:s4Voida","kind":"typeIdentifier"},{"text":")","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/ssoCredentials(parameters:headers:callback:)"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"title":"CredentialsManager","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManager"}],"abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanager","navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}]},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"kind":"symbol","title":"cause","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier","text":"Error"},{"kind":"text","text":"?"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","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":"."}],"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"Credentials","kind":"identifier"}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentialsmanager/store(apicredentials:foraudience:forscope:).json b/docs/data/documentation/auth0/credentialsmanager/store(apicredentials:foraudience:forscope:).json new file mode 100644 index 000000000..264bc84d2 --- /dev/null +++ b/docs/data/documentation/auth0/credentialsmanager/store(apicredentials:foraudience:forscope:).json @@ -0,0 +1 @@ +{"variants":[{"paths":["\/documentation\/auth0\/credentialsmanager\/store(apicredentials:foraudience:forscope:)"],"traits":[{"interfaceLanguage":"swift"}]}],"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":"apiCredentials","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth014APICredentialsV","text":"APICredentials","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials"},{"text":", ","kind":"text"},{"text":"forAudience","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"audience","kind":"internalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"forScope","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"scope","kind":"internalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"? = nil) -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","sections":[],"metadata":{"externalID":"s:5Auth018CredentialsManagerV5store03apiB011forAudience0F5ScopeSbAA14APICredentialsV_S2SSgtF","symbolKind":"method","title":"store(apiCredentials:forAudience:forScope:)","roleHeading":"Instance Method","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"store"},{"kind":"text","text":"("},{"kind":"externalParam","text":"apiCredentials"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth014APICredentialsV","text":"APICredentials"},{"kind":"text","text":", "},{"kind":"externalParam","text":"forAudience"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"forScope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?) -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"modules":[{"name":"Auth0"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/store(apiCredentials:forAudience:forScope:)","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/store(apiCredentials:forAudience:forScope:)":{"type":"topic","title":"store(apiCredentials:forAudience:forScope:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/store(apiCredentials:forAudience:forScope:)","url":"\/documentation\/auth0\/credentialsmanager\/store(apicredentials:foraudience:forscope:)","abstract":[],"kind":"symbol","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"store","kind":"identifier"},{"text":"(","kind":"text"},{"text":"apiCredentials","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"APICredentials","kind":"typeIdentifier","preciseIdentifier":"s:5Auth014APICredentialsV"},{"text":", ","kind":"text"},{"text":"forAudience","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"forScope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?) -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"title":"CredentialsManager","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManager"}],"abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanager","navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}]},"doc://com.auth0.Auth0/documentation/Auth0/APICredentials":{"role":"symbol","title":"APICredentials","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"APICredentials"}],"navigatorTitle":[{"kind":"identifier","text":"APICredentials"}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0 for a specific API as the result of exchanging a refresh token."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/APICredentials","url":"\/documentation\/auth0\/apicredentials","type":"topic"}}} \ 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 a3688c865..2c4475609 100644 --- a/docs/data/documentation/auth0/credentialsmanager/store(credentials:).json +++ b/docs/data/documentation/auth0/credentialsmanager/store(credentials:).json @@ -1 +1 @@ -{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/store(credentials:)"},"metadata":{"externalID":"s:5Auth018CredentialsManagerV5store11credentialsSbAA0B0C_tF","symbolKind":"method","roleHeading":"Instance Method","modules":[{"name":"Auth0"}],"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"store","kind":"identifier"},{"text":"(","kind":"text"},{"text":"credentials","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"title":"store(credentials:)"},"kind":"symbol","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":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"store"},{"kind":"text","text":"("},{"kind":"externalParam","text":"credentials"},{"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:Sb","kind":"typeIdentifier","text":"Bool"}],"platforms":["iOS"],"languages":["swift"]}]},{"parameters":[{"content":[{"inlineContent":[{"text":"","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","type":"reference"},{"text":" instance to store.","type":"text"}],"type":"paragraph"}],"name":"credentials"}],"kind":"parameters"},{"kind":"content","content":[{"text":"Return Value","type":"heading","level":2,"anchor":"return-value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"If the credentials were stored."}]}]},{"kind":"content","content":[{"anchor":"Usage","text":"Usage","type":"heading","level":2},{"type":"codeListing","syntax":"swift","code":["let didStore = credentialsManager.store(credentials: credentials)"]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanager\/store(credentials:)"]}],"sections":[],"abstract":[{"text":"Stores a ","type":"text"},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"},{"text":" instance in the Keychain.","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"url":"\/documentation\/auth0\/credentials","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"role":"symbol","type":"topic","abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManager","kind":"identifier"}],"navigatorTitle":[{"text":"CredentialsManager","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","abstract":[{"type":"text","text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain."}],"kind":"symbol","title":"CredentialsManager","url":"\/documentation\/auth0\/credentialsmanager","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/store(credentials:)":{"abstract":[{"type":"text","text":"Stores a "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","isActive":true},{"type":"text","text":" instance in the Keychain."}],"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/credentialsmanager\/store(credentials:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/store(credentials:)","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"store"},{"kind":"text","text":"("},{"kind":"externalParam","text":"credentials"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"title":"store(credentials:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"variants":[{"paths":["\/documentation\/auth0\/credentialsmanager\/store(credentials:)"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"abstract":[{"text":"Stores a ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","isActive":true,"type":"reference"},{"text":" instance in the Keychain.","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"store","kind":"identifier"},{"text":"(","kind":"text"},{"text":"credentials","kind":"externalParam"},{"text":": ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","text":"Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"platforms":["iOS"]}]},{"parameters":[{"name":"credentials","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":""},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","isActive":true},{"type":"text","text":" instance to store."}]}]}],"kind":"parameters"},{"kind":"content","content":[{"level":2,"text":"Return Value","type":"heading","anchor":"return-value"},{"inlineContent":[{"type":"text","text":"If the credentials were stored."}],"type":"paragraph"}]},{"kind":"content","content":[{"level":2,"text":"Usage","type":"heading","anchor":"Usage"},{"code":["let didStore = credentialsManager.store(credentials: credentials)"],"syntax":"swift","type":"codeListing"}]}],"kind":"symbol","schemaVersion":{"patch":0,"minor":3,"major":0},"sections":[],"metadata":{"externalID":"s:5Auth018CredentialsManagerV5store11credentialsSbAA0B0C_tF","symbolKind":"method","title":"store(credentials:)","roleHeading":"Instance Method","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"store","kind":"identifier"},{"text":"(","kind":"text"},{"text":"credentials","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"modules":[{"name":"Auth0"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/store(credentials:)","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"Credentials","kind":"identifier"}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"title":"CredentialsManager","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManager"}],"abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanager","navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}]},"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","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"store"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"credentials"},{"kind":"text","text":": "},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","text":"Credentials"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"abstract":[{"type":"text","text":"Stores a "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","isActive":true},{"type":"text","text":" instance in the Keychain."}],"url":"\/documentation\/auth0\/credentialsmanager\/store(credentials:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ 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 b7514f4a5..5b5b8b643 100644 --- a/docs/data/documentation/auth0/credentialsmanager/user.json +++ b/docs/data/documentation/auth0/credentialsmanager/user.json @@ -1 +1 @@ -{"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"user"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"UserInfo","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","preciseIdentifier":"s:5Auth08UserInfoV"},{"kind":"text","text":"? { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"},{"content":[{"level":2,"text":"Usage","type":"heading","anchor":"Usage"},{"syntax":"swift","type":"codeListing","code":["let user = credentialsManager.user"]},{"name":"Important","content":[{"inlineContent":[{"type":"text","text":"Access to this property will not be protected by biometric authentication."}],"type":"paragraph"}],"type":"aside","style":"important"}],"kind":"content"}],"variants":[{"paths":["\/documentation\/auth0\/credentialsmanager\/user"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/user","interfaceLanguage":"swift"},"schemaVersion":{"minor":3,"major":0,"patch":0},"abstract":[{"text":"Retrieves the user information from the Keychain synchronously, without checking if the credentials are expired.","type":"text"},{"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"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"kind":"symbol","sections":[],"metadata":{"externalID":"s:5Auth018CredentialsManagerV4userAA8UserInfoVSgvp","modules":[{"name":"Auth0"}],"role":"symbol","title":"user","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"user"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"UserInfo","preciseIdentifier":"s:5Auth08UserInfoV"},{"kind":"text","text":"?"}],"symbolKind":"property","roleHeading":"Instance Property"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManager","kind":"identifier"}],"navigatorTitle":[{"text":"CredentialsManager","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","abstract":[{"type":"text","text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain."}],"kind":"symbol","title":"CredentialsManager","url":"\/documentation\/auth0\/credentialsmanager","type":"topic"},"doc://com.auth0.Auth0/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."},{"type":"text","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"},{"type":"text","text":"."}],"title":"user","url":"\/documentation\/auth0\/credentialsmanager\/user","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"user","kind":"identifier"},{"text":": ","kind":"text"},{"text":"UserInfo","kind":"typeIdentifier","preciseIdentifier":"s:5Auth08UserInfoV"},{"text":"?","kind":"text"}],"type":"topic","kind":"symbol","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"text":"UserInfo","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/userinfo","type":"topic","title":"UserInfo","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"https://auth0.com/docs/secure/tokens/id-tokens":{"type":"link","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens","title":"ID token","titleInlineContent":[{"type":"text","text":"ID token"}],"url":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens"}}} \ No newline at end of file +{"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/user"},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"user"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"UserInfo","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","preciseIdentifier":"s:5Auth08UserInfoV"},{"kind":"text","text":"? { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"platforms":["iOS"],"languages":["swift"]}]},{"content":[{"anchor":"Usage","text":"Usage","type":"heading","level":2},{"syntax":"swift","type":"codeListing","code":["let user = credentialsManager.user"]},{"type":"aside","name":"Important","content":[{"inlineContent":[{"text":"Access to this property will not be protected by biometric authentication.","type":"text"}],"type":"paragraph"}],"style":"important"}],"kind":"content"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanager\/user"]}],"kind":"symbol","metadata":{"modules":[{"name":"Auth0"}],"title":"user","externalID":"s:5Auth018CredentialsManagerV4userAA8UserInfoVSgvp","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"user","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth08UserInfoV","text":"UserInfo","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"symbolKind":"property","roleHeading":"Instance Property"},"schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"text":"Retrieves the user information from the Keychain synchronously, without checking if the credentials are expired.","type":"text"},{"text":" ","type":"text"},{"text":"The user information is read from the stored ","type":"text"},{"type":"reference","isActive":true,"identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens"},{"type":"text","text":"."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/user":{"kind":"symbol","abstract":[{"text":"Retrieves the user information from the Keychain synchronously, without checking if the credentials are expired.","type":"text"},{"text":" ","type":"text"},{"text":"The user information is read from the stored ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens","isActive":true,"type":"reference"},{"type":"text","text":"."}],"type":"topic","title":"user","url":"\/documentation\/auth0\/credentialsmanager\/user","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"user","kind":"identifier"},{"text":": ","kind":"text"},{"text":"UserInfo","preciseIdentifier":"s:5Auth08UserInfoV","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/user"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"title":"CredentialsManager","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManager"}],"abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanager","navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}]},"https://auth0.com/docs/secure/tokens/id-tokens":{"title":"ID token","titleInlineContent":[{"type":"text","text":"ID token"}],"type":"link","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"title":"UserInfo","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"UserInfo"}],"abstract":[{"text":"OIDC Standard Claims user information.","type":"text"}],"url":"\/documentation\/auth0\/userinfo","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentialsmanagererror.json b/docs/data/documentation/auth0/credentialsmanagererror.json index 63d4359ec..36b9c60e4 100644 --- a/docs/data/documentation/auth0/credentialsmanagererror.json +++ b/docs/data/documentation/auth0/credentialsmanagererror.json @@ -1 +1 @@ -{"topicSections":[{"anchor":"Operators","title":"Operators","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/~=(_:_:)-7k0od","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/~=(_:_:)-93ixe"],"generated":true},{"anchor":"Instance-Properties","title":"Instance Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/cause","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/debugDescription"],"generated":true},{"anchor":"Type-Properties","title":"Type Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/apiExchangeFailed","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\/ssoExchangeFailed","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/storeFailed"],"generated":true},{"anchor":"Default-Implementations","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}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"relationshipsSections":[{"title":"Conforms To","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","doc:\/\/com.auth0.Auth0\/10Foundation14LocalizedErrorP","doc:\/\/com.auth0.Auth0\/s8CopyableP","doc:\/\/com.auth0.Auth0\/s28CustomDebugStringConvertibleP","doc:\/\/com.auth0.Auth0\/SQ","doc:\/\/com.auth0.Auth0\/s5ErrorP","doc:\/\/com.auth0.Auth0\/s8SendableP","doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP"],"type":"conformsTo","kind":"relationships"}],"schemaVersion":{"minor":3,"major":0,"patch":0},"sections":[],"metadata":{"symbolKind":"struct","modules":[{"name":"Auth0"}],"roleHeading":"Structure","role":"symbol","externalID":"s:5Auth023CredentialsManagerErrorV","title":"CredentialsManagerError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}]},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"variants":[{"paths":["\/documentation\/auth0\/credentialsmanagererror"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"references":{"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"}],"title":"~=(_:_:)","url":"\/documentation\/auth0\/credentialsmanagererror\/~=(_:_:)-7k0od","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"~=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/~=(_:_:)-7k0od","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/debugDescription":{"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"debugDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"type":"topic","title":"debugDescription","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/debugDescription","url":"\/documentation\/auth0\/credentialsmanagererror\/debugdescription","kind":"symbol","abstract":[{"type":"text","text":"Description of the error."}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/LocalizedError-Implementations":{"abstract":[],"title":"LocalizedError Implementations","kind":"article","type":"topic","role":"collectionGroup","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/LocalizedError-Implementations","url":"\/documentation\/auth0\/credentialsmanagererror\/localizederror-implementations"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/noCredentials":{"title":"noCredentials","url":"\/documentation\/auth0\/credentialsmanagererror\/nocredentials","kind":"symbol","role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noCredentials","abstract":[{"text":"No credentials were found in the store.","type":"text"},{"text":" ","type":"text"},{"text":"This error does not include a ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference"},{"text":".","type":"text"}],"fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"noCredentials"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"}]},"doc://com.auth0.Auth0/SQ":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/SQ","title":"Swift.Equatable"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"url":"\/documentation\/auth0\/credentialsmanagererror","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}],"title":"CredentialsManagerError","kind":"symbol","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/Equatable-Implementations":{"abstract":[],"title":"Equatable Implementations","kind":"article","type":"topic","role":"collectionGroup","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/Equatable-Implementations","url":"\/documentation\/auth0\/credentialsmanagererror\/equatable-implementations"},"doc://com.auth0.Auth0/s16SendableMetatypeP":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP","title":"Swift.SendableMetatype"},"https://manage.auth0.com/#/apis/":{"title":"Auth0 API","url":"https:\/\/manage.auth0.com\/#\/apis\/","identifier":"https:\/\/manage.auth0.com\/#\/apis\/","type":"link","titleInlineContent":[{"text":"Auth0 API","type":"text"}]},"doc://com.auth0.Auth0/s8CopyableP":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s8CopyableP","title":"Swift.Copyable"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/revokeFailed":{"type":"topic","title":"revokeFailed","kind":"symbol","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/revokeFailed","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"revokeFailed"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","kind":"typeIdentifier","text":"CredentialsManagerError"}],"url":"\/documentation\/auth0\/credentialsmanagererror\/revokefailed","abstract":[{"text":"The revocation of the refresh token failed.","type":"text"},{"text":" ","type":"text"},{"text":"The underlying ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","isActive":true,"type":"reference"},{"text":" can be accessed via the ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true,"type":"reference"},{"text":" property.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/~=(_:_:)-93ixe":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/~=(_:_:)-93ixe","kind":"symbol","abstract":[{"type":"text","text":"Matches "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" values in a switch statement."}],"url":"\/documentation\/auth0\/credentialsmanagererror\/~=(_:_:)-93ixe","role":"symbol","type":"topic","title":"~=(_:_:)","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"~=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"CredentialsManagerError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"},{"text":", ","kind":"text"},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/noRefreshToken":{"url":"\/documentation\/auth0\/credentialsmanagererror\/norefreshtoken","abstract":[{"type":"text","text":"The stored "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","isActive":true},{"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":"."}],"fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"noRefreshToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"}],"kind":"symbol","type":"topic","title":"noRefreshToken","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken"},"doc://com.auth0.Auth0/10Foundation14LocalizedErrorP":{"title":"Foundation.LocalizedError","identifier":"doc:\/\/com.auth0.Auth0\/10Foundation14LocalizedErrorP","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/largeMinTTL":{"kind":"symbol","role":"symbol","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 "},{"inlineContent":[{"type":"text","text":"Token Expiration"}],"type":"strong"},{"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":" "},{"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":"."}],"fragments":[{"kind":"keyword","text":"static"},{"kind":"text","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","title":"largeMinTTL","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/largeMinTTL"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/apiExchangeFailed":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/apiExchangeFailed","abstract":[{"text":"The exchange of the refresh token for API credentials failed.","type":"text"},{"text":" ","type":"text"},{"text":"The underlying ","type":"text"},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","isActive":true},{"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"}],"type":"topic","title":"apiExchangeFailed","url":"\/documentation\/auth0\/credentialsmanagererror\/apiexchangefailed","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"apiExchangeFailed"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"url":"\/documentation\/auth0\/credentials","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"role":"symbol","type":"topic","abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/storeFailed":{"kind":"symbol","abstract":[{"text":"Storing the renewed credentials failed.","type":"text"},{"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"},{"text":".","type":"text"}],"type":"topic","role":"symbol","title":"storeFailed","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"storeFailed","kind":"identifier"},{"text":": ","kind":"text"},{"text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/storeFailed","url":"\/documentation\/auth0\/credentialsmanagererror\/storefailed"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/renewFailed":{"fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"renewFailed","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","kind":"typeIdentifier"}],"title":"renewFailed","type":"topic","kind":"symbol","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"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","type":"reference"},{"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"}],"url":"\/documentation\/auth0\/credentialsmanagererror\/renewfailed"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/s8SendableP":{"type":"unresolvable","title":"Swift.Sendable","identifier":"doc:\/\/com.auth0.Auth0\/s8SendableP"},"doc://com.auth0.Auth0/s5ErrorP":{"identifier":"doc:\/\/com.auth0.Auth0\/s5ErrorP","type":"unresolvable","title":"Swift.Error"},"doc://com.auth0.Auth0/s28CustomDebugStringConvertibleP":{"type":"unresolvable","title":"Swift.CustomDebugStringConvertible","identifier":"doc:\/\/com.auth0.Auth0\/s28CustomDebugStringConvertibleP"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/ssoExchangeFailed":{"url":"\/documentation\/auth0\/credentialsmanagererror\/ssoexchangefailed","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"ssoExchangeFailed"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"}],"type":"topic","abstract":[{"type":"text","text":"The exchange of the refresh token for SSO credentials failed."},{"type":"text","text":" "},{"type":"text","text":"The underlying "},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","type":"reference"},{"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."}],"title":"ssoExchangeFailed","kind":"symbol","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/ssoExchangeFailed"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error":{"url":"\/documentation\/auth0\/auth0error","title":"Auth0Error","kind":"symbol","type":"topic","abstract":[{"type":"text","text":"Generic representation of Auth0 errors."}],"role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Auth0Error"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","navigatorTitle":[{"kind":"identifier","text":"Auth0Error"}]},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"title":"cause","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","kind":"symbol","abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":"?"}],"role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/Auth0Error-Implementations":{"role":"collectionGroup","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/Auth0Error-Implementations","type":"topic","kind":"article","url":"\/documentation\/auth0\/credentialsmanagererror\/auth0error-implementations","title":"Auth0Error Implementations"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/cause":{"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier","text":"Error"},{"kind":"text","text":"?"}],"abstract":[{"text":"The underlying ","type":"text"},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/cause","type":"topic","title":"cause","kind":"symbol","role":"symbol","url":"\/documentation\/auth0\/credentialsmanagererror\/cause"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/biometricsFailed":{"fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"biometricsFailed"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/biometricsFailed","abstract":[{"text":"The biometric authentication failed.","type":"text"},{"text":" ","type":"text"},{"text":"The underlying ","type":"text"},{"code":"LAError","type":"codeVoice"},{"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"}],"kind":"symbol","role":"symbol","title":"biometricsFailed","url":"\/documentation\/auth0\/credentialsmanagererror\/biometricsfailed","type":"topic"}}} \ No newline at end of file +{"sections":[],"metadata":{"symbolKind":"struct","title":"CredentialsManagerError","externalID":"s:5Auth023CredentialsManagerErrorV","roleHeading":"Structure","modules":[{"name":"Auth0"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}],"role":"symbol","navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}]},"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"},"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/~=(_:_:)-7k0od","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/~=(_:_:)-93ixe"],"generated":true,"title":"Operators","anchor":"Operators"},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/cause","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/debugDescription","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/message"],"generated":true,"title":"Instance Properties","anchor":"Instance-Properties"},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/apiExchangeFailed","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\/ssoExchangeFailed","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/storeFailed"],"generated":true,"title":"Type Properties","anchor":"Type-Properties"},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/Auth0Error-Implementations","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/Equatable-Implementations","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/LocalizedError-Implementations"],"generated":true,"title":"Default Implementations","anchor":"Default-Implementations"}],"relationshipsSections":[{"title":"Conforms To","kind":"relationships","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","doc:\/\/com.auth0.Auth0\/10Foundation14LocalizedErrorP","doc:\/\/com.auth0.Auth0\/s8CopyableP","doc:\/\/com.auth0.Auth0\/s28CustomDebugStringConvertibleP","doc:\/\/com.auth0.Auth0\/SQ","doc:\/\/com.auth0.Auth0\/s5ErrorP","doc:\/\/com.auth0.Auth0\/s8SendableP","doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP"],"type":"conformsTo"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanagererror"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}],"platforms":["iOS"]}],"kind":"declarations"}],"abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/noRefreshToken":{"title":"noRefreshToken","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"noRefreshToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"}],"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":" "},{"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"}],"url":"\/documentation\/auth0\/credentialsmanagererror\/norefreshtoken"},"doc://com.auth0.Auth0/s5ErrorP":{"identifier":"doc:\/\/com.auth0.Auth0\/s5ErrorP","type":"unresolvable","title":"Swift.Error"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/Equatable-Implementations":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/Equatable-Implementations","kind":"article","title":"Equatable Implementations","role":"collectionGroup","url":"\/documentation\/auth0\/credentialsmanagererror\/equatable-implementations","abstract":[],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/~=(_:_:)-93ixe":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/~=(_:_:)-93ixe","kind":"symbol","title":"~=(_:_:)","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"~="},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:s5ErrorP","text":"Error","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"role":"symbol","url":"\/documentation\/auth0\/credentialsmanagererror\/~=(_:_:)-93ixe","abstract":[{"type":"text","text":"Matches "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" values in a switch statement."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/ssoExchangeFailed":{"role":"symbol","title":"ssoExchangeFailed","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"ssoExchangeFailed"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"}],"abstract":[{"type":"text","text":"The exchange of the refresh token for SSO credentials 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","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true},{"type":"text","text":" property."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/ssoExchangeFailed","url":"\/documentation\/auth0\/credentialsmanagererror\/ssoexchangefailed","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"kind":"symbol","title":"cause","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier","text":"Error"},{"kind":"text","text":"?"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","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":"."}],"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi"},"doc://com.auth0.Auth0/SQ":{"identifier":"doc:\/\/com.auth0.Auth0\/SQ","type":"unresolvable","title":"Swift.Equatable"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/debugDescription":{"kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"debugDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"title":"debugDescription","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Description of the error."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/debugDescription","url":"\/documentation\/auth0\/credentialsmanagererror\/debugdescription"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"role":"symbol","title":"CredentialsManagerError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerError"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}],"abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","url":"\/documentation\/auth0\/credentialsmanagererror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/LocalizedError-Implementations":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/LocalizedError-Implementations","kind":"article","title":"LocalizedError Implementations","role":"collectionGroup","url":"\/documentation\/auth0\/credentialsmanagererror\/localizederror-implementations","abstract":[],"type":"topic"},"https://manage.auth0.com/#/apis/":{"identifier":"https:\/\/manage.auth0.com\/#\/apis\/","type":"link","title":"Auth0 API","titleInlineContent":[{"text":"Auth0 API","type":"text"}],"url":"https:\/\/manage.auth0.com\/#\/apis\/"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/Auth0Error-Implementations":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/Auth0Error-Implementations","kind":"article","title":"Auth0Error Implementations","role":"collectionGroup","url":"\/documentation\/auth0\/credentialsmanagererror\/auth0error-implementations","abstract":[],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/biometricsFailed":{"type":"topic","abstract":[{"text":"The biometric authentication failed.","type":"text"},{"text":" ","type":"text"},{"text":"The underlying ","type":"text"},{"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."}],"kind":"symbol","url":"\/documentation\/auth0\/credentialsmanagererror\/biometricsfailed","title":"biometricsFailed","role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"biometricsFailed","kind":"identifier"},{"text":": ","kind":"text"},{"text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/biometricsFailed"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"Credentials","kind":"identifier"}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}]},"doc://com.auth0.Auth0/s16SendableMetatypeP":{"identifier":"doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP","type":"unresolvable","title":"Swift.SendableMetatype"},"doc://com.auth0.Auth0/s28CustomDebugStringConvertibleP":{"identifier":"doc:\/\/com.auth0.Auth0\/s28CustomDebugStringConvertibleP","type":"unresolvable","title":"Swift.CustomDebugStringConvertible"},"doc://com.auth0.Auth0/10Foundation14LocalizedErrorP":{"identifier":"doc:\/\/com.auth0.Auth0\/10Foundation14LocalizedErrorP","type":"unresolvable","title":"Foundation.LocalizedError"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/cause":{"kind":"symbol","title":"cause","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP","text":"Error"},{"kind":"text","text":"?"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/cause","abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"url":"\/documentation\/auth0\/credentialsmanagererror\/cause"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/message":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/message","kind":"symbol","title":"message","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"message","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"role":"symbol","url":"\/documentation\/auth0\/credentialsmanagererror\/message","abstract":[],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/noCredentials":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noCredentials","kind":"symbol","title":"noCredentials","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"noCredentials","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","kind":"typeIdentifier"}],"role":"symbol","url":"\/documentation\/auth0\/credentialsmanagererror\/nocredentials","abstract":[{"text":"No credentials were found in the store.","type":"text"},{"text":" ","type":"text"},{"text":"This error does not include a ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference","isActive":true},{"text":".","type":"text"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/renewFailed":{"type":"topic","title":"renewFailed","url":"\/documentation\/auth0\/credentialsmanagererror\/renewfailed","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/renewFailed","abstract":[{"text":"The credentials renewal failed.","type":"text"},{"text":" ","type":"text"},{"text":"The underlying ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","isActive":true,"type":"reference"},{"text":" can be accessed via the ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true,"type":"reference"},{"text":" property.","type":"text"}],"role":"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","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"}]},"doc://com.auth0.Auth0/s8CopyableP":{"identifier":"doc:\/\/com.auth0.Auth0\/s8CopyableP","type":"unresolvable","title":"Swift.Copyable"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/largeMinTTL":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/largeMinTTL","title":"largeMinTTL","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"largeMinTTL","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","kind":"typeIdentifier"}],"role":"symbol","url":"\/documentation\/auth0\/credentialsmanagererror\/largeminttl","abstract":[{"text":"The ","type":"text"},{"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"},{"text":" or","type":"text"},{"text":" ","type":"text"},{"text":"increase the ","type":"text"},{"inlineContent":[{"text":"Token Expiration","type":"text"}],"type":"strong"},{"text":" value in the settings page of your ","type":"text"},{"isActive":true,"identifier":"https:\/\/manage.auth0.com\/#\/apis\/","type":"reference"},{"text":".","type":"text"},{"text":" ","type":"text"},{"text":"This error does not include a ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference"},{"text":".","type":"text"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/revokeFailed":{"type":"topic","abstract":[{"type":"text","text":"The revocation of the refresh token 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","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true},{"type":"text","text":" property."}],"title":"revokeFailed","kind":"symbol","url":"\/documentation\/auth0\/credentialsmanagererror\/revokefailed","role":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"revokeFailed"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/revokeFailed"},"doc://com.auth0.Auth0/s8SendableP":{"identifier":"doc:\/\/com.auth0.Auth0\/s8SendableP","type":"unresolvable","title":"Swift.Sendable"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/apiExchangeFailed":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/apiExchangeFailed","kind":"symbol","title":"apiExchangeFailed","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"apiExchangeFailed","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","kind":"typeIdentifier"}],"role":"symbol","url":"\/documentation\/auth0\/credentialsmanagererror\/apiexchangefailed","abstract":[{"text":"The exchange of the refresh token for API credentials failed.","type":"text"},{"text":" ","type":"text"},{"text":"The underlying ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","type":"reference"},{"text":" can be accessed via the ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference"},{"text":" property.","type":"text"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error":{"url":"\/documentation\/auth0\/auth0error","title":"Auth0Error","abstract":[{"type":"text","text":"Generic representation of Auth0 errors."}],"navigatorTitle":[{"kind":"identifier","text":"Auth0Error"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Auth0Error"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/~=(_:_:)-7k0od":{"type":"topic","title":"~=(_:_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/~=(_:_:)-7k0od","kind":"symbol","url":"\/documentation\/auth0\/credentialsmanagererror\/~=(_:_:)-7k0od","abstract":[{"text":"Matches ","type":"text"},{"code":"CredentialsManagerError","type":"codeVoice"},{"text":" values in a switch statement.","type":"text"}],"role":"symbol","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","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/storeFailed":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/storeFailed","kind":"symbol","title":"storeFailed","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"storeFailed","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","kind":"typeIdentifier"}],"role":"symbol","url":"\/documentation\/auth0\/credentialsmanagererror\/storefailed","abstract":[{"text":"Storing the renewed credentials failed.","type":"text"},{"text":" ","type":"text"},{"text":"This error does not include a ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference"},{"text":".","type":"text"}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentialsmanagererror/!=(_:_:).json b/docs/data/documentation/auth0/credentialsmanagererror/!=(_:_:).json index 7f7852bb3..51596674b 100644 --- a/docs/data/documentation/auth0/credentialsmanagererror/!=(_:_:).json +++ b/docs/data/documentation/auth0/credentialsmanagererror/!=(_:_:).json @@ -1 +1 @@ -{"metadata":{"fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"extendedModule":"Swift","role":"symbol","title":"!=(_:_:)","modules":[{"relatedModules":["Swift"],"name":"Auth0"}],"roleHeading":"Operator","symbolKind":"op","externalID":"s:SQsE2neoiySbx_xtFZ::SYNTHESIZED::s:5Auth023CredentialsManagerErrorV"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanagererror\/!=(_:_:)"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/!=(_:_:)","interfaceLanguage":"swift"},"kind":"symbol","sections":[],"schemaVersion":{"minor":3,"major":0,"patch":0},"abstract":[{"text":"Inherited from ","type":"text"},{"code":"Equatable.!=(_:_:)","type":"codeVoice"},{"text":".","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"!="},{"kind":"text","text":" "},{"kind":"text","text":"("},{"kind":"internalParam","text":"lhs"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":", "},{"text":"rhs","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"platforms":["iOS"],"languages":["swift"]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"url":"\/documentation\/auth0\/credentialsmanagererror","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}],"title":"CredentialsManagerError","kind":"symbol","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/!=(_:_:)":{"title":"!=(_:_:)","url":"\/documentation\/auth0\/credentialsmanagererror\/!=(_:_:)","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/!=(_:_:)","abstract":[],"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","text":"Self"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"kind":"symbol","role":"symbol"}}} \ No newline at end of file +{"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/!=(_:_:)","interfaceLanguage":"swift"},"kind":"symbol","metadata":{"externalID":"s:SQsE2neoiySbx_xtFZ::SYNTHESIZED::s:5Auth023CredentialsManagerErrorV","modules":[{"name":"Auth0","relatedModules":["Swift"]}],"title":"!=(_:_:)","extendedModule":"Swift","roleHeading":"Operator","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","text":"Self"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"role":"symbol","symbolKind":"op"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanagererror\/!=(_:_:)"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"!="},{"kind":"text","text":" "},{"kind":"text","text":"("},{"kind":"internalParam","text":"lhs"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":", "},{"kind":"internalParam","text":"rhs"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}]}],"kind":"declarations"}],"abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"Equatable.!=(_:_:)"},{"type":"text","text":"."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/!=(_:_:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/!=(_:_:)","kind":"symbol","title":"!=(_:_:)","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","text":"Self"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"role":"symbol","url":"\/documentation\/auth0\/credentialsmanagererror\/!=(_:_:)","abstract":[],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"role":"symbol","title":"CredentialsManagerError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerError"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}],"abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","url":"\/documentation\/auth0\/credentialsmanagererror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentialsmanagererror/==(_:_:).json b/docs/data/documentation/auth0/credentialsmanagererror/==(_:_:).json index f3b6fd4ef..f4ef69cb5 100644 --- a/docs/data/documentation/auth0/credentialsmanagererror/==(_:_:).json +++ b/docs/data/documentation/auth0/credentialsmanagererror/==(_:_:).json @@ -1 +1 @@ -{"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanagererror\/==(_:_:)"]}],"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"modules":[{"name":"Auth0"}],"externalID":"s:5Auth023CredentialsManagerErrorV2eeoiySbAC_ACtFZ","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"==","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"CredentialsManagerError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"},{"text":", ","kind":"text"},{"text":"CredentialsManagerError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"extendedModule":"Auth0","title":"==(_:_:)","symbolKind":"op","role":"symbol","roleHeading":"Operator"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"abstract":[{"type":"text","text":"Conformance to "},{"code":"Equatable","type":"codeVoice"},{"type":"text","text":"."}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/==(_:_:)"},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"=="},{"kind":"text","text":" "},{"kind":"text","text":"("},{"kind":"internalParam","text":"lhs"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"},{"kind":"text","text":", "},{"text":"rhs","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"},{"text":") -> ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"platforms":["iOS"],"languages":["swift"]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"url":"\/documentation\/auth0\/credentialsmanagererror","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}],"title":"CredentialsManagerError","kind":"symbol","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/==(_:_:)":{"url":"\/documentation\/auth0\/credentialsmanagererror\/==(_:_:)","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"==","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"kind":"symbol","abstract":[{"type":"text","text":"Conformance to "},{"code":"Equatable","type":"codeVoice"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/==(_:_:)","title":"==(_:_:)","type":"topic","role":"symbol"}}} \ No newline at end of file +{"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"==","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"lhs","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"CredentialsManagerError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"},{"text":", ","kind":"text"},{"text":"rhs","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"CredentialsManagerError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"},{"text":") -> ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanagererror\/==(_:_:)"]}],"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/==(_:_:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Conformance to "},{"code":"Equatable","type":"codeVoice"},{"type":"text","text":"."}],"metadata":{"roleHeading":"Operator","extendedModule":"Auth0","title":"==(_:_:)","role":"symbol","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","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"externalID":"s:5Auth023CredentialsManagerErrorV2eeoiySbAC_ACtFZ","modules":[{"name":"Auth0"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/==(_:_:)":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/==(_:_:)","title":"==(_:_:)","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"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"role":"symbol","url":"\/documentation\/auth0\/credentialsmanagererror\/==(_:_:)","abstract":[{"type":"text","text":"Conformance to "},{"code":"Equatable","type":"codeVoice"},{"type":"text","text":"."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"role":"symbol","title":"CredentialsManagerError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerError"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}],"abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","url":"\/documentation\/auth0\/credentialsmanagererror","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentialsmanagererror/apiexchangefailed.json b/docs/data/documentation/auth0/credentialsmanagererror/apiexchangefailed.json index 1c6d98a92..7c631423c 100644 --- a/docs/data/documentation/auth0/credentialsmanagererror/apiexchangefailed.json +++ b/docs/data/documentation/auth0/credentialsmanagererror/apiexchangefailed.json @@ -1 +1 @@ -{"metadata":{"title":"apiExchangeFailed","roleHeading":"Type Property","role":"symbol","externalID":"s:5Auth023CredentialsManagerErrorV17apiExchangeFailedACvpZ","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"apiExchangeFailed"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"}],"symbolKind":"property"},"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/apiExchangeFailed","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"schemaVersion":{"patch":0,"major":0,"minor":3},"kind":"symbol","abstract":[{"text":"The exchange of the refresh token for API credentials failed.","type":"text"},{"text":" ","type":"text"},{"text":"The underlying ","type":"text"},{"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","type":"reference","isActive":true},{"text":" property.","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"apiExchangeFailed"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"}]}]}],"variants":[{"paths":["\/documentation\/auth0\/credentialsmanagererror\/apiexchangefailed"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/apiExchangeFailed":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/apiExchangeFailed","abstract":[{"text":"The exchange of the refresh token for API credentials failed.","type":"text"},{"text":" ","type":"text"},{"text":"The underlying ","type":"text"},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","isActive":true},{"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"}],"type":"topic","title":"apiExchangeFailed","url":"\/documentation\/auth0\/credentialsmanagererror\/apiexchangefailed","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"apiExchangeFailed"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"title":"cause","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","kind":"symbol","abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":"?"}],"role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"url":"\/documentation\/auth0\/credentialsmanagererror","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}],"title":"CredentialsManagerError","kind":"symbol","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}]}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanagererror\/apiexchangefailed"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"abstract":[{"text":"The exchange of the refresh token for API credentials failed.","type":"text"},{"text":" ","type":"text"},{"text":"The underlying ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","isActive":true,"type":"reference"},{"text":" can be accessed via the ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true,"type":"reference"},{"text":" property.","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"apiExchangeFailed"},{"kind":"text","text":": "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","kind":"typeIdentifier","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"}],"platforms":["iOS"]}]}],"kind":"symbol","schemaVersion":{"minor":3,"patch":0,"major":0},"sections":[],"metadata":{"externalID":"s:5Auth023CredentialsManagerErrorV17apiExchangeFailedACvpZ","symbolKind":"property","title":"apiExchangeFailed","roleHeading":"Type Property","role":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"apiExchangeFailed"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"}],"modules":[{"name":"Auth0"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/apiExchangeFailed","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"role":"symbol","title":"CredentialsManagerError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerError"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}],"abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","url":"\/documentation\/auth0\/credentialsmanagererror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"kind":"symbol","title":"cause","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier","text":"Error"},{"kind":"text","text":"?"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","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":"."}],"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/apiExchangeFailed":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/apiExchangeFailed","kind":"symbol","title":"apiExchangeFailed","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"apiExchangeFailed","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","kind":"typeIdentifier"}],"role":"symbol","url":"\/documentation\/auth0\/credentialsmanagererror\/apiexchangefailed","abstract":[{"text":"The exchange of the refresh token for API credentials failed.","type":"text"},{"text":" ","type":"text"},{"text":"The underlying ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","type":"reference"},{"text":" can be accessed via the ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference"},{"text":" property.","type":"text"}],"type":"topic"}}} \ 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 5682e1070..889321c6f 100644 --- a/docs/data/documentation/auth0/credentialsmanagererror/auth0error-implementations.json +++ b/docs/data/documentation/auth0/credentialsmanagererror/auth0error-implementations.json @@ -1 +1 @@ -{"sections":[],"kind":"article","metadata":{"modules":[{"name":"Auth0"}],"role":"collectionGroup","roleHeading":"API Collection","title":"Auth0Error Implementations"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/Auth0Error-Implementations","interfaceLanguage":"swift"},"topicSections":[{"generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/errorDescription","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/localizedDescription"],"anchor":"Instance-Properties","title":"Instance Properties"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanagererror\/auth0error-implementations"]}],"schemaVersion":{"minor":3,"major":0,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/localizedDescription":{"abstract":[{"type":"text","text":"Description of the error."}],"title":"localizedDescription","url":"\/documentation\/auth0\/credentialsmanagererror\/localizeddescription","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/localizedDescription","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"localizedDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"type":"topic","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"url":"\/documentation\/auth0\/credentialsmanagererror","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}],"title":"CredentialsManagerError","kind":"symbol","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/errorDescription":{"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"errorDescription"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}],"title":"errorDescription","type":"topic","abstract":[{"type":"text","text":"Description of the error."}],"kind":"symbol","url":"\/documentation\/auth0\/credentialsmanagererror\/errordescription","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/errorDescription"}}} \ No newline at end of file +{"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/Auth0Error-Implementations","interfaceLanguage":"swift"},"kind":"article","metadata":{"modules":[{"name":"Auth0"}],"roleHeading":"API Collection","role":"collectionGroup","title":"Auth0Error Implementations"},"topicSections":[{"generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/errorDescription","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/localizedDescription"],"title":"Instance Properties","anchor":"Instance-Properties"}],"variants":[{"paths":["\/documentation\/auth0\/credentialsmanagererror\/auth0error-implementations"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"role":"symbol","title":"CredentialsManagerError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerError"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}],"abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","url":"\/documentation\/auth0\/credentialsmanagererror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/errorDescription":{"kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"errorDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"title":"errorDescription","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Description of the error."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/errorDescription","url":"\/documentation\/auth0\/credentialsmanagererror\/errordescription"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/localizedDescription":{"type":"topic","title":"localizedDescription","url":"\/documentation\/auth0\/credentialsmanagererror\/localizeddescription","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/localizedDescription","abstract":[{"text":"Description of the error.","type":"text"}],"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"localizedDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ 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 0a03667fa..63d3331e1 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},"metadata":{"symbolKind":"property","title":"biometricsFailed","modules":[{"name":"Auth0"}],"role":"symbol","roleHeading":"Type Property","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"biometricsFailed","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","kind":"typeIdentifier"}],"externalID":"s:5Auth023CredentialsManagerErrorV16biometricsFailedACvpZ"},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"biometricsFailed","kind":"identifier"},{"text":": ","kind":"text"},{"text":"CredentialsManagerError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"}],"platforms":["iOS"]}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/biometricsFailed"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanagererror\/biometricsfailed"]}],"kind":"symbol","abstract":[{"text":"The biometric authentication failed.","type":"text"},{"text":" ","type":"text"},{"text":"The underlying ","type":"text"},{"code":"LAError","type":"codeVoice"},{"text":" can be accessed via the ","type":"text"},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},{"text":" property.","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"title":"cause","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","kind":"symbol","abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":"?"}],"role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/biometricsFailed":{"fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"biometricsFailed"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/biometricsFailed","abstract":[{"text":"The biometric authentication failed.","type":"text"},{"text":" ","type":"text"},{"text":"The underlying ","type":"text"},{"code":"LAError","type":"codeVoice"},{"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"}],"kind":"symbol","role":"symbol","title":"biometricsFailed","url":"\/documentation\/auth0\/credentialsmanagererror\/biometricsfailed","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"url":"\/documentation\/auth0\/credentialsmanagererror","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}],"title":"CredentialsManagerError","kind":"symbol","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}]}}} \ No newline at end of file +{"sections":[],"kind":"symbol","metadata":{"symbolKind":"property","modules":[{"name":"Auth0"}],"title":"biometricsFailed","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"biometricsFailed"},{"text":": ","kind":"text"},{"text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","kind":"typeIdentifier"}],"externalID":"s:5Auth023CredentialsManagerErrorV16biometricsFailedACvpZ","role":"symbol","roleHeading":"Type Property"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/biometricsFailed"},"variants":[{"paths":["\/documentation\/auth0\/credentialsmanagererror\/biometricsfailed"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"patch":0,"minor":3,"major":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"biometricsFailed"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"abstract":[{"type":"text","text":"The biometric authentication failed."},{"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},{"text":" property.","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"kind":"symbol","title":"cause","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier","text":"Error"},{"kind":"text","text":"?"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","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":"."}],"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/biometricsFailed":{"type":"topic","abstract":[{"text":"The biometric authentication failed.","type":"text"},{"text":" ","type":"text"},{"text":"The underlying ","type":"text"},{"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."}],"kind":"symbol","url":"\/documentation\/auth0\/credentialsmanagererror\/biometricsfailed","title":"biometricsFailed","role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"biometricsFailed","kind":"identifier"},{"text":": ","kind":"text"},{"text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/biometricsFailed"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"role":"symbol","title":"CredentialsManagerError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerError"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}],"abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","url":"\/documentation\/auth0\/credentialsmanagererror","type":"topic"}}} \ 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 fc13482da..79195b11c 100644 --- a/docs/data/documentation/auth0/credentialsmanagererror/cause.json +++ b/docs/data/documentation/auth0/credentialsmanagererror/cause.json @@ -1 +1 @@ -{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanagererror\/cause"]}],"sections":[],"abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"metadata":{"externalID":"s:5Auth023CredentialsManagerErrorV5causes0D0_pSgvp","symbolKind":"property","title":"cause","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":"?","kind":"text"}],"modules":[{"name":"Auth0"}],"roleHeading":"Instance Property"},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier","text":"Error"},{"kind":"text","text":"?"}]}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/cause","interfaceLanguage":"swift"},"kind":"symbol","schemaVersion":{"minor":3,"major":0,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/cause":{"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier","text":"Error"},{"kind":"text","text":"?"}],"abstract":[{"text":"The underlying ","type":"text"},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/cause","type":"topic","title":"cause","kind":"symbol","role":"symbol","url":"\/documentation\/auth0\/credentialsmanagererror\/cause"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"url":"\/documentation\/auth0\/credentialsmanagererror","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}],"title":"CredentialsManagerError","kind":"symbol","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}]}}} \ No newline at end of file +{"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":"?"}]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanagererror\/cause"]}],"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/cause","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"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":"."}],"metadata":{"roleHeading":"Instance Property","symbolKind":"property","title":"cause","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier","text":"Error"},{"kind":"text","text":"?"}],"externalID":"s:5Auth023CredentialsManagerErrorV5causes0D0_pSgvp","modules":[{"name":"Auth0"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"role":"symbol","title":"CredentialsManagerError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerError"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}],"abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","url":"\/documentation\/auth0\/credentialsmanagererror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/cause":{"kind":"symbol","title":"cause","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP","text":"Error"},{"kind":"text","text":"?"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/cause","abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"url":"\/documentation\/auth0\/credentialsmanagererror\/cause"}}} \ 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 e5be8f202..ea8c07db8 100644 --- a/docs/data/documentation/auth0/credentialsmanagererror/debugdescription.json +++ b/docs/data/documentation/auth0/credentialsmanagererror/debugdescription.json @@ -1 +1 @@ -{"kind":"symbol","schemaVersion":{"major":0,"patch":0,"minor":3},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanagererror\/debugdescription"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/debugDescription"},"metadata":{"roleHeading":"Instance Property","externalID":"s:5Auth023CredentialsManagerErrorV16debugDescriptionSSvp","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"debugDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"role":"symbol","modules":[{"name":"Auth0"}],"symbolKind":"property","title":"debugDescription"},"abstract":[{"type":"text","text":"Description of the error."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"debugDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"languages":["swift"]}]},{"kind":"content","content":[{"text":"Discussion","level":2,"anchor":"discussion","type":"heading"},{"name":"Important","content":[{"type":"paragraph","inlineContent":[{"text":"You should avoid displaying the error description to the user, it’s meant for ","type":"text"},{"inlineContent":[{"text":"debugging","type":"text"}],"type":"strong"},{"text":" only.","type":"text"}]}],"type":"aside","style":"important"}]}],"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/debugDescription":{"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"debugDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"type":"topic","title":"debugDescription","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/debugDescription","url":"\/documentation\/auth0\/credentialsmanagererror\/debugdescription","kind":"symbol","abstract":[{"type":"text","text":"Description of the error."}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"url":"\/documentation\/auth0\/credentialsmanagererror","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}],"title":"CredentialsManagerError","kind":"symbol","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}]}}} \ No newline at end of file +{"abstract":[{"text":"Description of the error.","type":"text"}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"debugDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}]}],"kind":"declarations"},{"kind":"content","content":[{"type":"heading","text":"Discussion","anchor":"discussion","level":2},{"type":"aside","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"},{"text":" only.","type":"text"}],"type":"paragraph"}],"name":"Important"}]}],"variants":[{"paths":["\/documentation\/auth0\/credentialsmanagererror\/debugdescription"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"metadata":{"modules":[{"name":"Auth0"}],"title":"debugDescription","roleHeading":"Instance Property","symbolKind":"property","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"debugDescription"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"externalID":"s:5Auth023CredentialsManagerErrorV16debugDescriptionSSvp"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/debugDescription","interfaceLanguage":"swift"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"role":"symbol","title":"CredentialsManagerError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerError"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}],"abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","url":"\/documentation\/auth0\/credentialsmanagererror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/debugDescription":{"kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"debugDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"title":"debugDescription","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Description of the error."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/debugDescription","url":"\/documentation\/auth0\/credentialsmanagererror\/debugdescription"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ 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 ab490ead8..a7919a28b 100644 --- a/docs/data/documentation/auth0/credentialsmanagererror/equatable-implementations.json +++ b/docs/data/documentation/auth0/credentialsmanagererror/equatable-implementations.json @@ -1 +1 @@ -{"metadata":{"role":"collectionGroup","modules":[{"name":"Auth0"}],"roleHeading":"API Collection","title":"Equatable Implementations"},"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/!=(_:_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/==(_:_:)"],"title":"Operators","generated":true,"anchor":"Operators"}],"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","references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"url":"\/documentation\/auth0\/credentialsmanagererror","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}],"title":"CredentialsManagerError","kind":"symbol","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/==(_:_:)":{"url":"\/documentation\/auth0\/credentialsmanagererror\/==(_:_:)","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"==","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"kind":"symbol","abstract":[{"type":"text","text":"Conformance to "},{"code":"Equatable","type":"codeVoice"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/==(_:_:)","title":"==(_:_:)","type":"topic","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/!=(_:_:)":{"title":"!=(_:_:)","url":"\/documentation\/auth0\/credentialsmanagererror\/!=(_:_:)","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/!=(_:_:)","abstract":[],"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","text":"Self"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"kind":"symbol","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"topicSections":[{"title":"Operators","generated":true,"anchor":"Operators","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/!=(_:_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/==(_:_:)"]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanagererror\/equatable-implementations"]}],"kind":"article","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/Equatable-Implementations","interfaceLanguage":"swift"},"metadata":{"role":"collectionGroup","title":"Equatable Implementations","roleHeading":"API Collection","modules":[{"name":"Auth0"}]},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/==(_:_:)":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/==(_:_:)","title":"==(_:_:)","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"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"role":"symbol","url":"\/documentation\/auth0\/credentialsmanagererror\/==(_:_:)","abstract":[{"type":"text","text":"Conformance to "},{"code":"Equatable","type":"codeVoice"},{"type":"text","text":"."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/!=(_:_:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/!=(_:_:)","kind":"symbol","title":"!=(_:_:)","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","text":"Self"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"role":"symbol","url":"\/documentation\/auth0\/credentialsmanagererror\/!=(_:_:)","abstract":[],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"role":"symbol","title":"CredentialsManagerError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerError"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}],"abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","url":"\/documentation\/auth0\/credentialsmanagererror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ 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 ac50edd5c..fda72926a 100644 --- a/docs/data/documentation/auth0/credentialsmanagererror/errordescription.json +++ b/docs/data/documentation/auth0/credentialsmanagererror/errordescription.json @@ -1 +1 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/errorDescription","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Description of the error."}],"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":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"errorDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"? { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}]}]},{"kind":"content","content":[{"type":"heading","level":2,"text":"Discussion","anchor":"discussion"},{"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"},{"inlineContent":[{"text":"debugging","type":"text"}],"type":"strong"},{"text":" only.","type":"text"}],"type":"paragraph"}]}]}],"metadata":{"role":"symbol","extendedModule":"Auth0","title":"errorDescription","roleHeading":"Instance Property","externalID":"s:5Auth00A5ErrorPAAE16errorDescriptionSSSgvp::SYNTHESIZED::s:5Auth023CredentialsManagerErrorV","modules":[{"name":"Auth0"}],"symbolKind":"property","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"errorDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}]},"variants":[{"paths":["\/documentation\/auth0\/credentialsmanagererror\/errordescription"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"url":"\/documentation\/auth0\/credentialsmanagererror","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}],"title":"CredentialsManagerError","kind":"symbol","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/errorDescription":{"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"errorDescription"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}],"title":"errorDescription","type":"topic","abstract":[{"type":"text","text":"Description of the error."}],"kind":"symbol","url":"\/documentation\/auth0\/credentialsmanagererror\/errordescription","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/errorDescription"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"abstract":[{"text":"Description of the error.","type":"text"}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"errorDescription","kind":"identifier"},{"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":[{"level":2,"text":"Discussion","type":"heading","anchor":"discussion"},{"name":"Important","type":"aside","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"You should avoid displaying the error description to the user, it’s meant for "},{"type":"strong","inlineContent":[{"type":"text","text":"debugging"}]},{"type":"text","text":" only."}]}],"style":"important"}],"kind":"content"}],"variants":[{"paths":["\/documentation\/auth0\/credentialsmanagererror\/errordescription"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"minor":3,"major":0,"patch":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"metadata":{"modules":[{"name":"Auth0"}],"title":"errorDescription","roleHeading":"Instance Property","symbolKind":"property","role":"symbol","extendedModule":"Auth0","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"errorDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"externalID":"s:5Auth00A5ErrorPAAE16errorDescriptionSSSgvp::SYNTHESIZED::s:5Auth023CredentialsManagerErrorV"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/errorDescription"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/errorDescription":{"kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"errorDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"title":"errorDescription","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Description of the error."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/errorDescription","url":"\/documentation\/auth0\/credentialsmanagererror\/errordescription"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"role":"symbol","title":"CredentialsManagerError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerError"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}],"abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","url":"\/documentation\/auth0\/credentialsmanagererror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ 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 4232be43c..4e46992b5 100644 --- a/docs/data/documentation/auth0/credentialsmanagererror/failurereason.json +++ b/docs/data/documentation/auth0/credentialsmanagererror/failurereason.json @@ -1 +1 @@ -{"metadata":{"extendedModule":"Foundation","role":"symbol","symbolKind":"property","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"failureReason","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"platforms":[{"name":"iOS","introducedAt":"8.0","deprecated":false,"unavailable":false,"beta":false},{"name":"iPadOS","introducedAt":"8.0","deprecated":false,"unavailable":false,"beta":false},{"name":"Mac Catalyst","introducedAt":"8.0","deprecated":false,"unavailable":false,"beta":false},{"name":"macOS","introducedAt":"10.10","deprecated":false,"unavailable":false,"beta":false},{"name":"tvOS","introducedAt":"9.0","deprecated":false,"unavailable":false,"beta":false},{"name":"watchOS","introducedAt":"2.0","deprecated":false,"unavailable":false,"beta":false}],"title":"failureReason","modules":[{"name":"Auth0","relatedModules":["Foundation"]}],"externalID":"s:10Foundation14LocalizedErrorPAAE13failureReasonSSSgvp::SYNTHESIZED::s:5Auth023CredentialsManagerErrorV","roleHeading":"Instance Property"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanagererror\/failurereason"]}],"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\/failureReason"},"abstract":[{"text":"Inherited from ","type":"text"},{"type":"codeVoice","code":"LocalizedError.failureReason"},{"text":".","type":"text"}],"kind":"symbol","schemaVersion":{"minor":3,"major":0,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"failureReason","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"? { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"platforms":["iOS"]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/failureReason":{"title":"failureReason","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"failureReason"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}],"kind":"symbol","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/failureReason","url":"\/documentation\/auth0\/credentialsmanagererror\/failurereason","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"url":"\/documentation\/auth0\/credentialsmanagererror","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}],"title":"CredentialsManagerError","kind":"symbol","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}]}}} \ No newline at end of file +{"abstract":[{"text":"Inherited from ","type":"text"},{"code":"LocalizedError.failureReason","type":"codeVoice"},{"text":".","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"failureReason","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"? { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"platforms":["iOS"]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanagererror\/failurereason"]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"metadata":{"platforms":[{"deprecated":false,"unavailable":false,"beta":false,"name":"iOS","introducedAt":"8.0"},{"deprecated":false,"unavailable":false,"beta":false,"name":"iPadOS","introducedAt":"8.0"},{"deprecated":false,"unavailable":false,"beta":false,"name":"Mac Catalyst","introducedAt":"8.0"},{"deprecated":false,"unavailable":false,"beta":false,"name":"macOS","introducedAt":"10.10"},{"deprecated":false,"unavailable":false,"beta":false,"name":"tvOS","introducedAt":"9.0"},{"deprecated":false,"unavailable":false,"beta":false,"name":"watchOS","introducedAt":"2.0"}],"symbolKind":"property","title":"failureReason","roleHeading":"Instance Property","extendedModule":"Foundation","externalID":"s:10Foundation14LocalizedErrorPAAE13failureReasonSSSgvp::SYNTHESIZED::s:5Auth023CredentialsManagerErrorV","modules":[{"name":"Auth0","relatedModules":["Foundation"]}],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"failureReason"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"role":"symbol"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/failureReason","interfaceLanguage":"swift"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/failureReason":{"type":"topic","title":"failureReason","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/failureReason","url":"\/documentation\/auth0\/credentialsmanagererror\/failurereason","abstract":[],"kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"failureReason"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"role":"symbol","title":"CredentialsManagerError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerError"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}],"abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","url":"\/documentation\/auth0\/credentialsmanagererror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ 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 287a77ef5..f020d72d7 100644 --- a/docs/data/documentation/auth0/credentialsmanagererror/helpanchor.json +++ b/docs/data/documentation/auth0/credentialsmanagererror/helpanchor.json @@ -1 +1 @@ -{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/helpAnchor"},"abstract":[{"text":"Inherited from ","type":"text"},{"code":"LocalizedError.helpAnchor","type":"codeVoice"},{"text":".","type":"text"}],"kind":"symbol","metadata":{"role":"symbol","roleHeading":"Instance Property","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"helpAnchor","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"extendedModule":"Foundation","externalID":"s:10Foundation14LocalizedErrorPAAE10helpAnchorSSSgvp::SYNTHESIZED::s:5Auth023CredentialsManagerErrorV","platforms":[{"beta":false,"unavailable":false,"name":"iOS","introducedAt":"8.0","deprecated":false},{"beta":false,"unavailable":false,"name":"iPadOS","introducedAt":"8.0","deprecated":false},{"beta":false,"unavailable":false,"name":"Mac Catalyst","introducedAt":"8.0","deprecated":false},{"beta":false,"unavailable":false,"name":"macOS","introducedAt":"10.10","deprecated":false},{"beta":false,"unavailable":false,"name":"tvOS","introducedAt":"9.0","deprecated":false},{"beta":false,"unavailable":false,"name":"watchOS","introducedAt":"2.0","deprecated":false}],"modules":[{"relatedModules":["Foundation"],"name":"Auth0"}],"title":"helpAnchor","symbolKind":"property"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"helpAnchor"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"? { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"schemaVersion":{"patch":0,"major":0,"minor":3},"sections":[],"variants":[{"paths":["\/documentation\/auth0\/credentialsmanagererror\/helpanchor"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"url":"\/documentation\/auth0\/credentialsmanagererror","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}],"title":"CredentialsManagerError","kind":"symbol","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/helpAnchor":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/helpAnchor","role":"symbol","kind":"symbol","title":"helpAnchor","abstract":[],"url":"\/documentation\/auth0\/credentialsmanagererror\/helpanchor","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"helpAnchor"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}]}}} \ No newline at end of file +{"metadata":{"modules":[{"name":"Auth0","relatedModules":["Foundation"]}],"title":"helpAnchor","roleHeading":"Instance Property","symbolKind":"property","role":"symbol","platforms":[{"deprecated":false,"unavailable":false,"beta":false,"name":"iOS","introducedAt":"8.0"},{"deprecated":false,"unavailable":false,"beta":false,"name":"iPadOS","introducedAt":"8.0"},{"deprecated":false,"unavailable":false,"beta":false,"name":"Mac Catalyst","introducedAt":"8.0"},{"name":"macOS","unavailable":false,"deprecated":false,"introducedAt":"10.10","beta":false},{"unavailable":false,"beta":false,"introducedAt":"9.0","name":"tvOS","deprecated":false},{"unavailable":false,"beta":false,"introducedAt":"2.0","name":"watchOS","deprecated":false}],"extendedModule":"Foundation","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"helpAnchor"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"externalID":"s:10Foundation14LocalizedErrorPAAE10helpAnchorSSSgvp::SYNTHESIZED::s:5Auth023CredentialsManagerErrorV"},"sections":[],"variants":[{"paths":["\/documentation\/auth0\/credentialsmanagererror\/helpanchor"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/helpAnchor"},"kind":"symbol","abstract":[{"text":"Inherited from ","type":"text"},{"type":"codeVoice","code":"LocalizedError.helpAnchor"},{"text":".","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"helpAnchor"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"? { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"platforms":["iOS"]}],"kind":"declarations"}],"schemaVersion":{"patch":0,"minor":3,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"role":"symbol","title":"CredentialsManagerError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerError"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}],"abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","url":"\/documentation\/auth0\/credentialsmanagererror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/helpAnchor":{"url":"\/documentation\/auth0\/credentialsmanagererror\/helpanchor","title":"helpAnchor","abstract":[],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"helpAnchor"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/helpAnchor","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"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 8487686f2..a42193261 100644 --- a/docs/data/documentation/auth0/credentialsmanagererror/largeminttl.json +++ b/docs/data/documentation/auth0/credentialsmanagererror/largeminttl.json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"largeMinTTL"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","text":"CredentialsManagerError"}]}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/largeMinTTL","interfaceLanguage":"swift"},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"metadata":{"externalID":"s:5Auth023CredentialsManagerErrorV11largeMinTTLACvpZ","symbolKind":"property","modules":[{"name":"Auth0"}],"title":"largeMinTTL","roleHeading":"Type Property","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"largeMinTTL","kind":"identifier"},{"text":": ","kind":"text"},{"text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","kind":"typeIdentifier"}],"role":"symbol"},"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":[{"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":" "},{"type":"text","text":"This error does not include a "},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},{"type":"text","text":"."}],"sections":[],"variants":[{"paths":["\/documentation\/auth0\/credentialsmanagererror\/largeminttl"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"title":"cause","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","kind":"symbol","abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":"?"}],"role":"symbol","type":"topic"},"https://manage.auth0.com/#/apis/":{"type":"link","titleInlineContent":[{"text":"Auth0 API","type":"text"}],"title":"Auth0 API","url":"https:\/\/manage.auth0.com\/#\/apis\/","identifier":"https:\/\/manage.auth0.com\/#\/apis\/"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/largeMinTTL":{"kind":"symbol","role":"symbol","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 "},{"inlineContent":[{"type":"text","text":"Token Expiration"}],"type":"strong"},{"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":" "},{"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":"."}],"fragments":[{"kind":"keyword","text":"static"},{"kind":"text","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","title":"largeMinTTL","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/largeMinTTL"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"url":"\/documentation\/auth0\/credentialsmanagererror","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}],"title":"CredentialsManagerError","kind":"symbol","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}]}}} \ No newline at end of file +{"sections":[],"kind":"symbol","metadata":{"externalID":"s:5Auth023CredentialsManagerErrorV11largeMinTTLACvpZ","modules":[{"name":"Auth0"}],"title":"largeMinTTL","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"largeMinTTL"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"}],"roleHeading":"Type Property","role":"symbol","symbolKind":"property"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/largeMinTTL","interfaceLanguage":"swift"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanagererror\/largeminttl"]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"largeMinTTL"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CredentialsManagerError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"}],"platforms":["iOS"]}],"kind":"declarations"}],"abstract":[{"text":"The ","type":"text"},{"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"},{"text":" or","type":"text"},{"text":" ","type":"text"},{"text":"increase the ","type":"text"},{"inlineContent":[{"text":"Token Expiration","type":"text"}],"type":"strong"},{"text":" value in the settings page of your ","type":"text"},{"isActive":true,"identifier":"https:\/\/manage.auth0.com\/#\/apis\/","type":"reference"},{"text":".","type":"text"},{"text":" ","type":"text"},{"text":"This error does not include a ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference"},{"text":".","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/largeMinTTL":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/largeMinTTL","title":"largeMinTTL","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"largeMinTTL","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","kind":"typeIdentifier"}],"role":"symbol","url":"\/documentation\/auth0\/credentialsmanagererror\/largeminttl","abstract":[{"text":"The ","type":"text"},{"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"},{"text":" or","type":"text"},{"text":" ","type":"text"},{"text":"increase the ","type":"text"},{"inlineContent":[{"text":"Token Expiration","type":"text"}],"type":"strong"},{"text":" value in the settings page of your ","type":"text"},{"isActive":true,"identifier":"https:\/\/manage.auth0.com\/#\/apis\/","type":"reference"},{"text":".","type":"text"},{"text":" ","type":"text"},{"text":"This error does not include a ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference"},{"text":".","type":"text"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"role":"symbol","title":"CredentialsManagerError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerError"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}],"abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","url":"\/documentation\/auth0\/credentialsmanagererror","type":"topic"},"https://manage.auth0.com/#/apis/":{"url":"https:\/\/manage.auth0.com\/#\/apis\/","type":"link","title":"Auth0 API","titleInlineContent":[{"text":"Auth0 API","type":"text"}],"identifier":"https:\/\/manage.auth0.com\/#\/apis\/"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"kind":"symbol","title":"cause","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier","text":"Error"},{"kind":"text","text":"?"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","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":"."}],"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi"}}} \ 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 b818f0d60..49955c3b0 100644 --- a/docs/data/documentation/auth0/credentialsmanagererror/localizeddescription.json +++ b/docs/data/documentation/auth0/credentialsmanagererror/localizeddescription.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"metadata":{"title":"localizedDescription","externalID":"s:5Auth00A5ErrorPAAE20localizedDescriptionSSvp::SYNTHESIZED::s:5Auth023CredentialsManagerErrorV","roleHeading":"Instance Property","role":"symbol","extendedModule":"Auth0","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"localizedDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"symbolKind":"property","modules":[{"name":"Auth0"}]},"abstract":[{"type":"text","text":"Description of the error."}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/localizedDescription","interfaceLanguage":"swift"},"sections":[],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"localizedDescription"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}]}],"kind":"declarations"},{"content":[{"anchor":"discussion","type":"heading","text":"Discussion","level":2},{"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":[{"type":"text","text":"debugging"}]},{"type":"text","text":" only."}]}]}],"kind":"content"}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanagererror\/localizeddescription"]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"url":"\/documentation\/auth0\/credentialsmanagererror","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}],"title":"CredentialsManagerError","kind":"symbol","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/localizedDescription":{"abstract":[{"type":"text","text":"Description of the error."}],"title":"localizedDescription","url":"\/documentation\/auth0\/credentialsmanagererror\/localizeddescription","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/localizedDescription","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"localizedDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"type":"topic","kind":"symbol"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"metadata":{"roleHeading":"Instance Property","symbolKind":"property","modules":[{"name":"Auth0"}],"title":"localizedDescription","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"localizedDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"externalID":"s:5Auth00A5ErrorPAAE20localizedDescriptionSSvp::SYNTHESIZED::s:5Auth023CredentialsManagerErrorV","role":"symbol","extendedModule":"Auth0"},"sections":[],"abstract":[{"text":"Description of the error.","type":"text"}],"variants":[{"paths":["\/documentation\/auth0\/credentialsmanagererror\/localizeddescription"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/localizedDescription","interfaceLanguage":"swift"},"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"localizedDescription","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"platforms":["iOS"]}],"kind":"declarations"},{"content":[{"text":"Discussion","level":2,"anchor":"discussion","type":"heading"},{"name":"Important","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"}],"kind":"content"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"role":"symbol","title":"CredentialsManagerError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerError"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}],"abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","url":"\/documentation\/auth0\/credentialsmanagererror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/localizedDescription":{"type":"topic","title":"localizedDescription","url":"\/documentation\/auth0\/credentialsmanagererror\/localizeddescription","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/localizedDescription","abstract":[{"text":"Description of the error.","type":"text"}],"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"localizedDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ 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 1f19b7f35..7bfdb1e55 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},"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/failureReason","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/helpAnchor","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/recoverySuggestion"],"title":"Instance Properties","anchor":"Instance-Properties","generated":true}],"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"},"metadata":{"title":"LocalizedError Implementations","role":"collectionGroup","modules":[{"name":"Auth0"}],"roleHeading":"API Collection"},"kind":"article","sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanagererror\/localizederror-implementations"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/failureReason":{"title":"failureReason","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"failureReason"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}],"kind":"symbol","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/failureReason","url":"\/documentation\/auth0\/credentialsmanagererror\/failurereason","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/helpAnchor":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/helpAnchor","role":"symbol","kind":"symbol","title":"helpAnchor","abstract":[],"url":"\/documentation\/auth0\/credentialsmanagererror\/helpanchor","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"helpAnchor"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/recoverySuggestion":{"title":"recoverySuggestion","abstract":[],"url":"\/documentation\/auth0\/credentialsmanagererror\/recoverysuggestion","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/recoverySuggestion","kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"recoverySuggestion"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"url":"\/documentation\/auth0\/credentialsmanagererror","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}],"title":"CredentialsManagerError","kind":"symbol","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}]}}} \ No newline at end of file +{"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/failureReason","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/helpAnchor","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/recoverySuggestion"],"generated":true,"title":"Instance Properties","anchor":"Instance-Properties"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"metadata":{"roleHeading":"API Collection","modules":[{"name":"Auth0"}],"role":"collectionGroup","title":"LocalizedError Implementations"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanagererror\/localizederror-implementations"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/LocalizedError-Implementations"},"kind":"article","schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/recoverySuggestion":{"url":"\/documentation\/auth0\/credentialsmanagererror\/recoverysuggestion","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"recoverySuggestion"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"title":"recoverySuggestion","type":"topic","role":"symbol","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/recoverySuggestion","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/helpAnchor":{"url":"\/documentation\/auth0\/credentialsmanagererror\/helpanchor","title":"helpAnchor","abstract":[],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"helpAnchor"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/helpAnchor","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"role":"symbol","title":"CredentialsManagerError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerError"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}],"abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","url":"\/documentation\/auth0\/credentialsmanagererror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/failureReason":{"type":"topic","title":"failureReason","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/failureReason","url":"\/documentation\/auth0\/credentialsmanagererror\/failurereason","abstract":[],"kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"failureReason"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentialsmanagererror/message.json b/docs/data/documentation/auth0/credentialsmanagererror/message.json new file mode 100644 index 000000000..e605b704d --- /dev/null +++ b/docs/data/documentation/auth0/credentialsmanagererror/message.json @@ -0,0 +1 @@ +{"variants":[{"paths":["\/documentation\/auth0\/credentialsmanagererror\/message"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"message","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","sections":[],"metadata":{"externalID":"s:5Auth023CredentialsManagerErrorV7messageSSvp","extendedModule":"Auth0","symbolKind":"property","title":"message","role":"symbol","roleHeading":"Instance Property","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"message"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"modules":[{"name":"Auth0"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/message","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/message":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/message","kind":"symbol","title":"message","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"message","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"role":"symbol","url":"\/documentation\/auth0\/credentialsmanagererror\/message","abstract":[],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"role":"symbol","title":"CredentialsManagerError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerError"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}],"abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","url":"\/documentation\/auth0\/credentialsmanagererror","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 58b1dc8e4..02549adc2 100644 --- a/docs/data/documentation/auth0/credentialsmanagererror/nocredentials.json +++ b/docs/data/documentation/auth0/credentialsmanagererror/nocredentials.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"metadata":{"fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"noCredentials","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","kind":"typeIdentifier"}],"role":"symbol","title":"noCredentials","externalID":"s:5Auth023CredentialsManagerErrorV02noB0ACvpZ","roleHeading":"Type Property","modules":[{"name":"Auth0"}],"symbolKind":"property"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noCredentials","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"type":"text","text":"No credentials were found in the store."},{"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},{"type":"text","text":"."}],"schemaVersion":{"major":0,"patch":0,"minor":3},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"noCredentials"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"}],"platforms":["iOS"],"languages":["swift"]}]}],"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanagererror\/nocredentials"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/noCredentials":{"title":"noCredentials","url":"\/documentation\/auth0\/credentialsmanagererror\/nocredentials","kind":"symbol","role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noCredentials","abstract":[{"text":"No credentials were found in the store.","type":"text"},{"text":" ","type":"text"},{"text":"This error does not include a ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference"},{"text":".","type":"text"}],"fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"noCredentials"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"url":"\/documentation\/auth0\/credentialsmanagererror","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}],"title":"CredentialsManagerError","kind":"symbol","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"title":"cause","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","kind":"symbol","abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":"?"}],"role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noCredentials","interfaceLanguage":"swift"},"kind":"symbol","metadata":{"externalID":"s:5Auth023CredentialsManagerErrorV02noB0ACvpZ","modules":[{"name":"Auth0"}],"title":"noCredentials","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"noCredentials"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"}],"roleHeading":"Type Property","role":"symbol","symbolKind":"property"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanagererror\/nocredentials"]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"noCredentials","kind":"identifier"},{"text":": ","kind":"text"},{"text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"abstract":[{"text":"No credentials were found in the store.","type":"text"},{"text":" ","type":"text"},{"text":"This error does not include a ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference","isActive":true},{"text":".","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/noCredentials":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noCredentials","kind":"symbol","title":"noCredentials","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"noCredentials","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","kind":"typeIdentifier"}],"role":"symbol","url":"\/documentation\/auth0\/credentialsmanagererror\/nocredentials","abstract":[{"text":"No credentials were found in the store.","type":"text"},{"text":" ","type":"text"},{"text":"This error does not include a ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference","isActive":true},{"text":".","type":"text"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"role":"symbol","title":"CredentialsManagerError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerError"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}],"abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","url":"\/documentation\/auth0\/credentialsmanagererror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"kind":"symbol","title":"cause","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier","text":"Error"},{"kind":"text","text":"?"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","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":"."}],"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi"}}} \ 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 ba0018311..d1470d94c 100644 --- a/docs/data/documentation/auth0/credentialsmanagererror/norefreshtoken.json +++ b/docs/data/documentation/auth0/credentialsmanagererror/norefreshtoken.json @@ -1 +1 @@ -{"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"noRefreshToken","kind":"identifier"},{"text":": ","kind":"text"},{"text":"CredentialsManagerError","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"}]}],"kind":"declarations"}],"sections":[],"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"},{"text":"This error does not include a ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference"},{"text":".","type":"text"}],"metadata":{"symbolKind":"property","title":"noRefreshToken","role":"symbol","roleHeading":"Type Property","externalID":"s:5Auth023CredentialsManagerErrorV14noRefreshTokenACvpZ","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"noRefreshToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"}],"modules":[{"name":"Auth0"}]},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"schemaVersion":{"minor":3,"major":0,"patch":0},"variants":[{"paths":["\/documentation\/auth0\/credentialsmanagererror\/norefreshtoken"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken","interfaceLanguage":"swift"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/noRefreshToken":{"url":"\/documentation\/auth0\/credentialsmanagererror\/norefreshtoken","abstract":[{"type":"text","text":"The stored "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","isActive":true},{"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":"."}],"fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"noRefreshToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"}],"kind":"symbol","type":"topic","title":"noRefreshToken","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"title":"cause","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","kind":"symbol","abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":"?"}],"role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"url":"\/documentation\/auth0\/credentials","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"role":"symbol","type":"topic","abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"url":"\/documentation\/auth0\/credentialsmanagererror","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}],"title":"CredentialsManagerError","kind":"symbol","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"abstract":[{"text":"The stored ","type":"text"},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials"},{"type":"text","text":" instance does not contain a refresh token."},{"text":" ","type":"text"},{"type":"text","text":"This error does not include a "},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference"},{"type":"text","text":"."}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"noRefreshToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"}],"platforms":["iOS"]}],"kind":"declarations"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanagererror\/norefreshtoken"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"metadata":{"modules":[{"name":"Auth0"}],"title":"noRefreshToken","roleHeading":"Type Property","symbolKind":"property","role":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"noRefreshToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"}],"externalID":"s:5Auth023CredentialsManagerErrorV14noRefreshTokenACvpZ"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken","interfaceLanguage":"swift"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/noRefreshToken":{"title":"noRefreshToken","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/noRefreshToken","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"noRefreshToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"}],"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":" "},{"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"}],"url":"\/documentation\/auth0\/credentialsmanagererror\/norefreshtoken"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"Credentials","kind":"identifier"}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"role":"symbol","title":"CredentialsManagerError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerError"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}],"abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","url":"\/documentation\/auth0\/credentialsmanagererror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"kind":"symbol","title":"cause","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier","text":"Error"},{"kind":"text","text":"?"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","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":"."}],"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"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 a6c2db3a6..94e0d17b0 100644 --- a/docs/data/documentation/auth0/credentialsmanagererror/recoverysuggestion.json +++ b/docs/data/documentation/auth0/credentialsmanagererror/recoverysuggestion.json @@ -1 +1 @@ -{"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/recoverySuggestion"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"metadata":{"modules":[{"relatedModules":["Foundation"],"name":"Auth0"}],"symbolKind":"property","role":"symbol","externalID":"s:10Foundation14LocalizedErrorPAAE18recoverySuggestionSSSgvp::SYNTHESIZED::s:5Auth023CredentialsManagerErrorV","platforms":[{"introducedAt":"8.0","unavailable":false,"deprecated":false,"name":"iOS","beta":false},{"introducedAt":"8.0","unavailable":false,"deprecated":false,"name":"iPadOS","beta":false},{"introducedAt":"8.0","unavailable":false,"deprecated":false,"name":"Mac Catalyst","beta":false},{"introducedAt":"10.10","unavailable":false,"deprecated":false,"name":"macOS","beta":false},{"introducedAt":"9.0","unavailable":false,"deprecated":false,"name":"tvOS","beta":false},{"introducedAt":"2.0","unavailable":false,"deprecated":false,"name":"watchOS","beta":false}],"title":"recoverySuggestion","extendedModule":"Foundation","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"recoverySuggestion"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"roleHeading":"Instance Property"},"abstract":[{"type":"text","text":"Inherited from "},{"code":"LocalizedError.recoverySuggestion","type":"codeVoice"},{"type":"text","text":"."}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"recoverySuggestion","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"? { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"languages":["swift"]}],"kind":"declarations"}],"variants":[{"paths":["\/documentation\/auth0\/credentialsmanagererror\/recoverysuggestion"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","schemaVersion":{"major":0,"patch":0,"minor":3},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"url":"\/documentation\/auth0\/credentialsmanagererror","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}],"title":"CredentialsManagerError","kind":"symbol","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/recoverySuggestion":{"title":"recoverySuggestion","abstract":[],"url":"\/documentation\/auth0\/credentialsmanagererror\/recoverysuggestion","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/recoverySuggestion","kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"recoverySuggestion"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}]}}} \ No newline at end of file +{"abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"LocalizedError.recoverySuggestion"},{"type":"text","text":"."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"recoverySuggestion","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"? { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"languages":["swift"],"platforms":["iOS"]}]}],"variants":[{"paths":["\/documentation\/auth0\/credentialsmanagererror\/recoverysuggestion"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"metadata":{"platforms":[{"beta":false,"name":"iOS","unavailable":false,"introducedAt":"8.0","deprecated":false},{"beta":false,"name":"iPadOS","unavailable":false,"introducedAt":"8.0","deprecated":false},{"beta":false,"name":"Mac Catalyst","unavailable":false,"introducedAt":"8.0","deprecated":false},{"beta":false,"name":"macOS","unavailable":false,"introducedAt":"10.10","deprecated":false},{"beta":false,"name":"tvOS","unavailable":false,"introducedAt":"9.0","deprecated":false},{"beta":false,"name":"watchOS","unavailable":false,"introducedAt":"2.0","deprecated":false}],"symbolKind":"property","roleHeading":"Instance Property","title":"recoverySuggestion","extendedModule":"Foundation","externalID":"s:10Foundation14LocalizedErrorPAAE18recoverySuggestionSSSgvp::SYNTHESIZED::s:5Auth023CredentialsManagerErrorV","modules":[{"relatedModules":["Foundation"],"name":"Auth0"}],"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"recoverySuggestion","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"role":"symbol"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/recoverySuggestion","interfaceLanguage":"swift"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"role":"symbol","title":"CredentialsManagerError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerError"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}],"abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","url":"\/documentation\/auth0\/credentialsmanagererror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/recoverySuggestion":{"url":"\/documentation\/auth0\/credentialsmanagererror\/recoverysuggestion","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"recoverySuggestion"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"title":"recoverySuggestion","type":"topic","role":"symbol","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/recoverySuggestion","kind":"symbol"}}} \ 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 a3cce93a1..fd255c71f 100644 --- a/docs/data/documentation/auth0/credentialsmanagererror/renewfailed.json +++ b/docs/data/documentation/auth0/credentialsmanagererror/renewfailed.json @@ -1 +1 @@ -{"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanagererror\/renewfailed"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/renewFailed","interfaceLanguage":"swift"},"schemaVersion":{"minor":3,"patch":0,"major":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"renewFailed"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"}],"languages":["swift"]}]}],"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},{"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"}],"sections":[],"metadata":{"role":"symbol","roleHeading":"Type Property","symbolKind":"property","modules":[{"name":"Auth0"}],"title":"renewFailed","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"renewFailed","kind":"identifier"},{"text":": ","kind":"text"},{"text":"CredentialsManagerError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"}],"externalID":"s:5Auth023CredentialsManagerErrorV11renewFailedACvpZ"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"title":"cause","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","kind":"symbol","abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":"?"}],"role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"url":"\/documentation\/auth0\/credentialsmanagererror","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}],"title":"CredentialsManagerError","kind":"symbol","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/renewFailed":{"fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"renewFailed","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","kind":"typeIdentifier"}],"title":"renewFailed","type":"topic","kind":"symbol","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"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","type":"reference"},{"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"}],"url":"\/documentation\/auth0\/credentialsmanagererror\/renewfailed"}}} \ No newline at end of file +{"metadata":{"symbolKind":"property","title":"renewFailed","externalID":"s:5Auth023CredentialsManagerErrorV11renewFailedACvpZ","roleHeading":"Type Property","modules":[{"name":"Auth0"}],"fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"renewFailed","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","kind":"typeIdentifier"}],"role":"symbol"},"sections":[],"variants":[{"paths":["\/documentation\/auth0\/credentialsmanagererror\/renewfailed"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/renewFailed","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"text":"The credentials renewal failed.","type":"text"},{"text":" ","type":"text"},{"text":"The underlying ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","isActive":true,"type":"reference"},{"text":" can be accessed via the ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true,"type":"reference"},{"text":" property.","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"renewFailed","kind":"identifier"},{"text":": ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","kind":"typeIdentifier"}],"platforms":["iOS"]}],"kind":"declarations"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"role":"symbol","title":"CredentialsManagerError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerError"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}],"abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","url":"\/documentation\/auth0\/credentialsmanagererror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/renewFailed":{"type":"topic","title":"renewFailed","url":"\/documentation\/auth0\/credentialsmanagererror\/renewfailed","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/renewFailed","abstract":[{"text":"The credentials renewal failed.","type":"text"},{"text":" ","type":"text"},{"text":"The underlying ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","isActive":true,"type":"reference"},{"text":" can be accessed via the ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true,"type":"reference"},{"text":" property.","type":"text"}],"role":"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","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"}]},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"kind":"symbol","title":"cause","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier","text":"Error"},{"kind":"text","text":"?"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","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":"."}],"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ 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 b44ec2442..5fca7b223 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"]}],"schemaVersion":{"major":0,"patch":0,"minor":3},"kind":"symbol","abstract":[{"text":"The revocation of the refresh token failed.","type":"text"},{"text":" ","type":"text"},{"text":"The underlying ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","type":"reference"},{"text":" can be accessed via the ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference"},{"text":" property.","type":"text"}],"metadata":{"modules":[{"name":"Auth0"}],"role":"symbol","externalID":"s:5Auth023CredentialsManagerErrorV12revokeFailedACvpZ","roleHeading":"Type Property","symbolKind":"property","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"revokeFailed","kind":"identifier"},{"text":": ","kind":"text"},{"text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","kind":"typeIdentifier"}],"title":"revokeFailed"},"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"revokeFailed","kind":"identifier"},{"text":": ","kind":"text"},{"text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"}],"languages":["swift"]}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/revokeFailed"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/revokeFailed":{"type":"topic","title":"revokeFailed","kind":"symbol","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/revokeFailed","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"revokeFailed"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","kind":"typeIdentifier","text":"CredentialsManagerError"}],"url":"\/documentation\/auth0\/credentialsmanagererror\/revokefailed","abstract":[{"text":"The revocation of the refresh token failed.","type":"text"},{"text":" ","type":"text"},{"text":"The underlying ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","isActive":true,"type":"reference"},{"text":" can be accessed via the ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true,"type":"reference"},{"text":" property.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"title":"cause","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","kind":"symbol","abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":"?"}],"role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"url":"\/documentation\/auth0\/credentialsmanagererror","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}],"title":"CredentialsManagerError","kind":"symbol","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}]}}} \ No newline at end of file +{"variants":[{"paths":["\/documentation\/auth0\/credentialsmanagererror\/revokefailed"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"abstract":[{"type":"text","text":"The revocation of the refresh token 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","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true},{"type":"text","text":" property."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"revokeFailed"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","text":"CredentialsManagerError"}],"platforms":["iOS"],"languages":["swift"]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","sections":[],"metadata":{"symbolKind":"property","modules":[{"name":"Auth0"}],"title":"revokeFailed","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"revokeFailed"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"}],"externalID":"s:5Auth023CredentialsManagerErrorV12revokeFailedACvpZ","role":"symbol","roleHeading":"Type Property"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/revokeFailed","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"kind":"symbol","title":"cause","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier","text":"Error"},{"kind":"text","text":"?"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","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":"."}],"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/revokeFailed":{"type":"topic","abstract":[{"type":"text","text":"The revocation of the refresh token 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","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true},{"type":"text","text":" property."}],"title":"revokeFailed","kind":"symbol","url":"\/documentation\/auth0\/credentialsmanagererror\/revokefailed","role":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"revokeFailed"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/revokeFailed"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"role":"symbol","title":"CredentialsManagerError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerError"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}],"abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","url":"\/documentation\/auth0\/credentialsmanagererror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentialsmanagererror/ssoexchangefailed.json b/docs/data/documentation/auth0/credentialsmanagererror/ssoexchangefailed.json index 3b65071f3..9a25fb6a2 100644 --- a/docs/data/documentation/auth0/credentialsmanagererror/ssoexchangefailed.json +++ b/docs/data/documentation/auth0/credentialsmanagererror/ssoexchangefailed.json @@ -1 +1 @@ -{"schemaVersion":{"minor":3,"patch":0,"major":0},"sections":[],"kind":"symbol","metadata":{"symbolKind":"property","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ssoExchangeFailed","kind":"identifier"},{"text":": ","kind":"text"},{"text":"CredentialsManagerError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"}],"externalID":"s:5Auth023CredentialsManagerErrorV17ssoExchangeFailedACvpZ","title":"ssoExchangeFailed","roleHeading":"Type Property","modules":[{"name":"Auth0"}],"role":"symbol"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/ssoExchangeFailed"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"abstract":[{"text":"The exchange of the refresh token for SSO credentials 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"},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},{"text":" property.","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ssoExchangeFailed","kind":"identifier"},{"text":": ","kind":"text"},{"text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","kind":"typeIdentifier"}],"languages":["swift"]}]}],"variants":[{"paths":["\/documentation\/auth0\/credentialsmanagererror\/ssoexchangefailed"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/ssoExchangeFailed":{"url":"\/documentation\/auth0\/credentialsmanagererror\/ssoexchangefailed","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"ssoExchangeFailed"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"}],"type":"topic","abstract":[{"type":"text","text":"The exchange of the refresh token for SSO credentials failed."},{"type":"text","text":" "},{"type":"text","text":"The underlying "},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","type":"reference"},{"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."}],"title":"ssoExchangeFailed","kind":"symbol","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/ssoExchangeFailed"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"title":"cause","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","kind":"symbol","abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":"?"}],"role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"url":"\/documentation\/auth0\/credentialsmanagererror","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}],"title":"CredentialsManagerError","kind":"symbol","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}]}}} \ No newline at end of file +{"abstract":[{"text":"The exchange of the refresh token for SSO credentials failed.","type":"text"},{"text":" ","type":"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","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true},{"type":"text","text":" property."}],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"ssoExchangeFailed"},{"text":": ","kind":"text"},{"text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","kind":"typeIdentifier"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"variants":[{"paths":["\/documentation\/auth0\/credentialsmanagererror\/ssoexchangefailed"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"minor":3,"major":0,"patch":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"metadata":{"role":"symbol","title":"ssoExchangeFailed","modules":[{"name":"Auth0"}],"fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ssoExchangeFailed"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"}],"externalID":"s:5Auth023CredentialsManagerErrorV17ssoExchangeFailedACvpZ","roleHeading":"Type Property","symbolKind":"property"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/ssoExchangeFailed"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"kind":"symbol","title":"cause","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier","text":"Error"},{"kind":"text","text":"?"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","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":"."}],"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/ssoExchangeFailed":{"role":"symbol","title":"ssoExchangeFailed","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"ssoExchangeFailed"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError"}],"abstract":[{"type":"text","text":"The exchange of the refresh token for SSO credentials 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","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true},{"type":"text","text":" property."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/ssoExchangeFailed","url":"\/documentation\/auth0\/credentialsmanagererror\/ssoexchangefailed","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"role":"symbol","title":"CredentialsManagerError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerError"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}],"abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","url":"\/documentation\/auth0\/credentialsmanagererror","type":"topic"}}} \ 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 6f9d07c62..038134e16 100644 --- a/docs/data/documentation/auth0/credentialsmanagererror/storefailed.json +++ b/docs/data/documentation/auth0/credentialsmanagererror/storefailed.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"schemaVersion":{"patch":0,"minor":3,"major":0},"abstract":[{"type":"text","text":"Storing the renewed credentials failed."},{"type":"text","text":" "},{"type":"text","text":"This error does not include a "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true},{"type":"text","text":"."}],"primaryContentSections":[{"declarations":[{"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"storeFailed","kind":"identifier"},{"text":": ","kind":"text"},{"text":"CredentialsManagerError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"kind":"symbol","sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/storeFailed"},"variants":[{"paths":["\/documentation\/auth0\/credentialsmanagererror\/storefailed"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"externalID":"s:5Auth023CredentialsManagerErrorV11storeFailedACvpZ","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"storeFailed","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","kind":"typeIdentifier"}],"title":"storeFailed","modules":[{"name":"Auth0"}],"roleHeading":"Type Property","symbolKind":"property","role":"symbol"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"title":"cause","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","kind":"symbol","abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":"?"}],"role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/storeFailed":{"kind":"symbol","abstract":[{"text":"Storing the renewed credentials failed.","type":"text"},{"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"},{"text":".","type":"text"}],"type":"topic","role":"symbol","title":"storeFailed","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"storeFailed","kind":"identifier"},{"text":": ","kind":"text"},{"text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/storeFailed","url":"\/documentation\/auth0\/credentialsmanagererror\/storefailed"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"url":"\/documentation\/auth0\/credentialsmanagererror","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}],"title":"CredentialsManagerError","kind":"symbol","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanagererror\/storefailed"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"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":"."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"storeFailed","kind":"identifier"},{"text":": ","kind":"text"},{"text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"}],"languages":["swift"],"platforms":["iOS"]}]}],"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"metadata":{"externalID":"s:5Auth023CredentialsManagerErrorV11storeFailedACvpZ","symbolKind":"property","title":"storeFailed","roleHeading":"Type Property","role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"storeFailed","kind":"identifier"},{"text":": ","kind":"text"},{"text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","kind":"typeIdentifier"}],"modules":[{"name":"Auth0"}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/storeFailed"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"kind":"symbol","title":"cause","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier","text":"Error"},{"kind":"text","text":"?"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","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":"."}],"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"role":"symbol","title":"CredentialsManagerError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerError"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}],"abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","url":"\/documentation\/auth0\/credentialsmanagererror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/storeFailed":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/storeFailed","kind":"symbol","title":"storeFailed","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"storeFailed","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","kind":"typeIdentifier"}],"role":"symbol","url":"\/documentation\/auth0\/credentialsmanagererror\/storefailed","abstract":[{"text":"Storing the renewed credentials failed.","type":"text"},{"text":" ","type":"text"},{"text":"This error does not include a ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference"},{"text":".","type":"text"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"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 bf164b77f..9f025afe4 100644 --- a/docs/data/documentation/auth0/credentialsmanagererror/~=(_:_:)-7k0od.json +++ b/docs/data/documentation/auth0/credentialsmanagererror/~=(_:_:)-7k0od.json @@ -1 +1 @@ -{"schemaVersion":{"patch":0,"major":0,"minor":3},"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"]]},"variants":[{"paths":["\/documentation\/auth0\/credentialsmanagererror\/~=(_:_:)-7k0od"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","primaryContentSections":[{"declarations":[{"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"~=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"lhs","kind":"internalParam"},{"text":": ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"rhs","kind":"internalParam"},{"text":": ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"metadata":{"externalID":"s:5Auth023CredentialsManagerErrorV2teoiySbAC_ACtFZ","extendedModule":"Auth0","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"~="},{"kind":"text","text":" "},{"kind":"text","text":"("},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","kind":"typeIdentifier","text":"CredentialsManagerError"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","kind":"typeIdentifier","text":"CredentialsManagerError"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"role":"symbol","roleHeading":"Operator","modules":[{"name":"Auth0"}],"title":"~=(_:_:)","symbolKind":"op"},"sections":[],"abstract":[{"type":"text","text":"Matches "},{"code":"CredentialsManagerError","type":"codeVoice"},{"type":"text","text":" values in a switch statement."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"url":"\/documentation\/auth0\/credentialsmanagererror","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}],"title":"CredentialsManagerError","kind":"symbol","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","navigatorTitle":[{"text":"CredentialsManagerError","kind":"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"}],"title":"~=(_:_:)","url":"\/documentation\/auth0\/credentialsmanagererror\/~=(_:_:)-7k0od","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"~=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/~=(_:_:)-7k0od","type":"topic"}}} \ No newline at end of file +{"metadata":{"symbolKind":"op","roleHeading":"Operator","externalID":"s:5Auth023CredentialsManagerErrorV2teoiySbAC_ACtFZ","extendedModule":"Auth0","title":"~=(_:_:)","modules":[{"name":"Auth0"}],"fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"~=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"role":"symbol"},"sections":[],"variants":[{"paths":["\/documentation\/auth0\/credentialsmanagererror\/~=(_:_:)-7k0od"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/~=(_:_:)-7k0od","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"text":"Matches ","type":"text"},{"code":"CredentialsManagerError","type":"codeVoice"},{"text":" values in a switch statement.","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"~=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"lhs","kind":"internalParam"},{"text":": ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","text":"CredentialsManagerError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"},{"text":", ","kind":"text"},{"text":"rhs","kind":"internalParam"},{"text":": ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","text":"CredentialsManagerError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"platforms":["iOS"]}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/~=(_:_:)-7k0od":{"type":"topic","title":"~=(_:_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/~=(_:_:)-7k0od","kind":"symbol","url":"\/documentation\/auth0\/credentialsmanagererror\/~=(_:_:)-7k0od","abstract":[{"text":"Matches ","type":"text"},{"code":"CredentialsManagerError","type":"codeVoice"},{"text":" values in a switch statement.","type":"text"}],"role":"symbol","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","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"role":"symbol","title":"CredentialsManagerError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerError"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}],"abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","url":"\/documentation\/auth0\/credentialsmanagererror","type":"topic"}}} \ 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 062b8d5d1..4fb9ae6c6 100644 --- a/docs/data/documentation/auth0/credentialsmanagererror/~=(_:_:)-93ixe.json +++ b/docs/data/documentation/auth0/credentialsmanagererror/~=(_:_:)-93ixe.json @@ -1 +1 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/~=(_:_:)-93ixe","interfaceLanguage":"swift"},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"~=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"lhs","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"CredentialsManagerError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"},{"text":", ","kind":"text"},{"text":"rhs","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"metadata":{"roleHeading":"Operator","extendedModule":"Auth0","role":"symbol","externalID":"s:5Auth023CredentialsManagerErrorV2teoiySbAC_s0D0_ptFZ","modules":[{"name":"Auth0"}],"symbolKind":"op","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"~=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"CredentialsManagerError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"},{"text":", ","kind":"text"},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"title":"~=(_:_:)"},"schemaVersion":{"major":0,"patch":0,"minor":3},"abstract":[{"text":"Matches ","type":"text"},{"type":"codeVoice","code":"Error"},{"text":" values in a switch statement.","type":"text"}],"variants":[{"paths":["\/documentation\/auth0\/credentialsmanagererror\/~=(_:_:)-93ixe"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/~=(_:_:)-93ixe":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/~=(_:_:)-93ixe","kind":"symbol","abstract":[{"type":"text","text":"Matches "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" values in a switch statement."}],"url":"\/documentation\/auth0\/credentialsmanagererror\/~=(_:_:)-93ixe","role":"symbol","type":"topic","title":"~=(_:_:)","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"~=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"CredentialsManagerError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"},{"text":", ","kind":"text"},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"url":"\/documentation\/auth0\/credentialsmanagererror","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}],"title":"CredentialsManagerError","kind":"symbol","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"sections":[],"metadata":{"externalID":"s:5Auth023CredentialsManagerErrorV2teoiySbAC_s0D0_ptFZ","modules":[{"name":"Auth0"}],"title":"~=(_:_:)","extendedModule":"Auth0","roleHeading":"Operator","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","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"role":"symbol","symbolKind":"op"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/~=(_:_:)-93ixe","interfaceLanguage":"swift"},"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanagererror\/~=(_:_:)-93ixe"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"]]},"schemaVersion":{"minor":3,"patch":0,"major":0},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"~=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"lhs","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"},{"text":", ","kind":"text"},{"text":"rhs","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"Error","preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"abstract":[{"text":"Matches ","type":"text"},{"code":"Error","type":"codeVoice"},{"text":" values in a switch statement.","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError/~=(_:_:)-93ixe":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError\/~=(_:_:)-93ixe","kind":"symbol","title":"~=(_:_:)","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"~="},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","text":"CredentialsManagerError","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:s5ErrorP","text":"Error","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"role":"symbol","url":"\/documentation\/auth0\/credentialsmanagererror\/~=(_:_:)-93ixe","abstract":[{"type":"text","text":"Matches "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" values in a switch statement."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"role":"symbol","title":"CredentialsManagerError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerError"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}],"abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","url":"\/documentation\/auth0\/credentialsmanagererror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"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 c5fc3ac26..490600fd0 100644 --- a/docs/data/documentation/auth0/credentialsmanagerresult.json +++ b/docs/data/documentation/auth0/credentialsmanagerresult.json @@ -1 +1 @@ -{"variants":[{"paths":["\/documentation\/auth0\/credentialsmanagerresult"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerResult"},{"kind":"text","text":"<"},{"kind":"genericParameter","text":"T"},{"kind":"text","text":"> = "},{"kind":"typeIdentifier","text":"Result","preciseIdentifier":"s:s6ResultO"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"T","preciseIdentifier":"s:5Auth024CredentialsManagerResulta1Txmfp"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError"},{"kind":"text","text":">"}],"languages":["swift"],"platforms":["iOS"]}]}],"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerResult","interfaceLanguage":"swift"},"schemaVersion":{"patch":0,"minor":3,"major":0},"metadata":{"roleHeading":"Type Alias","title":"CredentialsManagerResult","navigatorTitle":[{"text":"CredentialsManagerResult","kind":"identifier"}],"symbolKind":"typealias","externalID":"s:5Auth024CredentialsManagerResulta","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerResult","kind":"identifier"}],"role":"symbol","modules":[{"name":"Auth0"}]},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"abstract":[{"code":"Result","type":"codeVoice"},{"text":" wrapper for Credentials Manager operations.","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerResult":{"type":"topic","abstract":[{"type":"codeVoice","code":"Result"},{"type":"text","text":" wrapper for Credentials Manager operations."}],"kind":"symbol","role":"symbol","navigatorTitle":[{"text":"CredentialsManagerResult","kind":"identifier"}],"title":"CredentialsManagerResult","url":"\/documentation\/auth0\/credentialsmanagerresult","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerResult","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerResult"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"url":"\/documentation\/auth0\/credentialsmanagererror","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManagerError","kind":"identifier"}],"title":"CredentialsManagerError","kind":"symbol","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","navigatorTitle":[{"text":"CredentialsManagerError","kind":"identifier"}]}}} \ No newline at end of file +{"metadata":{"symbolKind":"typealias","title":"CredentialsManagerResult","externalID":"s:5Auth024CredentialsManagerResulta","roleHeading":"Type Alias","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerResult"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerResult"}]},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsmanagerresult"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerResult","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"type":"codeVoice","code":"Result"},{"type":"text","text":" wrapper for Credentials Manager operations."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerResult"},{"kind":"text","text":"<"},{"kind":"genericParameter","text":"T"},{"kind":"text","text":"> = "},{"kind":"typeIdentifier","text":"Result","preciseIdentifier":"s:s6ResultO"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"T","preciseIdentifier":"s:5Auth024CredentialsManagerResulta1Txmfp"},{"kind":"text","text":", "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","kind":"typeIdentifier","text":"CredentialsManagerError","preciseIdentifier":"s:5Auth023CredentialsManagerErrorV"},{"kind":"text","text":">"}]}],"kind":"declarations"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerResult":{"kind":"symbol","abstract":[{"code":"Result","type":"codeVoice"},{"text":" wrapper for Credentials Manager operations.","type":"text"}],"type":"topic","title":"CredentialsManagerResult","url":"\/documentation\/auth0\/credentialsmanagerresult","role":"symbol","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerResult"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerResult","navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerResult"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManagerError":{"role":"symbol","title":"CredentialsManagerError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManagerError"}],"navigatorTitle":[{"kind":"identifier","text":"CredentialsManagerError"}],"abstract":[{"type":"text","text":"Represents an error during a Credentials Manager operation."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManagerError","url":"\/documentation\/auth0\/credentialsmanagererror","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/credentialsstorage.json b/docs/data/documentation/auth0/credentialsstorage.json index 325fde02d..c24f0599f 100644 --- a/docs/data/documentation/auth0/credentialsstorage.json +++ b/docs/data/documentation/auth0/credentialsstorage.json @@ -1 +1 @@ -{"schemaVersion":{"minor":3,"major":0,"patch":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsStorage"}],"languages":["swift"],"platforms":["iOS"]}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"sections":[],"abstract":[{"text":"Generic storage API for storing credentials.","type":"text"}],"kind":"symbol","topicSections":[{"title":"Instance Methods","generated":true,"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:)"],"anchor":"Instance-Methods"}],"metadata":{"navigatorTitle":[{"text":"CredentialsStorage","kind":"identifier"}],"title":"CredentialsStorage","roleHeading":"Protocol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsStorage","kind":"identifier"}],"symbolKind":"protocol","externalID":"s:5Auth018CredentialsStorageP","role":"symbol","modules":[{"name":"Auth0"}]},"relationshipsSections":[{"kind":"relationships","title":"Conforming Types","type":"conformingTypes","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain"]}],"variants":[{"paths":["\/documentation\/auth0\/credentialsstorage"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage/getEntry(forKey:)":{"type":"topic","url":"\/documentation\/auth0\/credentialsstorage\/getentry(forkey:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage\/getEntry(forKey:)","abstract":[{"type":"text","text":"Retrieves a storage entry."}],"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getEntry"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:10Foundation4DataV","kind":"typeIdentifier","text":"Data"},{"kind":"text","text":"?"}],"title":"getEntry(forKey:)","required":true},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage/deleteEntry(forKey:)":{"abstract":[{"text":"Deletes a storage entry.","type":"text"}],"role":"symbol","url":"\/documentation\/auth0\/credentialsstorage\/deleteentry(forkey:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage\/deleteEntry(forKey:)","required":true,"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"deleteEntry","kind":"identifier"},{"text":"(","kind":"text"},{"text":"forKey","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"type":"topic","kind":"symbol","title":"deleteEntry(forKey:)"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage/setEntry(_:forKey:)":{"role":"symbol","kind":"symbol","url":"\/documentation\/auth0\/credentialsstorage\/setentry(_:forkey:)","required":true,"abstract":[{"text":"Sets a storage entry.","type":"text"}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"setEntry"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"title":"setEntry(_:forKey:)","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage\/setEntry(_:forKey:)"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain":{"type":"topic","fragments":[{"kind":"keyword","text":"extension"},{"kind":"text","text":" "},{"preciseIdentifier":"s:14SimpleKeychainAAV","kind":"identifier","text":"SimpleKeychain"}],"title":"SimpleKeychain","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain","navigatorTitle":[{"kind":"identifier","text":"SimpleKeychain"}],"url":"\/documentation\/auth0\/simplekeychain\/simplekeychain","abstract":[{"type":"text","text":"Conformance to "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","isActive":true},{"type":"text","text":"."}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage":{"title":"CredentialsStorage","kind":"symbol","navigatorTitle":[{"text":"CredentialsStorage","kind":"identifier"}],"role":"symbol","url":"\/documentation\/auth0\/credentialsstorage","abstract":[{"text":"Generic storage API for storing credentials.","type":"text"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsStorage","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"metadata":{"roleHeading":"Protocol","navigatorTitle":[{"kind":"identifier","text":"CredentialsStorage"}],"symbolKind":"protocol","role":"symbol","title":"CredentialsStorage","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsStorage"}],"externalID":"s:5Auth018CredentialsStorageP","modules":[{"name":"Auth0"}]},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsstorage"]}],"relationshipsSections":[{"type":"conformingTypes","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain"],"kind":"relationships","title":"Conforming Types"}],"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:)"],"generated":true,"title":"Instance Methods","anchor":"Instance-Methods"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage"},"kind":"symbol","abstract":[{"text":"Generic storage API for storing credentials.","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsStorage","kind":"identifier"}],"platforms":["iOS"]}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain":{"type":"topic","title":"SimpleKeychain","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain","kind":"symbol","url":"\/documentation\/auth0\/simplekeychain\/simplekeychain","abstract":[{"type":"text","text":"Conformance to "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","isActive":true},{"type":"text","text":"."}],"role":"symbol","fragments":[{"kind":"keyword","text":"extension"},{"kind":"text","text":" "},{"kind":"identifier","preciseIdentifier":"s:14SimpleKeychainAAV","text":"SimpleKeychain"}],"navigatorTitle":[{"kind":"identifier","text":"SimpleKeychain"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage/getEntry(forKey:)":{"type":"topic","abstract":[{"type":"text","text":"Retrieves a storage entry."}],"title":"getEntry(forKey:)","kind":"symbol","url":"\/documentation\/auth0\/credentialsstorage\/getentry(forkey:)","required":true,"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getEntry","kind":"identifier"},{"text":"(","kind":"text"},{"text":"forKey","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"Data","preciseIdentifier":"s:10Foundation4DataV","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage\/getEntry(forKey:)"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage":{"title":"CredentialsStorage","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","role":"symbol","kind":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsStorage","kind":"identifier"}],"abstract":[{"text":"Generic storage API for storing credentials.","type":"text"}],"url":"\/documentation\/auth0\/credentialsstorage","navigatorTitle":[{"text":"CredentialsStorage","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage/setEntry(_:forKey:)":{"type":"topic","title":"setEntry(_:forKey:)","url":"\/documentation\/auth0\/credentialsstorage\/setentry(_:forkey:)","kind":"symbol","abstract":[{"type":"text","text":"Sets a storage entry."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage\/setEntry(_:forKey:)","required":true,"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"setEntry"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV","text":"Data"},{"kind":"text","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"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage/deleteEntry(forKey:)":{"title":"deleteEntry(forKey:)","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage\/deleteEntry(forKey:)","role":"symbol","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"deleteEntry","kind":"identifier"},{"text":"(","kind":"text"},{"text":"forKey","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"abstract":[{"text":"Deletes a storage entry.","type":"text"}],"url":"\/documentation\/auth0\/credentialsstorage\/deleteentry(forkey:)","required":true}}} \ 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 580aed2cc..26698ab8d 100644 --- a/docs/data/documentation/auth0/credentialsstorage/deleteentry(forkey:).json +++ b/docs/data/documentation/auth0/credentialsstorage/deleteentry(forkey:).json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage"]]},"sections":[],"kind":"symbol","schemaVersion":{"major":0,"patch":0,"minor":3},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"deleteEntry"},{"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"}],"languages":["swift"]}]},{"parameters":[{"name":"key","content":[{"type":"paragraph","inlineContent":[{"text":"The key to delete from the store.","type":"text"}]}]}],"kind":"parameters"},{"kind":"content","content":[{"level":2,"type":"heading","anchor":"return-value","text":"Return Value"},{"type":"paragraph","inlineContent":[{"text":"If the entry was deleted.","type":"text"}]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsstorage\/deleteentry(forkey:)"]}],"abstract":[{"type":"text","text":"Deletes a storage entry."}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage\/deleteEntry(forKey:)","interfaceLanguage":"swift"},"metadata":{"role":"symbol","modules":[{"name":"Auth0"}],"roleHeading":"Instance Method","required":true,"externalID":"s:5Auth018CredentialsStorageP11deleteEntry6forKeySbSS_tF","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"deleteEntry"},{"kind":"text","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"}],"symbolKind":"method","title":"deleteEntry(forKey:)"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage/deleteEntry(forKey:)":{"abstract":[{"text":"Deletes a storage entry.","type":"text"}],"role":"symbol","url":"\/documentation\/auth0\/credentialsstorage\/deleteentry(forkey:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage\/deleteEntry(forKey:)","required":true,"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"deleteEntry","kind":"identifier"},{"text":"(","kind":"text"},{"text":"forKey","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"type":"topic","kind":"symbol","title":"deleteEntry(forKey:)"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage":{"title":"CredentialsStorage","kind":"symbol","navigatorTitle":[{"text":"CredentialsStorage","kind":"identifier"}],"role":"symbol","url":"\/documentation\/auth0\/credentialsstorage","abstract":[{"text":"Generic storage API for storing credentials.","type":"text"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsStorage","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"metadata":{"roleHeading":"Instance Method","symbolKind":"method","title":"deleteEntry(forKey:)","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"deleteEntry"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"required":true,"externalID":"s:5Auth018CredentialsStorageP11deleteEntry6forKeySbSS_tF","modules":[{"name":"Auth0"}]},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsstorage\/deleteentry(forkey:)"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage\/deleteEntry(forKey:)","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"text":"Deletes a storage entry.","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"deleteEntry","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"forKey"},{"text":" ","kind":"text"},{"text":"key","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"platforms":["iOS"],"languages":["swift"]}]},{"parameters":[{"name":"key","content":[{"inlineContent":[{"text":"The key to delete from the store.","type":"text"}],"type":"paragraph"}]}],"kind":"parameters"},{"content":[{"anchor":"return-value","level":2,"text":"Return Value","type":"heading"},{"type":"paragraph","inlineContent":[{"text":"If the entry was deleted.","type":"text"}]}],"kind":"content"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage":{"title":"CredentialsStorage","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","role":"symbol","kind":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsStorage","kind":"identifier"}],"abstract":[{"text":"Generic storage API for storing credentials.","type":"text"}],"url":"\/documentation\/auth0\/credentialsstorage","navigatorTitle":[{"text":"CredentialsStorage","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage/deleteEntry(forKey:)":{"title":"deleteEntry(forKey:)","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage\/deleteEntry(forKey:)","role":"symbol","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"deleteEntry","kind":"identifier"},{"text":"(","kind":"text"},{"text":"forKey","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"abstract":[{"text":"Deletes a storage entry.","type":"text"}],"url":"\/documentation\/auth0\/credentialsstorage\/deleteentry(forkey:)","required":true}}} \ 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 6cd01383c..ce292aebf 100644 --- a/docs/data/documentation/auth0/credentialsstorage/getentry(forkey:).json +++ b/docs/data/documentation/auth0/credentialsstorage/getentry(forkey:).json @@ -1 +1 @@ -{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage\/getEntry(forKey:)"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage"]]},"abstract":[{"text":"Retrieves a storage entry.","type":"text"}],"metadata":{"externalID":"s:5Auth018CredentialsStorageP8getEntry6forKey10Foundation4DataVSgSS_tF","required":true,"modules":[{"name":"Auth0"}],"title":"getEntry(forKey:)","symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getEntry","kind":"identifier"},{"text":"(","kind":"text"},{"text":"forKey","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"Data","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV"},{"text":"?","kind":"text"}],"role":"symbol","roleHeading":"Instance Method"},"kind":"symbol","sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getEntry","kind":"identifier"},{"text":"(","kind":"text"},{"text":"forKey","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"key","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Data","preciseIdentifier":"s:10Foundation4DataV","kind":"typeIdentifier"},{"text":"?","kind":"text"}]}]},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"text":"The key to get from the store.","type":"text"}]}],"name":"key"}]},{"kind":"content","content":[{"text":"Return Value","level":2,"type":"heading","anchor":"return-value"},{"inlineContent":[{"text":"The stored data.","type":"text"}],"type":"paragraph"}]}],"variants":[{"paths":["\/documentation\/auth0\/credentialsstorage\/getentry(forkey:)"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage":{"title":"CredentialsStorage","kind":"symbol","navigatorTitle":[{"text":"CredentialsStorage","kind":"identifier"}],"role":"symbol","url":"\/documentation\/auth0\/credentialsstorage","abstract":[{"text":"Generic storage API for storing credentials.","type":"text"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsStorage","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage/getEntry(forKey:)":{"type":"topic","url":"\/documentation\/auth0\/credentialsstorage\/getentry(forkey:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage\/getEntry(forKey:)","abstract":[{"type":"text","text":"Retrieves a storage entry."}],"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getEntry"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:10Foundation4DataV","kind":"typeIdentifier","text":"Data"},{"kind":"text","text":"?"}],"title":"getEntry(forKey:)","required":true}}} \ No newline at end of file +{"abstract":[{"type":"text","text":"Retrieves a storage entry."}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getEntry","kind":"identifier"},{"text":"(","kind":"text"},{"text":"forKey","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"key","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Data","preciseIdentifier":"s:10Foundation4DataV","kind":"typeIdentifier"},{"kind":"text","text":"?"}]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The key to get from the store."}]}],"name":"key"}]},{"kind":"content","content":[{"type":"heading","level":2,"anchor":"return-value","text":"Return Value"},{"inlineContent":[{"type":"text","text":"The stored data."}],"type":"paragraph"}]}],"variants":[{"paths":["\/documentation\/auth0\/credentialsstorage\/getentry(forkey:)"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"patch":0,"minor":3,"major":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage"]]},"metadata":{"externalID":"s:5Auth018CredentialsStorageP8getEntry6forKey10Foundation4DataVSgSS_tF","symbolKind":"method","title":"getEntry(forKey:)","required":true,"roleHeading":"Instance Method","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getEntry","kind":"identifier"},{"text":"(","kind":"text"},{"text":"forKey","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"Data","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV"},{"text":"?","kind":"text"}],"modules":[{"name":"Auth0"}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage\/getEntry(forKey:)"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage/getEntry(forKey:)":{"type":"topic","abstract":[{"type":"text","text":"Retrieves a storage entry."}],"title":"getEntry(forKey:)","kind":"symbol","url":"\/documentation\/auth0\/credentialsstorage\/getentry(forkey:)","required":true,"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getEntry","kind":"identifier"},{"text":"(","kind":"text"},{"text":"forKey","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"Data","preciseIdentifier":"s:10Foundation4DataV","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage\/getEntry(forKey:)"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage":{"title":"CredentialsStorage","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","role":"symbol","kind":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsStorage","kind":"identifier"}],"abstract":[{"text":"Generic storage API for storing credentials.","type":"text"}],"url":"\/documentation\/auth0\/credentialsstorage","navigatorTitle":[{"text":"CredentialsStorage","kind":"identifier"}]}}} \ 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 7f9f7cb08..c36409aac 100644 --- a/docs/data/documentation/auth0/credentialsstorage/setentry(_:forkey:).json +++ b/docs/data/documentation/auth0/credentialsstorage/setentry(_:forkey:).json @@ -1 +1 @@ -{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage\/setEntry(_:forKey:)"},"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"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"},{"text":": ","kind":"text"},{"text":"Data","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV"},{"text":", ","kind":"text"},{"text":"forKey","kind":"externalParam"},{"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"}],"languages":["swift"]}]},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"text":"The data to be stored.","type":"text"}]}],"name":"data"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The key to store it to."}]}],"name":"key"}]},{"kind":"content","content":[{"type":"heading","anchor":"return-value","level":2,"text":"Return Value"},{"type":"paragraph","inlineContent":[{"text":"If the data was stored.","type":"text"}]}]}],"abstract":[{"text":"Sets a storage entry.","type":"text"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage"]]},"metadata":{"required":true,"externalID":"s:5Auth018CredentialsStorageP8setEntry_6forKeySb10Foundation4DataV_SStF","modules":[{"name":"Auth0"}],"title":"setEntry(_:forKey:)","symbolKind":"method","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"setEntry"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"roleHeading":"Instance Method"},"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsstorage\/setentry(_:forkey:)"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage/setEntry(_:forKey:)":{"role":"symbol","kind":"symbol","url":"\/documentation\/auth0\/credentialsstorage\/setentry(_:forkey:)","required":true,"abstract":[{"text":"Sets a storage entry.","type":"text"}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"setEntry"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"title":"setEntry(_:forKey:)","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage\/setEntry(_:forKey:)"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage":{"title":"CredentialsStorage","kind":"symbol","navigatorTitle":[{"text":"CredentialsStorage","kind":"identifier"}],"role":"symbol","url":"\/documentation\/auth0\/credentialsstorage","abstract":[{"text":"Generic storage API for storing credentials.","type":"text"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsStorage","kind":"identifier"}]}}} \ No newline at end of file +{"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"setEntry"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":" "},{"kind":"internalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}]}],"kind":"declarations"},{"parameters":[{"content":[{"inlineContent":[{"text":"The data to be stored.","type":"text"}],"type":"paragraph"}],"name":"data"},{"content":[{"inlineContent":[{"text":"The key to store it to.","type":"text"}],"type":"paragraph"}],"name":"key"}],"kind":"parameters"},{"content":[{"level":2,"type":"heading","anchor":"return-value","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"If the data was stored."}]}],"kind":"content"}],"sections":[],"abstract":[{"type":"text","text":"Sets a storage entry."}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/credentialsstorage\/setentry(_:forkey:)"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage\/setEntry(_:forKey:)","interfaceLanguage":"swift"},"metadata":{"role":"symbol","title":"setEntry(_:forKey:)","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"setEntry"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV","text":"Data"},{"kind":"text","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"}],"externalID":"s:5Auth018CredentialsStorageP8setEntry_6forKeySb10Foundation4DataV_SStF","roleHeading":"Instance Method","required":true,"symbolKind":"method"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage":{"title":"CredentialsStorage","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","role":"symbol","kind":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsStorage","kind":"identifier"}],"abstract":[{"text":"Generic storage API for storing credentials.","type":"text"}],"url":"\/documentation\/auth0\/credentialsstorage","navigatorTitle":[{"text":"CredentialsStorage","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage/setEntry(_:forKey:)":{"type":"topic","title":"setEntry(_:forKey:)","url":"\/documentation\/auth0\/credentialsstorage\/setentry(_:forkey:)","kind":"symbol","abstract":[{"type":"text","text":"Sets a storage entry."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage\/setEntry(_:forKey:)","required":true,"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"setEntry"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV","text":"Data"},{"kind":"text","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"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/cryptokit.json b/docs/data/documentation/auth0/cryptokit.json index 564d8c1da..64d274329 100644 --- a/docs/data/documentation/auth0/cryptokit.json +++ b/docs/data/documentation/auth0/cryptokit.json @@ -1 +1 @@ -{"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"metadata":{"symbolKind":"extension","externalID":"s:m:s:e:s:e:s:e:s:9CryptoKit4P256O7SigningO10PrivateKeyV5Auth0E11descriptionSSvp","roleHeading":"Extended Module","modules":[{"name":"Auth0"}],"title":"CryptoKit","role":"collection"},"variants":[{"paths":["\/documentation\/auth0\/cryptokit"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit","interfaceLanguage":"swift"},"topicSections":[{"generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/P256","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave"],"anchor":"Extended-Types","title":"Extended Types"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/P256":{"navigatorTitle":[{"text":"P256","kind":"identifier"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/P256","url":"\/documentation\/auth0\/cryptokit\/p256","abstract":[],"title":"P256","kind":"symbol","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/SecureEnclave":{"url":"\/documentation\/auth0\/cryptokit\/secureenclave","role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave","title":"SecureEnclave","abstract":[],"navigatorTitle":[{"kind":"identifier","text":"SecureEnclave"}]},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit","title":"CryptoKit","kind":"symbol","type":"topic","role":"collection","abstract":[],"url":"\/documentation\/auth0\/cryptokit"}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/cryptokit"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"topicSections":[{"title":"Extended Types","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/P256","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave"],"generated":true,"anchor":"Extended-Types"}],"metadata":{"title":"CryptoKit","symbolKind":"extension","role":"collection","externalID":"s:m:s:e:s:e:s:e:s:9CryptoKit4P256O7SigningO10PrivateKeyV5Auth0E11descriptionSSvp","modules":[{"name":"Auth0"}],"roleHeading":"Extended Module"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit","interfaceLanguage":"swift"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/P256":{"kind":"symbol","abstract":[],"type":"topic","url":"\/documentation\/auth0\/cryptokit\/p256","title":"P256","role":"symbol","navigatorTitle":[{"text":"P256","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/P256"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/SecureEnclave":{"kind":"symbol","abstract":[],"type":"topic","title":"SecureEnclave","url":"\/documentation\/auth0\/cryptokit\/secureenclave","role":"symbol","navigatorTitle":[{"text":"SecureEnclave","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit":{"title":"CryptoKit","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit","role":"collection","kind":"symbol","abstract":[],"url":"\/documentation\/auth0\/cryptokit"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/cryptokit/p256.json b/docs/data/documentation/auth0/cryptokit/p256.json index 9a0f997cf..506b90341 100644 --- a/docs/data/documentation/auth0/cryptokit/p256.json +++ b/docs/data/documentation/auth0/cryptokit/p256.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit"]]},"kind":"symbol","sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/P256"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/cryptokit\/p256"]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"topicSections":[{"generated":true,"anchor":"Extended-Types","title":"Extended Types","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/P256\/Signing"]}],"metadata":{"navigatorTitle":[{"kind":"identifier","text":"P256"}],"extendedModule":"CryptoKit","role":"symbol","symbolKind":"extension","roleHeading":"Extended Type","externalID":"s:e:s:e:s:e:s:9CryptoKit4P256O7SigningO10PrivateKeyV5Auth0E11descriptionSSvp","modules":[{"name":"Auth0","relatedModules":["CryptoKit"]}],"title":"P256"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/P256/Signing":{"navigatorTitle":[{"text":"Signing","kind":"identifier"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/P256\/Signing","url":"\/documentation\/auth0\/cryptokit\/p256\/signing","abstract":[],"kind":"symbol","title":"P256.Signing","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit","title":"CryptoKit","kind":"symbol","type":"topic","role":"collection","abstract":[],"url":"\/documentation\/auth0\/cryptokit"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/P256":{"navigatorTitle":[{"text":"P256","kind":"identifier"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/P256","url":"\/documentation\/auth0\/cryptokit\/p256","abstract":[],"title":"P256","kind":"symbol","role":"symbol"}}} \ No newline at end of file +{"metadata":{"symbolKind":"extension","title":"P256","externalID":"s:e:s:e:s:e:s:9CryptoKit4P256O7SigningO10PrivateKeyV5Auth0E11descriptionSSvp","roleHeading":"Extended Type","extendedModule":"CryptoKit","modules":[{"name":"Auth0","relatedModules":["CryptoKit"]}],"navigatorTitle":[{"kind":"identifier","text":"P256"}],"role":"symbol"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/cryptokit\/p256"]}],"topicSections":[{"title":"Extended Types","generated":true,"anchor":"Extended-Types","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/P256\/Signing"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/P256","interfaceLanguage":"swift"},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit":{"title":"CryptoKit","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit","role":"collection","kind":"symbol","abstract":[],"url":"\/documentation\/auth0\/cryptokit"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/P256/Signing":{"kind":"symbol","abstract":[],"type":"topic","url":"\/documentation\/auth0\/cryptokit\/p256\/signing","title":"P256.Signing","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Signing"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/P256\/Signing"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/P256":{"kind":"symbol","abstract":[],"type":"topic","url":"\/documentation\/auth0\/cryptokit\/p256","title":"P256","role":"symbol","navigatorTitle":[{"text":"P256","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/P256"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/cryptokit/p256/signing.json b/docs/data/documentation/auth0/cryptokit/p256/signing.json index 45eae5bf0..9a538cc04 100644 --- a/docs/data/documentation/auth0/cryptokit/p256/signing.json +++ b/docs/data/documentation/auth0/cryptokit/p256/signing.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/P256"]]},"schemaVersion":{"minor":3,"major":0,"patch":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/P256\/Signing","interfaceLanguage":"swift"},"metadata":{"roleHeading":"Extended Type","navigatorTitle":[{"kind":"identifier","text":"Signing"}],"modules":[{"name":"Auth0","relatedModules":["CryptoKit"]}],"externalID":"s:e:s:e:s:9CryptoKit4P256O7SigningO10PrivateKeyV5Auth0E11descriptionSSvp","title":"P256.Signing","extendedModule":"CryptoKit","symbolKind":"extension","role":"symbol"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/cryptokit\/p256\/signing"]}],"sections":[],"topicSections":[{"title":"Extended Structures","generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/P256\/Signing\/PrivateKey"],"anchor":"Extended-Structures"}],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/P256":{"navigatorTitle":[{"text":"P256","kind":"identifier"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/P256","url":"\/documentation\/auth0\/cryptokit\/p256","abstract":[],"title":"P256","kind":"symbol","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/P256/Signing/PrivateKey":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/P256\/Signing\/PrivateKey","type":"topic","title":"P256.Signing.PrivateKey","url":"\/documentation\/auth0\/cryptokit\/p256\/signing\/privatekey","abstract":[],"role":"symbol","navigatorTitle":[{"text":"PrivateKey","kind":"identifier"}],"kind":"symbol","fragments":[{"text":"extension","kind":"keyword"},{"text":" ","kind":"text"},{"preciseIdentifier":"s:9CryptoKit4P256O","text":"P256","kind":"identifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:9CryptoKit4P256O7SigningO","text":"Signing","kind":"identifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:9CryptoKit4P256O7SigningO10PrivateKeyV","text":"PrivateKey","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit","title":"CryptoKit","kind":"symbol","type":"topic","role":"collection","abstract":[],"url":"\/documentation\/auth0\/cryptokit"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/P256/Signing":{"navigatorTitle":[{"text":"Signing","kind":"identifier"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/P256\/Signing","url":"\/documentation\/auth0\/cryptokit\/p256\/signing","abstract":[],"kind":"symbol","title":"P256.Signing","role":"symbol"}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/cryptokit\/p256\/signing"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/P256"]]},"topicSections":[{"title":"Extended Structures","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/P256\/Signing\/PrivateKey"],"anchor":"Extended-Structures","generated":true}],"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"metadata":{"externalID":"s:e:s:e:s:9CryptoKit4P256O7SigningO10PrivateKeyV5Auth0E11descriptionSSvp","extendedModule":"CryptoKit","symbolKind":"extension","title":"P256.Signing","role":"symbol","roleHeading":"Extended Type","navigatorTitle":[{"kind":"identifier","text":"Signing"}],"modules":[{"name":"Auth0","relatedModules":["CryptoKit"]}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/P256\/Signing"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit":{"title":"CryptoKit","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit","role":"collection","kind":"symbol","abstract":[],"url":"\/documentation\/auth0\/cryptokit"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/P256/Signing/PrivateKey":{"role":"symbol","title":"P256.Signing.PrivateKey","fragments":[{"kind":"keyword","text":"extension"},{"kind":"text","text":" "},{"kind":"identifier","text":"P256","preciseIdentifier":"s:9CryptoKit4P256O"},{"kind":"text","text":"."},{"kind":"identifier","preciseIdentifier":"s:9CryptoKit4P256O7SigningO","text":"Signing"},{"kind":"text","text":"."},{"preciseIdentifier":"s:9CryptoKit4P256O7SigningO10PrivateKeyV","text":"PrivateKey","kind":"identifier"}],"navigatorTitle":[{"text":"PrivateKey","kind":"identifier"}],"abstract":[],"kind":"symbol","url":"\/documentation\/auth0\/cryptokit\/p256\/signing\/privatekey","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/P256\/Signing\/PrivateKey","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/P256/Signing":{"kind":"symbol","abstract":[],"type":"topic","url":"\/documentation\/auth0\/cryptokit\/p256\/signing","title":"P256.Signing","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Signing"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/P256\/Signing"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/P256":{"kind":"symbol","abstract":[],"type":"topic","url":"\/documentation\/auth0\/cryptokit\/p256","title":"P256","role":"symbol","navigatorTitle":[{"text":"P256","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/P256"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/cryptokit/p256/signing/privatekey.json b/docs/data/documentation/auth0/cryptokit/p256/signing/privatekey.json index 240a632bf..b627193a0 100644 --- a/docs/data/documentation/auth0/cryptokit/p256/signing/privatekey.json +++ b/docs/data/documentation/auth0/cryptokit/p256/signing/privatekey.json @@ -1 +1 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/P256\/Signing\/PrivateKey","interfaceLanguage":"swift"},"topicSections":[{"anchor":"Default-Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/P256\/Signing\/PrivateKey\/CustomStringConvertible-Implementations"],"generated":true,"title":"Default Implementations"}],"metadata":{"fragments":[{"text":"extension","kind":"keyword"},{"text":" ","kind":"text"},{"preciseIdentifier":"s:9CryptoKit4P256O","text":"P256","kind":"identifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:9CryptoKit4P256O7SigningO","text":"Signing","kind":"identifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:9CryptoKit4P256O7SigningO10PrivateKeyV","text":"PrivateKey","kind":"identifier"}],"modules":[{"name":"Auth0","relatedModules":["CryptoKit"]}],"symbolKind":"extension","role":"symbol","roleHeading":"Extended Structure","externalID":"s:e:s:9CryptoKit4P256O7SigningO10PrivateKeyV5Auth0E11descriptionSSvp","title":"P256.Signing.PrivateKey","navigatorTitle":[{"text":"PrivateKey","kind":"identifier"}],"extendedModule":"CryptoKit"},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/P256","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/P256\/Signing"]]},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"extension","kind":"keyword"},{"text":" ","kind":"text"},{"text":"P256","kind":"typeIdentifier","preciseIdentifier":"s:9CryptoKit4P256O"},{"text":".","kind":"text"},{"text":"Signing","kind":"typeIdentifier","preciseIdentifier":"s:9CryptoKit4P256O7SigningO"},{"text":".","kind":"text"},{"text":"PrivateKey","kind":"typeIdentifier","preciseIdentifier":"s:9CryptoKit4P256O7SigningO10PrivateKeyV"}]}],"kind":"declarations"}],"schemaVersion":{"patch":0,"major":0,"minor":3},"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/cryptokit\/p256\/signing\/privatekey"]}],"relationshipsSections":[{"title":"Conforms To","type":"conformsTo","identifiers":["doc:\/\/com.auth0.Auth0\/s8CopyableP","doc:\/\/com.auth0.Auth0\/s23CustomStringConvertibleP"],"kind":"relationships"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/P256/Signing":{"navigatorTitle":[{"text":"Signing","kind":"identifier"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/P256\/Signing","url":"\/documentation\/auth0\/cryptokit\/p256\/signing","abstract":[],"kind":"symbol","title":"P256.Signing","role":"symbol"},"doc://com.auth0.Auth0/s23CustomStringConvertibleP":{"title":"Swift.CustomStringConvertible","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s23CustomStringConvertibleP"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/P256":{"navigatorTitle":[{"text":"P256","kind":"identifier"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/P256","url":"\/documentation\/auth0\/cryptokit\/p256","abstract":[],"title":"P256","kind":"symbol","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/P256/Signing/PrivateKey/CustomStringConvertible-Implementations":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/P256\/Signing\/PrivateKey\/CustomStringConvertible-Implementations","title":"CustomStringConvertible Implementations","type":"topic","abstract":[],"url":"\/documentation\/auth0\/cryptokit\/p256\/signing\/privatekey\/customstringconvertible-implementations","role":"collectionGroup","kind":"article"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/P256/Signing/PrivateKey":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/P256\/Signing\/PrivateKey","type":"topic","title":"P256.Signing.PrivateKey","url":"\/documentation\/auth0\/cryptokit\/p256\/signing\/privatekey","abstract":[],"role":"symbol","navigatorTitle":[{"text":"PrivateKey","kind":"identifier"}],"kind":"symbol","fragments":[{"text":"extension","kind":"keyword"},{"text":" ","kind":"text"},{"preciseIdentifier":"s:9CryptoKit4P256O","text":"P256","kind":"identifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:9CryptoKit4P256O7SigningO","text":"Signing","kind":"identifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:9CryptoKit4P256O7SigningO10PrivateKeyV","text":"PrivateKey","kind":"identifier"}]},"doc://com.auth0.Auth0/s8CopyableP":{"title":"Swift.Copyable","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s8CopyableP"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit","title":"CryptoKit","kind":"symbol","type":"topic","role":"collection","abstract":[],"url":"\/documentation\/auth0\/cryptokit"}}} \ No newline at end of file +{"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/P256\/Signing\/PrivateKey","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"extension"},{"text":" ","kind":"text"},{"kind":"typeIdentifier","text":"P256","preciseIdentifier":"s:9CryptoKit4P256O"},{"kind":"text","text":"."},{"preciseIdentifier":"s:9CryptoKit4P256O7SigningO","text":"Signing","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"PrivateKey","preciseIdentifier":"s:9CryptoKit4P256O7SigningO10PrivateKeyV","kind":"typeIdentifier"}],"platforms":["iOS"],"languages":["swift"]}]}],"relationshipsSections":[{"kind":"relationships","title":"Conforms To","type":"conformsTo","identifiers":["doc:\/\/com.auth0.Auth0\/s8CopyableP","doc:\/\/com.auth0.Auth0\/s23CustomStringConvertibleP"]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/cryptokit\/p256\/signing\/privatekey"]}],"kind":"symbol","metadata":{"roleHeading":"Extended Structure","symbolKind":"extension","modules":[{"relatedModules":["CryptoKit"],"name":"Auth0"}],"title":"P256.Signing.PrivateKey","navigatorTitle":[{"text":"PrivateKey","kind":"identifier"}],"fragments":[{"text":"extension","kind":"keyword"},{"text":" ","kind":"text"},{"preciseIdentifier":"s:9CryptoKit4P256O","text":"P256","kind":"identifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:9CryptoKit4P256O7SigningO","text":"Signing","kind":"identifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:9CryptoKit4P256O7SigningO10PrivateKeyV","text":"PrivateKey","kind":"identifier"}],"externalID":"s:e:s:9CryptoKit4P256O7SigningO10PrivateKeyV5Auth0E11descriptionSSvp","role":"symbol","extendedModule":"CryptoKit"},"schemaVersion":{"major":0,"minor":3,"patch":0},"topicSections":[{"generated":true,"title":"Default Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/P256\/Signing\/PrivateKey\/CustomStringConvertible-Implementations"],"anchor":"Default-Implementations"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/P256","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/P256\/Signing"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/P256/Signing":{"kind":"symbol","abstract":[],"type":"topic","url":"\/documentation\/auth0\/cryptokit\/p256\/signing","title":"P256.Signing","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Signing"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/P256\/Signing"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/s8CopyableP":{"identifier":"doc:\/\/com.auth0.Auth0\/s8CopyableP","title":"Swift.Copyable","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/P256":{"kind":"symbol","abstract":[],"type":"topic","url":"\/documentation\/auth0\/cryptokit\/p256","title":"P256","role":"symbol","navigatorTitle":[{"text":"P256","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/P256"},"doc://com.auth0.Auth0/s23CustomStringConvertibleP":{"title":"Swift.CustomStringConvertible","identifier":"doc:\/\/com.auth0.Auth0\/s23CustomStringConvertibleP","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/P256/Signing/PrivateKey":{"role":"symbol","title":"P256.Signing.PrivateKey","fragments":[{"kind":"keyword","text":"extension"},{"kind":"text","text":" "},{"kind":"identifier","text":"P256","preciseIdentifier":"s:9CryptoKit4P256O"},{"kind":"text","text":"."},{"kind":"identifier","preciseIdentifier":"s:9CryptoKit4P256O7SigningO","text":"Signing"},{"kind":"text","text":"."},{"preciseIdentifier":"s:9CryptoKit4P256O7SigningO10PrivateKeyV","text":"PrivateKey","kind":"identifier"}],"navigatorTitle":[{"text":"PrivateKey","kind":"identifier"}],"abstract":[],"kind":"symbol","url":"\/documentation\/auth0\/cryptokit\/p256\/signing\/privatekey","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/P256\/Signing\/PrivateKey","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit":{"title":"CryptoKit","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit","role":"collection","kind":"symbol","abstract":[],"url":"\/documentation\/auth0\/cryptokit"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/P256/Signing/PrivateKey/CustomStringConvertible-Implementations":{"url":"\/documentation\/auth0\/cryptokit\/p256\/signing\/privatekey\/customstringconvertible-implementations","title":"CustomStringConvertible Implementations","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/P256\/Signing\/PrivateKey\/CustomStringConvertible-Implementations","role":"collectionGroup","kind":"article","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/cryptokit/p256/signing/privatekey/customstringconvertible-implementations.json b/docs/data/documentation/auth0/cryptokit/p256/signing/privatekey/customstringconvertible-implementations.json index 9501d017f..3601e264e 100644 --- a/docs/data/documentation/auth0/cryptokit/p256/signing/privatekey/customstringconvertible-implementations.json +++ b/docs/data/documentation/auth0/cryptokit/p256/signing/privatekey/customstringconvertible-implementations.json @@ -1 +1 @@ -{"metadata":{"role":"collectionGroup","title":"CustomStringConvertible Implementations","modules":[{"name":"Auth0"}],"roleHeading":"API Collection"},"kind":"article","variants":[{"paths":["\/documentation\/auth0\/cryptokit\/p256\/signing\/privatekey\/customstringconvertible-implementations"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/P256\/Signing\/PrivateKey\/CustomStringConvertible-Implementations","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/P256","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/P256\/Signing","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/P256\/Signing\/PrivateKey"]]},"schemaVersion":{"minor":3,"major":0,"patch":0},"sections":[],"topicSections":[{"anchor":"Instance-Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/P256\/Signing\/PrivateKey\/description"],"generated":true,"title":"Instance Properties"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit","title":"CryptoKit","kind":"symbol","type":"topic","role":"collection","abstract":[],"url":"\/documentation\/auth0\/cryptokit"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/P256/Signing/PrivateKey/description":{"title":"description","abstract":[],"url":"\/documentation\/auth0\/cryptokit\/p256\/signing\/privatekey\/description","kind":"symbol","role":"symbol","type":"topic","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"description","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/P256\/Signing\/PrivateKey\/description"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/P256/Signing/PrivateKey":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/P256\/Signing\/PrivateKey","type":"topic","title":"P256.Signing.PrivateKey","url":"\/documentation\/auth0\/cryptokit\/p256\/signing\/privatekey","abstract":[],"role":"symbol","navigatorTitle":[{"text":"PrivateKey","kind":"identifier"}],"kind":"symbol","fragments":[{"text":"extension","kind":"keyword"},{"text":" ","kind":"text"},{"preciseIdentifier":"s:9CryptoKit4P256O","text":"P256","kind":"identifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:9CryptoKit4P256O7SigningO","text":"Signing","kind":"identifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:9CryptoKit4P256O7SigningO10PrivateKeyV","text":"PrivateKey","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/P256/Signing":{"navigatorTitle":[{"text":"Signing","kind":"identifier"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/P256\/Signing","url":"\/documentation\/auth0\/cryptokit\/p256\/signing","abstract":[],"kind":"symbol","title":"P256.Signing","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/P256":{"navigatorTitle":[{"text":"P256","kind":"identifier"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/P256","url":"\/documentation\/auth0\/cryptokit\/p256","abstract":[],"title":"P256","kind":"symbol","role":"symbol"}}} \ No newline at end of file +{"topicSections":[{"title":"Instance Properties","generated":true,"anchor":"Instance-Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/P256\/Signing\/PrivateKey\/description"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/cryptokit\/p256\/signing\/privatekey\/customstringconvertible-implementations"]}],"kind":"article","metadata":{"roleHeading":"API Collection","modules":[{"name":"Auth0"}],"role":"collectionGroup","title":"CustomStringConvertible Implementations"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/P256\/Signing\/PrivateKey\/CustomStringConvertible-Implementations"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/P256","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/P256\/Signing","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/P256\/Signing\/PrivateKey"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/P256/Signing":{"kind":"symbol","abstract":[],"type":"topic","url":"\/documentation\/auth0\/cryptokit\/p256\/signing","title":"P256.Signing","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Signing"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/P256\/Signing"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit":{"title":"CryptoKit","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit","role":"collection","kind":"symbol","abstract":[],"url":"\/documentation\/auth0\/cryptokit"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/P256":{"kind":"symbol","abstract":[],"type":"topic","url":"\/documentation\/auth0\/cryptokit\/p256","title":"P256","role":"symbol","navigatorTitle":[{"text":"P256","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/P256"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/P256/Signing/PrivateKey":{"role":"symbol","title":"P256.Signing.PrivateKey","fragments":[{"kind":"keyword","text":"extension"},{"kind":"text","text":" "},{"kind":"identifier","text":"P256","preciseIdentifier":"s:9CryptoKit4P256O"},{"kind":"text","text":"."},{"kind":"identifier","preciseIdentifier":"s:9CryptoKit4P256O7SigningO","text":"Signing"},{"kind":"text","text":"."},{"preciseIdentifier":"s:9CryptoKit4P256O7SigningO10PrivateKeyV","text":"PrivateKey","kind":"identifier"}],"navigatorTitle":[{"text":"PrivateKey","kind":"identifier"}],"abstract":[],"kind":"symbol","url":"\/documentation\/auth0\/cryptokit\/p256\/signing\/privatekey","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/P256\/Signing\/PrivateKey","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/P256/Signing/PrivateKey/description":{"role":"symbol","title":"description","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"description"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"abstract":[],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/P256\/Signing\/PrivateKey\/description","url":"\/documentation\/auth0\/cryptokit\/p256\/signing\/privatekey\/description","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/cryptokit/p256/signing/privatekey/description.json b/docs/data/documentation/auth0/cryptokit/p256/signing/privatekey/description.json index e4e5ce8d2..b4bef4e6e 100644 --- a/docs/data/documentation/auth0/cryptokit/p256/signing/privatekey/description.json +++ b/docs/data/documentation/auth0/cryptokit/p256/signing/privatekey/description.json @@ -1 +1 @@ -{"schemaVersion":{"patch":0,"major":0,"minor":3},"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"description","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/cryptokit\/p256\/signing\/privatekey\/description"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/P256","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/P256\/Signing","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/P256\/Signing\/PrivateKey"]]},"abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"CustomStringConvertible.description"},{"type":"text","text":"."}],"metadata":{"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"description","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"role":"symbol","externalID":"s:9CryptoKit4P256O7SigningO10PrivateKeyV5Auth0E11descriptionSSvp","modules":[{"relatedModules":["CryptoKit"],"name":"Auth0"}],"roleHeading":"Instance Property","extendedModule":"CryptoKit","symbolKind":"property","title":"description"},"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/P256\/Signing\/PrivateKey\/description"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/P256/Signing":{"navigatorTitle":[{"text":"Signing","kind":"identifier"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/P256\/Signing","url":"\/documentation\/auth0\/cryptokit\/p256\/signing","abstract":[],"kind":"symbol","title":"P256.Signing","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/P256/Signing/PrivateKey":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/P256\/Signing\/PrivateKey","type":"topic","title":"P256.Signing.PrivateKey","url":"\/documentation\/auth0\/cryptokit\/p256\/signing\/privatekey","abstract":[],"role":"symbol","navigatorTitle":[{"text":"PrivateKey","kind":"identifier"}],"kind":"symbol","fragments":[{"text":"extension","kind":"keyword"},{"text":" ","kind":"text"},{"preciseIdentifier":"s:9CryptoKit4P256O","text":"P256","kind":"identifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:9CryptoKit4P256O7SigningO","text":"Signing","kind":"identifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:9CryptoKit4P256O7SigningO10PrivateKeyV","text":"PrivateKey","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/P256":{"navigatorTitle":[{"text":"P256","kind":"identifier"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/P256","url":"\/documentation\/auth0\/cryptokit\/p256","abstract":[],"title":"P256","kind":"symbol","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/P256/Signing/PrivateKey/description":{"title":"description","abstract":[],"url":"\/documentation\/auth0\/cryptokit\/p256\/signing\/privatekey\/description","kind":"symbol","role":"symbol","type":"topic","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"description","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/P256\/Signing\/PrivateKey\/description"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit","title":"CryptoKit","kind":"symbol","type":"topic","role":"collection","abstract":[],"url":"\/documentation\/auth0\/cryptokit"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"schemaVersion":{"patch":0,"major":0,"minor":3},"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"description","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"platforms":["iOS"]}],"kind":"declarations"}],"sections":[],"abstract":[{"text":"Inherited from ","type":"text"},{"code":"CustomStringConvertible.description","type":"codeVoice"},{"text":".","type":"text"}],"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/cryptokit\/p256\/signing\/privatekey\/description"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"role":"symbol","title":"description","modules":[{"name":"Auth0","relatedModules":["CryptoKit"]}],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"description"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"externalID":"s:9CryptoKit4P256O7SigningO10PrivateKeyV5Auth0E11descriptionSSvp","extendedModule":"CryptoKit","roleHeading":"Instance Property","symbolKind":"property"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/P256\/Signing\/PrivateKey\/description","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/P256","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/P256\/Signing","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/P256\/Signing\/PrivateKey"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/P256/Signing":{"kind":"symbol","abstract":[],"type":"topic","url":"\/documentation\/auth0\/cryptokit\/p256\/signing","title":"P256.Signing","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Signing"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/P256\/Signing"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/P256":{"kind":"symbol","abstract":[],"type":"topic","url":"\/documentation\/auth0\/cryptokit\/p256","title":"P256","role":"symbol","navigatorTitle":[{"text":"P256","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/P256"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit":{"title":"CryptoKit","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit","role":"collection","kind":"symbol","abstract":[],"url":"\/documentation\/auth0\/cryptokit"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/P256/Signing/PrivateKey":{"role":"symbol","title":"P256.Signing.PrivateKey","fragments":[{"kind":"keyword","text":"extension"},{"kind":"text","text":" "},{"kind":"identifier","text":"P256","preciseIdentifier":"s:9CryptoKit4P256O"},{"kind":"text","text":"."},{"kind":"identifier","preciseIdentifier":"s:9CryptoKit4P256O7SigningO","text":"Signing"},{"kind":"text","text":"."},{"preciseIdentifier":"s:9CryptoKit4P256O7SigningO10PrivateKeyV","text":"PrivateKey","kind":"identifier"}],"navigatorTitle":[{"text":"PrivateKey","kind":"identifier"}],"abstract":[],"kind":"symbol","url":"\/documentation\/auth0\/cryptokit\/p256\/signing\/privatekey","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/P256\/Signing\/PrivateKey","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/P256/Signing/PrivateKey/description":{"role":"symbol","title":"description","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"description"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"abstract":[],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/P256\/Signing\/PrivateKey\/description","url":"\/documentation\/auth0\/cryptokit\/p256\/signing\/privatekey\/description","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/cryptokit/secureenclave.json b/docs/data/documentation/auth0/cryptokit/secureenclave.json index 079b1c095..d018cbffa 100644 --- a/docs/data/documentation/auth0/cryptokit/secureenclave.json +++ b/docs/data/documentation/auth0/cryptokit/secureenclave.json @@ -1 +1 @@ -{"variants":[{"paths":["\/documentation\/auth0\/cryptokit\/secureenclave"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"role":"symbol","symbolKind":"extension","extendedModule":"CryptoKit","title":"SecureEnclave","roleHeading":"Extended Type","modules":[{"relatedModules":["CryptoKit"],"name":"Auth0"}],"externalID":"s:e:s:e:s:e:s:e:s:9CryptoKit13SecureEnclaveO4P256O7SigningO10PrivateKeyV5Auth0E11descriptionSSvp","navigatorTitle":[{"kind":"identifier","text":"SecureEnclave"}]},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit"]]},"kind":"symbol","sections":[],"topicSections":[{"generated":true,"title":"Extended Types","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave\/P256"],"anchor":"Extended-Types"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave","interfaceLanguage":"swift"},"schemaVersion":{"minor":3,"patch":0,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/SecureEnclave":{"url":"\/documentation\/auth0\/cryptokit\/secureenclave","role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave","title":"SecureEnclave","abstract":[],"navigatorTitle":[{"kind":"identifier","text":"SecureEnclave"}]},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit","title":"CryptoKit","kind":"symbol","type":"topic","role":"collection","abstract":[],"url":"\/documentation\/auth0\/cryptokit"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/SecureEnclave/P256":{"navigatorTitle":[{"kind":"identifier","text":"P256"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave\/P256","kind":"symbol","title":"SecureEnclave.P256","type":"topic","role":"symbol","abstract":[],"url":"\/documentation\/auth0\/cryptokit\/secureenclave\/p256"}}} \ No newline at end of file +{"variants":[{"paths":["\/documentation\/auth0\/cryptokit\/secureenclave"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit"]]},"topicSections":[{"title":"Extended Types","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave\/P256"],"generated":true,"anchor":"Extended-Types"}],"metadata":{"symbolKind":"extension","title":"SecureEnclave","externalID":"s:e:s:e:s:e:s:e:s:9CryptoKit13SecureEnclaveO4P256O7SigningO10PrivateKeyV5Auth0E11descriptionSSvp","extendedModule":"CryptoKit","roleHeading":"Extended Type","modules":[{"relatedModules":["CryptoKit"],"name":"Auth0"}],"navigatorTitle":[{"kind":"identifier","text":"SecureEnclave"}],"role":"symbol"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave","interfaceLanguage":"swift"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/SecureEnclave/P256":{"kind":"symbol","abstract":[],"type":"topic","title":"SecureEnclave.P256","url":"\/documentation\/auth0\/cryptokit\/secureenclave\/p256","role":"symbol","navigatorTitle":[{"text":"P256","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave\/P256"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit":{"title":"CryptoKit","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit","role":"collection","kind":"symbol","abstract":[],"url":"\/documentation\/auth0\/cryptokit"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/SecureEnclave":{"kind":"symbol","abstract":[],"type":"topic","title":"SecureEnclave","url":"\/documentation\/auth0\/cryptokit\/secureenclave","role":"symbol","navigatorTitle":[{"text":"SecureEnclave","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/cryptokit/secureenclave/p256.json b/docs/data/documentation/auth0/cryptokit/secureenclave/p256.json index fd18260e5..2c1ad65fc 100644 --- a/docs/data/documentation/auth0/cryptokit/secureenclave/p256.json +++ b/docs/data/documentation/auth0/cryptokit/secureenclave/p256.json @@ -1 +1 @@ -{"topicSections":[{"generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave\/P256\/Signing"],"anchor":"Extended-Types","title":"Extended Types"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave\/P256","interfaceLanguage":"swift"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/cryptokit\/secureenclave\/p256"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave"]]},"kind":"symbol","sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"externalID":"s:e:s:e:s:e:s:9CryptoKit13SecureEnclaveO4P256O7SigningO10PrivateKeyV5Auth0E11descriptionSSvp","title":"SecureEnclave.P256","navigatorTitle":[{"text":"P256","kind":"identifier"}],"roleHeading":"Extended Type","role":"symbol","extendedModule":"CryptoKit","symbolKind":"extension","modules":[{"relatedModules":["CryptoKit"],"name":"Auth0"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/SecureEnclave/P256/Signing":{"navigatorTitle":[{"kind":"identifier","text":"Signing"}],"url":"\/documentation\/auth0\/cryptokit\/secureenclave\/p256\/signing","abstract":[],"title":"SecureEnclave.P256.Signing","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave\/P256\/Signing","kind":"symbol","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/SecureEnclave/P256":{"navigatorTitle":[{"kind":"identifier","text":"P256"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave\/P256","kind":"symbol","title":"SecureEnclave.P256","type":"topic","role":"symbol","abstract":[],"url":"\/documentation\/auth0\/cryptokit\/secureenclave\/p256"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit","title":"CryptoKit","kind":"symbol","type":"topic","role":"collection","abstract":[],"url":"\/documentation\/auth0\/cryptokit"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/SecureEnclave":{"url":"\/documentation\/auth0\/cryptokit\/secureenclave","role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave","title":"SecureEnclave","abstract":[],"navigatorTitle":[{"kind":"identifier","text":"SecureEnclave"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"sections":[],"topicSections":[{"generated":true,"title":"Extended Types","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave\/P256\/Signing"],"anchor":"Extended-Types"}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/cryptokit\/secureenclave\/p256"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"roleHeading":"Extended Type","navigatorTitle":[{"text":"P256","kind":"identifier"}],"title":"SecureEnclave.P256","role":"symbol","modules":[{"relatedModules":["CryptoKit"],"name":"Auth0"}],"externalID":"s:e:s:e:s:e:s:9CryptoKit13SecureEnclaveO4P256O7SigningO10PrivateKeyV5Auth0E11descriptionSSvp","extendedModule":"CryptoKit","symbolKind":"extension"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave\/P256","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit":{"title":"CryptoKit","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit","role":"collection","kind":"symbol","abstract":[],"url":"\/documentation\/auth0\/cryptokit"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/SecureEnclave/P256":{"kind":"symbol","abstract":[],"type":"topic","title":"SecureEnclave.P256","url":"\/documentation\/auth0\/cryptokit\/secureenclave\/p256","role":"symbol","navigatorTitle":[{"text":"P256","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave\/P256"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/SecureEnclave":{"kind":"symbol","abstract":[],"type":"topic","title":"SecureEnclave","url":"\/documentation\/auth0\/cryptokit\/secureenclave","role":"symbol","navigatorTitle":[{"text":"SecureEnclave","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/SecureEnclave/P256/Signing":{"kind":"symbol","abstract":[],"type":"topic","title":"SecureEnclave.P256.Signing","url":"\/documentation\/auth0\/cryptokit\/secureenclave\/p256\/signing","role":"symbol","navigatorTitle":[{"text":"Signing","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave\/P256\/Signing"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/cryptokit/secureenclave/p256/signing.json b/docs/data/documentation/auth0/cryptokit/secureenclave/p256/signing.json index 7e445b379..b86fa8002 100644 --- a/docs/data/documentation/auth0/cryptokit/secureenclave/p256/signing.json +++ b/docs/data/documentation/auth0/cryptokit/secureenclave/p256/signing.json @@ -1 +1 @@ -{"sections":[],"schemaVersion":{"patch":0,"minor":3,"major":0},"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave\/P256\/Signing\/PrivateKey"],"title":"Extended Structures","generated":true,"anchor":"Extended-Structures"}],"metadata":{"navigatorTitle":[{"kind":"identifier","text":"Signing"}],"title":"SecureEnclave.P256.Signing","roleHeading":"Extended Type","role":"symbol","extendedModule":"CryptoKit","modules":[{"relatedModules":["CryptoKit"],"name":"Auth0"}],"externalID":"s:e:s:e:s:9CryptoKit13SecureEnclaveO4P256O7SigningO10PrivateKeyV5Auth0E11descriptionSSvp","symbolKind":"extension"},"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/cryptokit\/secureenclave\/p256\/signing"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave\/P256\/Signing","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave\/P256"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/SecureEnclave/P256/Signing":{"navigatorTitle":[{"kind":"identifier","text":"Signing"}],"url":"\/documentation\/auth0\/cryptokit\/secureenclave\/p256\/signing","abstract":[],"title":"SecureEnclave.P256.Signing","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave\/P256\/Signing","kind":"symbol","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/SecureEnclave/P256/Signing/PrivateKey":{"kind":"symbol","abstract":[],"url":"\/documentation\/auth0\/cryptokit\/secureenclave\/p256\/signing\/privatekey","navigatorTitle":[{"kind":"identifier","text":"PrivateKey"}],"role":"symbol","title":"SecureEnclave.P256.Signing.PrivateKey","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave\/P256\/Signing\/PrivateKey","type":"topic","fragments":[{"kind":"keyword","text":"extension"},{"kind":"text","text":" "},{"preciseIdentifier":"s:9CryptoKit13SecureEnclaveO","kind":"identifier","text":"SecureEnclave"},{"kind":"text","text":"."},{"preciseIdentifier":"s:9CryptoKit13SecureEnclaveO4P256O","kind":"identifier","text":"P256"},{"kind":"text","text":"."},{"preciseIdentifier":"s:9CryptoKit13SecureEnclaveO4P256O7SigningO","kind":"identifier","text":"Signing"},{"kind":"text","text":"."},{"preciseIdentifier":"s:9CryptoKit13SecureEnclaveO4P256O7SigningO10PrivateKeyV","kind":"identifier","text":"PrivateKey"}]},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/SecureEnclave/P256":{"navigatorTitle":[{"kind":"identifier","text":"P256"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave\/P256","kind":"symbol","title":"SecureEnclave.P256","type":"topic","role":"symbol","abstract":[],"url":"\/documentation\/auth0\/cryptokit\/secureenclave\/p256"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit","title":"CryptoKit","kind":"symbol","type":"topic","role":"collection","abstract":[],"url":"\/documentation\/auth0\/cryptokit"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/SecureEnclave":{"url":"\/documentation\/auth0\/cryptokit\/secureenclave","role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave","title":"SecureEnclave","abstract":[],"navigatorTitle":[{"kind":"identifier","text":"SecureEnclave"}]}}} \ No newline at end of file +{"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave\/P256\/Signing\/PrivateKey"],"generated":true,"title":"Extended Structures","anchor":"Extended-Structures"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/cryptokit\/secureenclave\/p256\/signing"]}],"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave\/P256\/Signing"},"metadata":{"role":"symbol","title":"SecureEnclave.P256.Signing","modules":[{"name":"Auth0","relatedModules":["CryptoKit"]}],"navigatorTitle":[{"text":"Signing","kind":"identifier"}],"externalID":"s:e:s:e:s:9CryptoKit13SecureEnclaveO4P256O7SigningO10PrivateKeyV5Auth0E11descriptionSSvp","extendedModule":"CryptoKit","roleHeading":"Extended Type","symbolKind":"extension"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave\/P256"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/SecureEnclave":{"kind":"symbol","abstract":[],"type":"topic","title":"SecureEnclave","url":"\/documentation\/auth0\/cryptokit\/secureenclave","role":"symbol","navigatorTitle":[{"text":"SecureEnclave","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/SecureEnclave/P256/Signing/PrivateKey":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave\/P256\/Signing\/PrivateKey","title":"SecureEnclave.P256.Signing.PrivateKey","fragments":[{"kind":"keyword","text":"extension"},{"kind":"text","text":" "},{"kind":"identifier","preciseIdentifier":"s:9CryptoKit13SecureEnclaveO","text":"SecureEnclave"},{"kind":"text","text":"."},{"kind":"identifier","preciseIdentifier":"s:9CryptoKit13SecureEnclaveO4P256O","text":"P256"},{"kind":"text","text":"."},{"kind":"identifier","preciseIdentifier":"s:9CryptoKit13SecureEnclaveO4P256O7SigningO","text":"Signing"},{"kind":"text","text":"."},{"kind":"identifier","preciseIdentifier":"s:9CryptoKit13SecureEnclaveO4P256O7SigningO10PrivateKeyV","text":"PrivateKey"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"PrivateKey"}],"url":"\/documentation\/auth0\/cryptokit\/secureenclave\/p256\/signing\/privatekey","abstract":[],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit":{"title":"CryptoKit","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit","role":"collection","kind":"symbol","abstract":[],"url":"\/documentation\/auth0\/cryptokit"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/SecureEnclave/P256/Signing":{"kind":"symbol","abstract":[],"type":"topic","title":"SecureEnclave.P256.Signing","url":"\/documentation\/auth0\/cryptokit\/secureenclave\/p256\/signing","role":"symbol","navigatorTitle":[{"text":"Signing","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave\/P256\/Signing"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/SecureEnclave/P256":{"kind":"symbol","abstract":[],"type":"topic","title":"SecureEnclave.P256","url":"\/documentation\/auth0\/cryptokit\/secureenclave\/p256","role":"symbol","navigatorTitle":[{"text":"P256","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave\/P256"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/cryptokit/secureenclave/p256/signing/privatekey.json b/docs/data/documentation/auth0/cryptokit/secureenclave/p256/signing/privatekey.json index 9f7b9e40d..b92c6c0e7 100644 --- a/docs/data/documentation/auth0/cryptokit/secureenclave/p256/signing/privatekey.json +++ b/docs/data/documentation/auth0/cryptokit/secureenclave/p256/signing/privatekey.json @@ -1 +1 @@ -{"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"extension"},{"kind":"text","text":" "},{"kind":"typeIdentifier","preciseIdentifier":"s:9CryptoKit13SecureEnclaveO","text":"SecureEnclave"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:9CryptoKit13SecureEnclaveO4P256O","text":"P256"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:9CryptoKit13SecureEnclaveO4P256O7SigningO","text":"Signing"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:9CryptoKit13SecureEnclaveO4P256O7SigningO10PrivateKeyV","text":"PrivateKey"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave\/P256","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave\/P256\/Signing"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"relationshipsSections":[{"title":"Conforms To","type":"conformsTo","kind":"relationships","identifiers":["doc:\/\/com.auth0.Auth0\/s8CopyableP","doc:\/\/com.auth0.Auth0\/s23CustomStringConvertibleP"]}],"sections":[],"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave\/P256\/Signing\/PrivateKey","interfaceLanguage":"swift"},"topicSections":[{"title":"Default Implementations","generated":true,"anchor":"Default-Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave\/P256\/Signing\/PrivateKey\/CustomStringConvertible-Implementations"]}],"metadata":{"extendedModule":"CryptoKit","title":"SecureEnclave.P256.Signing.PrivateKey","modules":[{"relatedModules":["CryptoKit"],"name":"Auth0"}],"navigatorTitle":[{"text":"PrivateKey","kind":"identifier"}],"role":"symbol","roleHeading":"Extended Structure","symbolKind":"extension","externalID":"s:e:s:9CryptoKit13SecureEnclaveO4P256O7SigningO10PrivateKeyV5Auth0E11descriptionSSvp","fragments":[{"text":"extension","kind":"keyword"},{"text":" ","kind":"text"},{"preciseIdentifier":"s:9CryptoKit13SecureEnclaveO","text":"SecureEnclave","kind":"identifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:9CryptoKit13SecureEnclaveO4P256O","text":"P256","kind":"identifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:9CryptoKit13SecureEnclaveO4P256O7SigningO","text":"Signing","kind":"identifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:9CryptoKit13SecureEnclaveO4P256O7SigningO10PrivateKeyV","text":"PrivateKey","kind":"identifier"}]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/cryptokit\/secureenclave\/p256\/signing\/privatekey"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/SecureEnclave/P256":{"navigatorTitle":[{"kind":"identifier","text":"P256"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave\/P256","kind":"symbol","title":"SecureEnclave.P256","type":"topic","role":"symbol","abstract":[],"url":"\/documentation\/auth0\/cryptokit\/secureenclave\/p256"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit","title":"CryptoKit","kind":"symbol","type":"topic","role":"collection","abstract":[],"url":"\/documentation\/auth0\/cryptokit"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/SecureEnclave/P256/Signing/PrivateKey/CustomStringConvertible-Implementations":{"role":"collectionGroup","abstract":[],"url":"\/documentation\/auth0\/cryptokit\/secureenclave\/p256\/signing\/privatekey\/customstringconvertible-implementations","kind":"article","title":"CustomStringConvertible Implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave\/P256\/Signing\/PrivateKey\/CustomStringConvertible-Implementations","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/SecureEnclave":{"url":"\/documentation\/auth0\/cryptokit\/secureenclave","role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave","title":"SecureEnclave","abstract":[],"navigatorTitle":[{"kind":"identifier","text":"SecureEnclave"}]},"doc://com.auth0.Auth0/s8CopyableP":{"type":"unresolvable","title":"Swift.Copyable","identifier":"doc:\/\/com.auth0.Auth0\/s8CopyableP"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/SecureEnclave/P256/Signing":{"navigatorTitle":[{"kind":"identifier","text":"Signing"}],"url":"\/documentation\/auth0\/cryptokit\/secureenclave\/p256\/signing","abstract":[],"title":"SecureEnclave.P256.Signing","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave\/P256\/Signing","kind":"symbol","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/SecureEnclave/P256/Signing/PrivateKey":{"kind":"symbol","abstract":[],"url":"\/documentation\/auth0\/cryptokit\/secureenclave\/p256\/signing\/privatekey","navigatorTitle":[{"kind":"identifier","text":"PrivateKey"}],"role":"symbol","title":"SecureEnclave.P256.Signing.PrivateKey","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave\/P256\/Signing\/PrivateKey","type":"topic","fragments":[{"kind":"keyword","text":"extension"},{"kind":"text","text":" "},{"preciseIdentifier":"s:9CryptoKit13SecureEnclaveO","kind":"identifier","text":"SecureEnclave"},{"kind":"text","text":"."},{"preciseIdentifier":"s:9CryptoKit13SecureEnclaveO4P256O","kind":"identifier","text":"P256"},{"kind":"text","text":"."},{"preciseIdentifier":"s:9CryptoKit13SecureEnclaveO4P256O7SigningO","kind":"identifier","text":"Signing"},{"kind":"text","text":"."},{"preciseIdentifier":"s:9CryptoKit13SecureEnclaveO4P256O7SigningO10PrivateKeyV","kind":"identifier","text":"PrivateKey"}]},"doc://com.auth0.Auth0/s23CustomStringConvertibleP":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s23CustomStringConvertibleP","title":"Swift.CustomStringConvertible"}}} \ No newline at end of file +{"topicSections":[{"anchor":"Default-Implementations","title":"Default Implementations","generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave\/P256\/Signing\/PrivateKey\/CustomStringConvertible-Implementations"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave\/P256","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave\/P256\/Signing"]]},"metadata":{"externalID":"s:e:s:9CryptoKit13SecureEnclaveO4P256O7SigningO10PrivateKeyV5Auth0E11descriptionSSvp","modules":[{"name":"Auth0","relatedModules":["CryptoKit"]}],"title":"SecureEnclave.P256.Signing.PrivateKey","extendedModule":"CryptoKit","roleHeading":"Extended Structure","fragments":[{"text":"extension","kind":"keyword"},{"text":" ","kind":"text"},{"preciseIdentifier":"s:9CryptoKit13SecureEnclaveO","text":"SecureEnclave","kind":"identifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:9CryptoKit13SecureEnclaveO4P256O","text":"P256","kind":"identifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:9CryptoKit13SecureEnclaveO4P256O7SigningO","text":"Signing","kind":"identifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:9CryptoKit13SecureEnclaveO4P256O7SigningO10PrivateKeyV","text":"PrivateKey","kind":"identifier"}],"role":"symbol","navigatorTitle":[{"text":"PrivateKey","kind":"identifier"}],"symbolKind":"extension"},"sections":[],"relationshipsSections":[{"title":"Conforms To","kind":"relationships","type":"conformsTo","identifiers":["doc:\/\/com.auth0.Auth0\/s8CopyableP","doc:\/\/com.auth0.Auth0\/s23CustomStringConvertibleP"]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/cryptokit\/secureenclave\/p256\/signing\/privatekey"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave\/P256\/Signing\/PrivateKey","interfaceLanguage":"swift"},"kind":"symbol","schemaVersion":{"patch":0,"minor":3,"major":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"extension","kind":"keyword"},{"text":" ","kind":"text"},{"preciseIdentifier":"s:9CryptoKit13SecureEnclaveO","text":"SecureEnclave","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:9CryptoKit13SecureEnclaveO4P256O","text":"P256","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:9CryptoKit13SecureEnclaveO4P256O7SigningO","text":"Signing","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:9CryptoKit13SecureEnclaveO4P256O7SigningO10PrivateKeyV","text":"PrivateKey","kind":"typeIdentifier"}]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/SecureEnclave/P256/Signing":{"kind":"symbol","abstract":[],"type":"topic","title":"SecureEnclave.P256.Signing","url":"\/documentation\/auth0\/cryptokit\/secureenclave\/p256\/signing","role":"symbol","navigatorTitle":[{"text":"Signing","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave\/P256\/Signing"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/SecureEnclave/P256":{"kind":"symbol","abstract":[],"type":"topic","title":"SecureEnclave.P256","url":"\/documentation\/auth0\/cryptokit\/secureenclave\/p256","role":"symbol","navigatorTitle":[{"text":"P256","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave\/P256"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/SecureEnclave":{"kind":"symbol","abstract":[],"type":"topic","title":"SecureEnclave","url":"\/documentation\/auth0\/cryptokit\/secureenclave","role":"symbol","navigatorTitle":[{"text":"SecureEnclave","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit":{"title":"CryptoKit","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit","role":"collection","kind":"symbol","abstract":[],"url":"\/documentation\/auth0\/cryptokit"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/SecureEnclave/P256/Signing/PrivateKey/CustomStringConvertible-Implementations":{"url":"\/documentation\/auth0\/cryptokit\/secureenclave\/p256\/signing\/privatekey\/customstringconvertible-implementations","title":"CustomStringConvertible Implementations","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave\/P256\/Signing\/PrivateKey\/CustomStringConvertible-Implementations","role":"collectionGroup","kind":"article","type":"topic"},"doc://com.auth0.Auth0/s23CustomStringConvertibleP":{"title":"Swift.CustomStringConvertible","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s23CustomStringConvertibleP"},"doc://com.auth0.Auth0/s8CopyableP":{"title":"Swift.Copyable","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s8CopyableP"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/SecureEnclave/P256/Signing/PrivateKey":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave\/P256\/Signing\/PrivateKey","title":"SecureEnclave.P256.Signing.PrivateKey","fragments":[{"kind":"keyword","text":"extension"},{"kind":"text","text":" "},{"kind":"identifier","preciseIdentifier":"s:9CryptoKit13SecureEnclaveO","text":"SecureEnclave"},{"kind":"text","text":"."},{"kind":"identifier","preciseIdentifier":"s:9CryptoKit13SecureEnclaveO4P256O","text":"P256"},{"kind":"text","text":"."},{"kind":"identifier","preciseIdentifier":"s:9CryptoKit13SecureEnclaveO4P256O7SigningO","text":"Signing"},{"kind":"text","text":"."},{"kind":"identifier","preciseIdentifier":"s:9CryptoKit13SecureEnclaveO4P256O7SigningO10PrivateKeyV","text":"PrivateKey"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"PrivateKey"}],"url":"\/documentation\/auth0\/cryptokit\/secureenclave\/p256\/signing\/privatekey","abstract":[],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/cryptokit/secureenclave/p256/signing/privatekey/customstringconvertible-implementations.json b/docs/data/documentation/auth0/cryptokit/secureenclave/p256/signing/privatekey/customstringconvertible-implementations.json index 89800e62d..1fed6c604 100644 --- a/docs/data/documentation/auth0/cryptokit/secureenclave/p256/signing/privatekey/customstringconvertible-implementations.json +++ b/docs/data/documentation/auth0/cryptokit/secureenclave/p256/signing/privatekey/customstringconvertible-implementations.json @@ -1 +1 @@ -{"metadata":{"roleHeading":"API Collection","modules":[{"name":"Auth0"}],"role":"collectionGroup","title":"CustomStringConvertible Implementations"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave\/P256\/Signing\/PrivateKey\/CustomStringConvertible-Implementations"},"topicSections":[{"generated":true,"anchor":"Instance-Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave\/P256\/Signing\/PrivateKey\/description"],"title":"Instance Properties"}],"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave\/P256","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave\/P256\/Signing","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave\/P256\/Signing\/PrivateKey"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"article","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/cryptokit\/secureenclave\/p256\/signing\/privatekey\/customstringconvertible-implementations"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit","title":"CryptoKit","kind":"symbol","type":"topic","role":"collection","abstract":[],"url":"\/documentation\/auth0\/cryptokit"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/SecureEnclave/P256/Signing/PrivateKey/description":{"url":"\/documentation\/auth0\/cryptokit\/secureenclave\/p256\/signing\/privatekey\/description","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave\/P256\/Signing\/PrivateKey\/description","title":"description","type":"topic","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"description","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/SecureEnclave":{"url":"\/documentation\/auth0\/cryptokit\/secureenclave","role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave","title":"SecureEnclave","abstract":[],"navigatorTitle":[{"kind":"identifier","text":"SecureEnclave"}]},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/SecureEnclave/P256/Signing/PrivateKey":{"kind":"symbol","abstract":[],"url":"\/documentation\/auth0\/cryptokit\/secureenclave\/p256\/signing\/privatekey","navigatorTitle":[{"kind":"identifier","text":"PrivateKey"}],"role":"symbol","title":"SecureEnclave.P256.Signing.PrivateKey","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave\/P256\/Signing\/PrivateKey","type":"topic","fragments":[{"kind":"keyword","text":"extension"},{"kind":"text","text":" "},{"preciseIdentifier":"s:9CryptoKit13SecureEnclaveO","kind":"identifier","text":"SecureEnclave"},{"kind":"text","text":"."},{"preciseIdentifier":"s:9CryptoKit13SecureEnclaveO4P256O","kind":"identifier","text":"P256"},{"kind":"text","text":"."},{"preciseIdentifier":"s:9CryptoKit13SecureEnclaveO4P256O7SigningO","kind":"identifier","text":"Signing"},{"kind":"text","text":"."},{"preciseIdentifier":"s:9CryptoKit13SecureEnclaveO4P256O7SigningO10PrivateKeyV","kind":"identifier","text":"PrivateKey"}]},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/SecureEnclave/P256/Signing":{"navigatorTitle":[{"kind":"identifier","text":"Signing"}],"url":"\/documentation\/auth0\/cryptokit\/secureenclave\/p256\/signing","abstract":[],"title":"SecureEnclave.P256.Signing","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave\/P256\/Signing","kind":"symbol","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/SecureEnclave/P256":{"navigatorTitle":[{"kind":"identifier","text":"P256"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave\/P256","kind":"symbol","title":"SecureEnclave.P256","type":"topic","role":"symbol","abstract":[],"url":"\/documentation\/auth0\/cryptokit\/secureenclave\/p256"}}} \ No newline at end of file +{"sections":[],"kind":"article","metadata":{"role":"collectionGroup","title":"CustomStringConvertible Implementations","roleHeading":"API Collection","modules":[{"name":"Auth0"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave\/P256\/Signing\/PrivateKey\/CustomStringConvertible-Implementations","interfaceLanguage":"swift"},"topicSections":[{"anchor":"Instance-Properties","title":"Instance Properties","generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave\/P256\/Signing\/PrivateKey\/description"]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/cryptokit\/secureenclave\/p256\/signing\/privatekey\/customstringconvertible-implementations"]}],"schemaVersion":{"patch":0,"minor":3,"major":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave\/P256","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave\/P256\/Signing","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave\/P256\/Signing\/PrivateKey"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/SecureEnclave/P256/Signing/PrivateKey/description":{"url":"\/documentation\/auth0\/cryptokit\/secureenclave\/p256\/signing\/privatekey\/description","title":"description","abstract":[],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"description"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave\/P256\/Signing\/PrivateKey\/description","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/SecureEnclave/P256/Signing/PrivateKey":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave\/P256\/Signing\/PrivateKey","title":"SecureEnclave.P256.Signing.PrivateKey","fragments":[{"kind":"keyword","text":"extension"},{"kind":"text","text":" "},{"kind":"identifier","preciseIdentifier":"s:9CryptoKit13SecureEnclaveO","text":"SecureEnclave"},{"kind":"text","text":"."},{"kind":"identifier","preciseIdentifier":"s:9CryptoKit13SecureEnclaveO4P256O","text":"P256"},{"kind":"text","text":"."},{"kind":"identifier","preciseIdentifier":"s:9CryptoKit13SecureEnclaveO4P256O7SigningO","text":"Signing"},{"kind":"text","text":"."},{"kind":"identifier","preciseIdentifier":"s:9CryptoKit13SecureEnclaveO4P256O7SigningO10PrivateKeyV","text":"PrivateKey"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"PrivateKey"}],"url":"\/documentation\/auth0\/cryptokit\/secureenclave\/p256\/signing\/privatekey","abstract":[],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/SecureEnclave/P256":{"kind":"symbol","abstract":[],"type":"topic","title":"SecureEnclave.P256","url":"\/documentation\/auth0\/cryptokit\/secureenclave\/p256","role":"symbol","navigatorTitle":[{"text":"P256","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave\/P256"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/SecureEnclave/P256/Signing":{"kind":"symbol","abstract":[],"type":"topic","title":"SecureEnclave.P256.Signing","url":"\/documentation\/auth0\/cryptokit\/secureenclave\/p256\/signing","role":"symbol","navigatorTitle":[{"text":"Signing","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave\/P256\/Signing"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit":{"title":"CryptoKit","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit","role":"collection","kind":"symbol","abstract":[],"url":"\/documentation\/auth0\/cryptokit"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/SecureEnclave":{"kind":"symbol","abstract":[],"type":"topic","title":"SecureEnclave","url":"\/documentation\/auth0\/cryptokit\/secureenclave","role":"symbol","navigatorTitle":[{"text":"SecureEnclave","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/cryptokit/secureenclave/p256/signing/privatekey/description.json b/docs/data/documentation/auth0/cryptokit/secureenclave/p256/signing/privatekey/description.json index a826f9379..1f7ca731a 100644 --- a/docs/data/documentation/auth0/cryptokit/secureenclave/p256/signing/privatekey/description.json +++ b/docs/data/documentation/auth0/cryptokit/secureenclave/p256/signing/privatekey/description.json @@ -1 +1 @@ -{"abstract":[{"text":"Inherited from ","type":"text"},{"code":"CustomStringConvertible.description","type":"codeVoice"},{"text":".","type":"text"}],"metadata":{"roleHeading":"Instance Property","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"description","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"extendedModule":"CryptoKit","role":"symbol","modules":[{"name":"Auth0","relatedModules":["CryptoKit"]}],"symbolKind":"property","title":"description","externalID":"s:9CryptoKit13SecureEnclaveO4P256O7SigningO10PrivateKeyV5Auth0E11descriptionSSvp"},"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave\/P256\/Signing\/PrivateKey\/description"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave\/P256","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave\/P256\/Signing","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave\/P256\/Signing\/PrivateKey"]]},"variants":[{"paths":["\/documentation\/auth0\/cryptokit\/secureenclave\/p256\/signing\/privatekey\/description"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"schemaVersion":{"minor":3,"patch":0,"major":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"description","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/SecureEnclave":{"url":"\/documentation\/auth0\/cryptokit\/secureenclave","role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave","title":"SecureEnclave","abstract":[],"navigatorTitle":[{"kind":"identifier","text":"SecureEnclave"}]},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit","title":"CryptoKit","kind":"symbol","type":"topic","role":"collection","abstract":[],"url":"\/documentation\/auth0\/cryptokit"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/SecureEnclave/P256/Signing":{"navigatorTitle":[{"kind":"identifier","text":"Signing"}],"url":"\/documentation\/auth0\/cryptokit\/secureenclave\/p256\/signing","abstract":[],"title":"SecureEnclave.P256.Signing","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave\/P256\/Signing","kind":"symbol","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/SecureEnclave/P256":{"navigatorTitle":[{"kind":"identifier","text":"P256"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave\/P256","kind":"symbol","title":"SecureEnclave.P256","type":"topic","role":"symbol","abstract":[],"url":"\/documentation\/auth0\/cryptokit\/secureenclave\/p256"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/SecureEnclave/P256/Signing/PrivateKey/description":{"url":"\/documentation\/auth0\/cryptokit\/secureenclave\/p256\/signing\/privatekey\/description","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave\/P256\/Signing\/PrivateKey\/description","title":"description","type":"topic","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"description","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/SecureEnclave/P256/Signing/PrivateKey":{"kind":"symbol","abstract":[],"url":"\/documentation\/auth0\/cryptokit\/secureenclave\/p256\/signing\/privatekey","navigatorTitle":[{"kind":"identifier","text":"PrivateKey"}],"role":"symbol","title":"SecureEnclave.P256.Signing.PrivateKey","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave\/P256\/Signing\/PrivateKey","type":"topic","fragments":[{"kind":"keyword","text":"extension"},{"kind":"text","text":" "},{"preciseIdentifier":"s:9CryptoKit13SecureEnclaveO","kind":"identifier","text":"SecureEnclave"},{"kind":"text","text":"."},{"preciseIdentifier":"s:9CryptoKit13SecureEnclaveO4P256O","kind":"identifier","text":"P256"},{"kind":"text","text":"."},{"preciseIdentifier":"s:9CryptoKit13SecureEnclaveO4P256O7SigningO","kind":"identifier","text":"Signing"},{"kind":"text","text":"."},{"preciseIdentifier":"s:9CryptoKit13SecureEnclaveO4P256O7SigningO10PrivateKeyV","kind":"identifier","text":"PrivateKey"}]}}} \ No newline at end of file +{"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave\/P256\/Signing\/PrivateKey\/description"},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"description","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/cryptokit\/secureenclave\/p256\/signing\/privatekey\/description"]}],"kind":"symbol","metadata":{"modules":[{"relatedModules":["CryptoKit"],"name":"Auth0"}],"title":"description","externalID":"s:9CryptoKit13SecureEnclaveO4P256O7SigningO10PrivateKeyV5Auth0E11descriptionSSvp","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"description"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"extendedModule":"CryptoKit","roleHeading":"Instance Property","symbolKind":"property"},"schemaVersion":{"minor":3,"patch":0,"major":0},"abstract":[{"text":"Inherited from ","type":"text"},{"code":"CustomStringConvertible.description","type":"codeVoice"},{"text":".","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave\/P256","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave\/P256\/Signing","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave\/P256\/Signing\/PrivateKey"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/SecureEnclave/P256/Signing/PrivateKey/description":{"url":"\/documentation\/auth0\/cryptokit\/secureenclave\/p256\/signing\/privatekey\/description","title":"description","abstract":[],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"description"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave\/P256\/Signing\/PrivateKey\/description","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/SecureEnclave/P256":{"kind":"symbol","abstract":[],"type":"topic","title":"SecureEnclave.P256","url":"\/documentation\/auth0\/cryptokit\/secureenclave\/p256","role":"symbol","navigatorTitle":[{"text":"P256","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave\/P256"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/SecureEnclave/P256/Signing/PrivateKey":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave\/P256\/Signing\/PrivateKey","title":"SecureEnclave.P256.Signing.PrivateKey","fragments":[{"kind":"keyword","text":"extension"},{"kind":"text","text":" "},{"kind":"identifier","preciseIdentifier":"s:9CryptoKit13SecureEnclaveO","text":"SecureEnclave"},{"kind":"text","text":"."},{"kind":"identifier","preciseIdentifier":"s:9CryptoKit13SecureEnclaveO4P256O","text":"P256"},{"kind":"text","text":"."},{"kind":"identifier","preciseIdentifier":"s:9CryptoKit13SecureEnclaveO4P256O7SigningO","text":"Signing"},{"kind":"text","text":"."},{"kind":"identifier","preciseIdentifier":"s:9CryptoKit13SecureEnclaveO4P256O7SigningO10PrivateKeyV","text":"PrivateKey"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"PrivateKey"}],"url":"\/documentation\/auth0\/cryptokit\/secureenclave\/p256\/signing\/privatekey","abstract":[],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/SecureEnclave/P256/Signing":{"kind":"symbol","abstract":[],"type":"topic","title":"SecureEnclave.P256.Signing","url":"\/documentation\/auth0\/cryptokit\/secureenclave\/p256\/signing","role":"symbol","navigatorTitle":[{"text":"Signing","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave\/P256\/Signing"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit/SecureEnclave":{"kind":"symbol","abstract":[],"type":"topic","title":"SecureEnclave","url":"\/documentation\/auth0\/cryptokit\/secureenclave","role":"symbol","navigatorTitle":[{"text":"SecureEnclave","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit\/SecureEnclave"},"doc://com.auth0.Auth0/documentation/Auth0/CryptoKit":{"title":"CryptoKit","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CryptoKit","role":"collection","kind":"symbol","abstract":[],"url":"\/documentation\/auth0\/cryptokit"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/databaseuser.json b/docs/data/documentation/auth0/databaseuser.json index 270c9798e..609c4ab7d 100644 --- a/docs/data/documentation/auth0/databaseuser.json +++ b/docs/data/documentation/auth0/databaseuser.json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"DatabaseUser","kind":"identifier"},{"text":" = (email","kind":"text"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", username","kind":"text"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?, verified","kind":"text"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":")","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DatabaseUser"},"sections":[],"variants":[{"paths":["\/documentation\/auth0\/databaseuser"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"symbolKind":"typealias","modules":[{"name":"Auth0"}],"title":"DatabaseUser","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"DatabaseUser"}],"externalID":"s:5Auth012DatabaseUsera","roleHeading":"Type Alias","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"DatabaseUser","kind":"identifier"}]},"abstract":[{"type":"text","text":"A newly created database user (just the email, username, and email verified flag)."}],"schemaVersion":{"patch":0,"major":0,"minor":3},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/DatabaseUser":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DatabaseUser","fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"text":"DatabaseUser","kind":"identifier"}],"url":"\/documentation\/auth0\/databaseuser","kind":"symbol","title":"DatabaseUser","abstract":[{"type":"text","text":"A newly created database user (just the email, username, and email verified flag)."}],"role":"symbol","navigatorTitle":[{"text":"DatabaseUser","kind":"identifier"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/databaseuser"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"abstract":[{"type":"text","text":"A newly created database user (just the email, username, and email verified flag)."}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"DatabaseUser","kind":"identifier"},{"text":" = (email","kind":"text"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", username","kind":"text"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?, verified","kind":"text"},{"text":": ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"text":")","kind":"text"}]}],"kind":"declarations"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","sections":[],"metadata":{"externalID":"s:5Auth012DatabaseUsera","symbolKind":"typealias","title":"DatabaseUser","roleHeading":"Type Alias","role":"symbol","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"DatabaseUser","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"DatabaseUser"}],"modules":[{"name":"Auth0"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DatabaseUser","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/DatabaseUser":{"url":"\/documentation\/auth0\/databaseuser","abstract":[{"type":"text","text":"A newly created database user (just the email, username, and email verified flag)."}],"title":"DatabaseUser","navigatorTitle":[{"kind":"identifier","text":"DatabaseUser"}],"fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"DatabaseUser"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DatabaseUser","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/defaultscope.json b/docs/data/documentation/auth0/defaultscope.json index 6ff156ef0..a644044fe 100644 --- a/docs/data/documentation/auth0/defaultscope.json +++ b/docs/data/documentation/auth0/defaultscope.json @@ -1 +1 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/defaultScope","interfaceLanguage":"swift"},"schemaVersion":{"patch":0,"minor":3,"major":0},"variants":[{"paths":["\/documentation\/auth0\/defaultscope"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","abstract":[{"type":"text","text":"Default scope value used across Auth0.swift. Equals to "},{"type":"codeVoice","code":"openid profile email"},{"type":"text","text":"."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"defaultScope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}]}]}],"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"metadata":{"roleHeading":"Global Variable","role":"symbol","modules":[{"name":"Auth0"}],"symbolKind":"var","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"defaultScope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"title":"defaultScope","externalID":"s:5Auth012defaultScopeSSvp"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/defaultScope":{"title":"defaultScope","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/defaultScope","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"defaultScope","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"kind":"symbol","abstract":[{"type":"text","text":"Default scope value used across Auth0.swift. Equals to "},{"type":"codeVoice","code":"openid profile email"},{"type":"text","text":"."}],"url":"\/documentation\/auth0\/defaultscope","role":"symbol"}}} \ No newline at end of file +{"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"defaultScope","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"languages":["swift"],"platforms":["iOS"]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/defaultscope"]}],"sections":[],"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"},"abstract":[{"type":"text","text":"Default scope value used across Auth0.swift. Equals to "},{"type":"codeVoice","code":"openid profile email"},{"type":"text","text":"."}],"metadata":{"roleHeading":"Global Variable","symbolKind":"var","role":"symbol","title":"defaultScope","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"defaultScope","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"externalID":"s:5Auth012defaultScopeSSvp","modules":[{"name":"Auth0"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/defaultScope":{"title":"defaultScope","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/defaultScope","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"defaultScope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"abstract":[{"text":"Default scope value used across Auth0.swift. Equals to ","type":"text"},{"code":"openid profile email","type":"codeVoice"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/defaultscope"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/dpop.json b/docs/data/documentation/auth0/dpop.json index aad8e6e82..55d22f9c9 100644 --- a/docs/data/documentation/auth0/dpop.json +++ b/docs/data/documentation/auth0/dpop.json @@ -1 +1 @@ -{"abstract":[{"text":"Utilities for securing requests with DPoP (Demonstrating Proof of Possession) as described in","type":"text"},{"text":" ","type":"text"},{"type":"reference","isActive":true,"identifier":"https:\/\/datatracker.ietf.org\/doc\/html\/rfc9449"},{"text":".","type":"text"}],"kind":"symbol","schemaVersion":{"patch":0,"minor":3,"major":0},"sections":[],"seeAlsoSections":[{"anchor":"Related-Documentation","title":"Related Documentation","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"DPoP","kind":"identifier"}],"platforms":["iOS"]}]},{"content":[{"level":2,"text":"Availability","anchor":"Availability","type":"heading"},{"type":"paragraph","inlineContent":[{"text":"This feature is currently available in","type":"text"},{"text":" ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","isActive":true,"type":"reference"},{"text":".","type":"text"},{"text":" ","type":"text"},{"text":"Please reach out to Auth0 support to get it enabled for your tenant.","type":"text"}]}],"kind":"content"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP","interfaceLanguage":"swift"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/dpop"]}],"topicSections":[{"anchor":"Instance-Properties","generated":true,"title":"Instance Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP\/keychainIdentifier"]},{"anchor":"Type-Properties","generated":true,"title":"Type Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP\/defaultKeychainIdentifier"]},{"anchor":"Type-Methods","generated":true,"title":"Type Methods","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP\/addHeaders(to:accessToken:tokenType:nonce:keychainIdentifier:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP\/clearKeypair(for:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP\/isNonceRequired(by:)"]}],"relationshipsSections":[{"kind":"relationships","type":"conformsTo","title":"Conforms To","identifiers":["doc:\/\/com.auth0.Auth0\/s8SendableP","doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP"]}],"metadata":{"externalID":"s:5Auth04DPoPV","symbolKind":"struct","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"DPoP","kind":"identifier"}],"navigatorTitle":[{"text":"DPoP","kind":"identifier"}],"title":"DPoP","roleHeading":"Structure","modules":[{"name":"Auth0"}],"role":"symbol"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/DPoP/addHeaders(to:accessToken:tokenType:nonce:keychainIdentifier:)":{"role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"addHeaders","kind":"identifier"},{"text":"(","kind":"text"},{"text":"to","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"inout","kind":"keyword"},{"text":" ","kind":"text"},{"text":"URLRequest","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation10URLRequestV"},{"text":", ","kind":"text"},{"text":"accessToken","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"tokenType","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"nonce","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"text":"keychainIdentifier","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":"(","kind":"text"},{"text":"DPoPError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth09DPoPErrorV"},{"text":")","kind":"text"}],"type":"topic","url":"\/documentation\/auth0\/dpop\/addheaders(to:accesstoken:tokentype:nonce:keychainidentifier:)","abstract":[{"text":"Adds the ","type":"text"},{"code":"Authorization","type":"codeVoice"},{"text":" and ","type":"text"},{"code":"DPoP","type":"codeVoice"},{"text":" headers to the provided ","type":"text"},{"code":"URLRequest","type":"codeVoice"},{"text":". The ","type":"text"},{"code":"Authorization","type":"codeVoice"},{"text":" header is set","type":"text"},{"text":" ","type":"text"},{"text":"using the access token and token type. The ","type":"text"},{"code":"DPoP","type":"codeVoice"},{"text":" header contains the generated DPoP proof.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP\/addHeaders(to:accessToken:tokenType:nonce:keychainIdentifier:)","title":"addHeaders(to:accessToken:tokenType:nonce:keychainIdentifier:)","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/DPoP/keychainIdentifier":{"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"keychainIdentifier","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"title":"keychainIdentifier","abstract":[{"text":"The identifier used to store the key pair on the Keychain.","type":"text"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP\/keychainIdentifier","role":"symbol","type":"topic","url":"\/documentation\/auth0\/dpop\/keychainidentifier"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/DPoP/defaultKeychainIdentifier":{"url":"\/documentation\/auth0\/dpop\/defaultkeychainidentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP\/defaultKeychainIdentifier","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"defaultKeychainIdentifier","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"role":"symbol","kind":"symbol","abstract":[{"text":"The default identifier used to store the key pair on the Keychain, which is the bundle identifier.","type":"text"}],"title":"defaultKeychainIdentifier","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/DPoP":{"role":"symbol","type":"topic","title":"DPoP","kind":"symbol","url":"\/documentation\/auth0\/dpop","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"DPoP","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP","abstract":[{"text":"Utilities for securing requests with DPoP (Demonstrating Proof of Possession) as described in","type":"text"},{"text":" ","type":"text"},{"type":"reference","identifier":"https:\/\/datatracker.ietf.org\/doc\/html\/rfc9449","isActive":true},{"text":".","type":"text"}],"navigatorTitle":[{"text":"DPoP","kind":"identifier"}]},"doc://com.auth0.Auth0/s16SendableMetatypeP":{"type":"unresolvable","title":"Swift.SendableMetatype","identifier":"doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP"},"doc://com.auth0.Auth0/s8SendableP":{"type":"unresolvable","title":"Swift.Sendable","identifier":"doc:\/\/com.auth0.Auth0\/s8SendableP"},"https://datatracker.ietf.org/doc/html/rfc9449":{"type":"link","url":"https:\/\/datatracker.ietf.org\/doc\/html\/rfc9449","titleInlineContent":[{"text":"RFC 9449","type":"text"}],"title":"RFC 9449","identifier":"https:\/\/datatracker.ietf.org\/doc\/html\/rfc9449"},"https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access":{"type":"link","url":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","titleInlineContent":[{"text":"Early Access","type":"text"}],"title":"Early Access","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access"},"doc://com.auth0.Auth0/documentation/Auth0/DPoP/isNonceRequired(by:)":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP\/isNonceRequired(by:)","role":"symbol","url":"\/documentation\/auth0\/dpop\/isnoncerequired(by:)","abstract":[{"text":"Checks the ","type":"text"},{"code":"WWW-Authenticate","type":"codeVoice"},{"text":" header of a failed ","type":"text"},{"code":"HTTPURLResponse","type":"codeVoice"},{"text":" to determine if a nonce must be included in","type":"text"},{"text":" ","type":"text"},{"text":"the DPoP proof. If so, a new nonce value should be present in the ","type":"text"},{"code":"DPoP-Nonce","type":"codeVoice"},{"text":" header of the response. This","type":"text"},{"text":" ","type":"text"},{"text":"nonce should be extracted and used to generate a new DPoP proof. The failed request should then be retried with","type":"text"},{"text":" ","type":"text"},{"text":"the new DPoP proof.","type":"text"}],"fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isNonceRequired","kind":"identifier"},{"text":"(","kind":"text"},{"text":"by","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"HTTPURLResponse","kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSHTTPURLResponse"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"title":"isNonceRequired(by:)","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/DPoP/clearKeypair(for:)":{"type":"topic","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"clearKeypair","kind":"identifier"},{"text":"(","kind":"text"},{"text":"for","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":"(","kind":"text"},{"text":"DPoPError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth09DPoPErrorV"},{"text":")","kind":"text"}],"abstract":[{"text":"Clears the key pair stored in the Keychain.","type":"text"}],"title":"clearKeypair(for:)","role":"symbol","url":"\/documentation\/auth0\/dpop\/clearkeypair(for:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP\/clearKeypair(for:)"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError":{"kind":"symbol","abstract":[{"type":"text","text":"Represents an error during a DPoP operation."}],"navigatorTitle":[{"text":"DPoPError","kind":"identifier"}],"title":"DPoPError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"DPoPError","kind":"identifier"}],"url":"\/documentation\/auth0\/dpoperror","role":"symbol"}}} \ No newline at end of file +{"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP\/keychainIdentifier"],"generated":true,"title":"Instance Properties","anchor":"Instance-Properties"},{"anchor":"Type-Properties","title":"Type Properties","generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP\/defaultKeychainIdentifier"]},{"anchor":"Type-Methods","title":"Type Methods","generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP\/addHeaders(to:accessToken:tokenType:nonce:keychainIdentifier:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP\/clearKeypair(for:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP\/isNonceRequired(by:)"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"relationshipsSections":[{"title":"Conforms To","identifiers":["doc:\/\/com.auth0.Auth0\/s8SendableP","doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP"],"type":"conformsTo","kind":"relationships"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"DPoP"}]}]},{"kind":"content","content":[{"anchor":"Availability","type":"heading","level":2,"text":"Availability"},{"inlineContent":[{"text":"This feature is currently available in","type":"text"},{"text":" ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access"},{"text":".","type":"text"},{"text":" ","type":"text"},{"text":"Please reach out to Auth0 support to get it enabled for your tenant.","type":"text"}],"type":"paragraph"}]}],"sections":[],"abstract":[{"text":"Utilities for securing requests with DPoP (Demonstrating Proof of Possession) as described in","type":"text"},{"text":" ","type":"text"},{"isActive":true,"identifier":"https:\/\/datatracker.ietf.org\/doc\/html\/rfc9449","type":"reference"},{"text":".","type":"text"}],"kind":"symbol","seeAlsoSections":[{"title":"Related Documentation","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError"],"anchor":"Related-Documentation"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/dpop"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP"},"metadata":{"roleHeading":"Structure","navigatorTitle":[{"kind":"identifier","text":"DPoP"}],"symbolKind":"struct","role":"symbol","title":"DPoP","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"DPoP"}],"externalID":"s:5Auth04DPoPV","modules":[{"name":"Auth0"}]},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/DPoP/isNonceRequired(by:)":{"kind":"symbol","abstract":[{"type":"text","text":"Checks the "},{"type":"codeVoice","code":"WWW-Authenticate"},{"type":"text","text":" header of a failed "},{"code":"HTTPURLResponse","type":"codeVoice"},{"type":"text","text":" to determine if a nonce must be included in"},{"type":"text","text":" "},{"type":"text","text":"the DPoP proof. If so, a new nonce value should be present in the "},{"code":"DPoP-Nonce","type":"codeVoice"},{"type":"text","text":" header of the response. This"},{"type":"text","text":" "},{"type":"text","text":"nonce should be extracted and used to generate a new DPoP proof. The failed request should then be retried with"},{"type":"text","text":" "},{"type":"text","text":"the new DPoP proof."}],"type":"topic","title":"isNonceRequired(by:)","url":"\/documentation\/auth0\/dpop\/isnoncerequired(by:)","role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"isNonceRequired"},{"kind":"text","text":"("},{"kind":"externalParam","text":"by"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSHTTPURLResponse","text":"HTTPURLResponse"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP\/isNonceRequired(by:)"},"https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access":{"title":"Early Access","titleInlineContent":[{"text":"Early Access","type":"text"}],"type":"link","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","url":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError":{"role":"symbol","title":"DPoPError","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"DPoPError","kind":"identifier"}],"navigatorTitle":[{"text":"DPoPError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a DPoP operation."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError","url":"\/documentation\/auth0\/dpoperror","type":"topic"},"doc://com.auth0.Auth0/s8SendableP":{"identifier":"doc:\/\/com.auth0.Auth0\/s8SendableP","type":"unresolvable","title":"Swift.Sendable"},"doc://com.auth0.Auth0/documentation/Auth0/DPoP/clearKeypair(for:)":{"kind":"symbol","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"clearKeypair","kind":"identifier"},{"kind":"text","text":"("},{"text":"for","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":"(","kind":"text"},{"text":"DPoPError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth09DPoPErrorV"},{"kind":"text","text":")"}],"title":"clearKeypair(for:)","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Clears the key pair stored in the Keychain."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP\/clearKeypair(for:)","url":"\/documentation\/auth0\/dpop\/clearkeypair(for:)"},"doc://com.auth0.Auth0/documentation/Auth0/DPoP/addHeaders(to:accessToken:tokenType:nonce:keychainIdentifier:)":{"type":"topic","abstract":[{"type":"text","text":"Adds the "},{"type":"codeVoice","code":"Authorization"},{"text":" and ","type":"text"},{"code":"DPoP","type":"codeVoice"},{"text":" headers to the provided ","type":"text"},{"code":"URLRequest","type":"codeVoice"},{"type":"text","text":". The "},{"type":"codeVoice","code":"Authorization"},{"type":"text","text":" header is set"},{"text":" ","type":"text"},{"text":"using the access token and token type. The ","type":"text"},{"code":"DPoP","type":"codeVoice"},{"text":" header contains the generated DPoP proof.","type":"text"}],"title":"addHeaders(to:accessToken:tokenType:nonce:keychainIdentifier:)","url":"\/documentation\/auth0\/dpop\/addheaders(to:accesstoken:tokentype:nonce:keychainidentifier:)","kind":"symbol","role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"addHeaders","kind":"identifier"},{"text":"(","kind":"text"},{"text":"to","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"inout","kind":"keyword"},{"text":" ","kind":"text"},{"preciseIdentifier":"s:10Foundation10URLRequestV","text":"URLRequest","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"accessToken","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"tokenType","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"nonce","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"keychainIdentifier","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:5Auth09DPoPErrorV","text":"DPoPError","kind":"typeIdentifier"},{"text":")","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP\/addHeaders(to:accessToken:tokenType:nonce:keychainIdentifier:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"https://datatracker.ietf.org/doc/html/rfc9449":{"identifier":"https:\/\/datatracker.ietf.org\/doc\/html\/rfc9449","type":"link","title":"RFC 9449","titleInlineContent":[{"type":"text","text":"RFC 9449"}],"url":"https:\/\/datatracker.ietf.org\/doc\/html\/rfc9449"},"doc://com.auth0.Auth0/documentation/Auth0/DPoP":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP","type":"topic","title":"DPoP","role":"symbol","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"DPoP","kind":"identifier"}],"abstract":[{"type":"text","text":"Utilities for securing requests with DPoP (Demonstrating Proof of Possession) as described in"},{"type":"text","text":" "},{"isActive":true,"type":"reference","identifier":"https:\/\/datatracker.ietf.org\/doc\/html\/rfc9449"},{"type":"text","text":"."}],"url":"\/documentation\/auth0\/dpop","navigatorTitle":[{"text":"DPoP","kind":"identifier"}]},"doc://com.auth0.Auth0/s16SendableMetatypeP":{"title":"Swift.SendableMetatype","identifier":"doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/DPoP/keychainIdentifier":{"kind":"symbol","title":"keychainIdentifier","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"keychainIdentifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP\/keychainIdentifier","abstract":[{"type":"text","text":"The identifier used to store the key pair on the Keychain."}],"url":"\/documentation\/auth0\/dpop\/keychainidentifier"},"doc://com.auth0.Auth0/documentation/Auth0/DPoP/defaultKeychainIdentifier":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP\/defaultKeychainIdentifier","kind":"symbol","title":"defaultKeychainIdentifier","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"defaultKeychainIdentifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"role":"symbol","url":"\/documentation\/auth0\/dpop\/defaultkeychainidentifier","abstract":[{"type":"text","text":"The default identifier used to store the key pair on the Keychain, which is the bundle identifier."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/dpop/addheaders(to:accesstoken:tokentype:nonce:keychainidentifier:).json b/docs/data/documentation/auth0/dpop/addheaders(to:accesstoken:tokentype:nonce:keychainidentifier:).json index 8461fcd88..33c9c22aa 100644 --- a/docs/data/documentation/auth0/dpop/addheaders(to:accesstoken:tokentype:nonce:keychainidentifier:).json +++ b/docs/data/documentation/auth0/dpop/addheaders(to:accesstoken:tokentype:nonce:keychainidentifier:).json @@ -1 +1 @@ -{"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"symbolKind":"method","role":"symbol","externalID":"s:5Auth04DPoPV10addHeaders2to11accessToken9tokenType5nonce18keychainIdentifiery10Foundation10URLRequestVz_S3SSgSStAA0B6PErrorVYKFZ","roleHeading":"Type Method","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"addHeaders","kind":"identifier"},{"text":"(","kind":"text"},{"text":"to","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"inout","kind":"keyword"},{"text":" ","kind":"text"},{"text":"URLRequest","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation10URLRequestV"},{"text":", ","kind":"text"},{"text":"accessToken","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"tokenType","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"nonce","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"text":"keychainIdentifier","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":"(","kind":"text"},{"text":"DPoPError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth09DPoPErrorV"},{"text":")","kind":"text"}],"title":"addHeaders(to:accessToken:tokenType:nonce:keychainIdentifier:)","modules":[{"name":"Auth0"}]},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP\/addHeaders(to:accessToken:tokenType:nonce:keychainIdentifier:)"},"kind":"symbol","abstract":[{"text":"Adds the ","type":"text"},{"type":"codeVoice","code":"Authorization"},{"text":" and ","type":"text"},{"type":"codeVoice","code":"DPoP"},{"text":" headers to the provided ","type":"text"},{"type":"codeVoice","code":"URLRequest"},{"text":". The ","type":"text"},{"type":"codeVoice","code":"Authorization"},{"text":" header is set","type":"text"},{"text":" ","type":"text"},{"text":"using the access token and token type. The ","type":"text"},{"type":"codeVoice","code":"DPoP"},{"text":" header contains the generated DPoP proof.","type":"text"}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"addHeaders","kind":"identifier"},{"text":"(","kind":"text"},{"text":"to","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"request","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"inout","kind":"keyword"},{"text":" ","kind":"text"},{"preciseIdentifier":"s:10Foundation10URLRequestV","text":"URLRequest","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"accessToken","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"tokenType","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"nonce","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"? = nil, ","kind":"text"},{"text":"keychainIdentifier","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" = defaultKeychainIdentifier) ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:5Auth09DPoPErrorV","text":"DPoPError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError","kind":"typeIdentifier"},{"text":")","kind":"text"}]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"type":"text","text":"The "},{"type":"codeVoice","code":"URLRequest"},{"type":"text","text":" to which the headers will be added."}],"type":"paragraph"}],"name":"request"},{"content":[{"inlineContent":[{"text":"The access token to include in the ","type":"text"},{"type":"codeVoice","code":"Authorization"},{"text":" header. See ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/accessToken","type":"reference"},{"text":".","type":"text"}],"type":"paragraph"}],"name":"accessToken"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Either "},{"code":"DPoP","type":"codeVoice"},{"type":"text","text":" or "},{"code":"Bearer","type":"codeVoice"},{"type":"text","text":". See "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/tokenType","type":"reference","isActive":true},{"type":"text","text":"."}]}],"name":"tokenType"},{"content":[{"inlineContent":[{"text":"Optional nonce value to include in the DPoP proof.","type":"text"}],"type":"paragraph"}],"name":"nonce"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The identifier used to store the key pair on the Keychain. Defaults to the bundle identifier."}]}],"name":"keychainIdentifier"}]},{"content":[{"level":2,"text":"Availability","anchor":"Availability","type":"heading"},{"inlineContent":[{"type":"text","text":"This feature is currently available in"},{"type":"text","text":" "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access"},{"type":"text","text":"."},{"type":"text","text":" "},{"type":"text","text":"Please reach out to Auth0 support to get it enabled for your tenant."}],"type":"paragraph"},{"level":2,"text":"Usage","anchor":"Usage","type":"heading"},{"code":["var request = URLRequest(url: URL(string: \"https:\/\/example.com\/api\/endpoint\")!)","request.httpMethod = \"POST\"","","do {"," try DPoP.addHeaders(to: &request,"," accessToken: credentials.accessToken,"," tokenType: credentials.tokenType)","} catch {"," print(error)","}"],"syntax":"swift","type":"codeListing"},{"style":"important","name":"Important","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The HTTP method is needed for the generation of the DPoP proof, and must already be set on the "},{"code":"URLRequest","type":"codeVoice"},{"type":"text","text":"."}]}],"type":"aside"},{"style":"note","name":"Throws","content":[{"inlineContent":[{"text":"","type":"text"},{"type":"codeVoice","code":"DPoPError"},{"text":" if the DPoP proof generation fails.","type":"text"}],"type":"paragraph"}],"type":"aside"}],"kind":"content"}],"sections":[],"variants":[{"paths":["\/documentation\/auth0\/dpop\/addheaders(to:accesstoken:tokentype:nonce:keychainidentifier:)"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/DPoP":{"role":"symbol","type":"topic","title":"DPoP","kind":"symbol","url":"\/documentation\/auth0\/dpop","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"DPoP","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP","abstract":[{"text":"Utilities for securing requests with DPoP (Demonstrating Proof of Possession) as described in","type":"text"},{"text":" ","type":"text"},{"type":"reference","identifier":"https:\/\/datatracker.ietf.org\/doc\/html\/rfc9449","isActive":true},{"text":".","type":"text"}],"navigatorTitle":[{"text":"DPoP","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/tokenType":{"url":"\/documentation\/auth0\/credentials\/tokentype","abstract":[{"text":"Indicates how the access token should be used. For example, as a bearer token.","type":"text"}],"title":"tokenType","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/tokenType","kind":"symbol","type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"tokenType"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}]},"doc://com.auth0.Auth0/documentation/Auth0/DPoP/addHeaders(to:accessToken:tokenType:nonce:keychainIdentifier:)":{"role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"addHeaders","kind":"identifier"},{"text":"(","kind":"text"},{"text":"to","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"inout","kind":"keyword"},{"text":" ","kind":"text"},{"text":"URLRequest","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation10URLRequestV"},{"text":", ","kind":"text"},{"text":"accessToken","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"tokenType","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"nonce","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"text":"keychainIdentifier","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":"(","kind":"text"},{"text":"DPoPError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth09DPoPErrorV"},{"text":")","kind":"text"}],"type":"topic","url":"\/documentation\/auth0\/dpop\/addheaders(to:accesstoken:tokentype:nonce:keychainidentifier:)","abstract":[{"text":"Adds the ","type":"text"},{"code":"Authorization","type":"codeVoice"},{"text":" and ","type":"text"},{"code":"DPoP","type":"codeVoice"},{"text":" headers to the provided ","type":"text"},{"code":"URLRequest","type":"codeVoice"},{"text":". The ","type":"text"},{"code":"Authorization","type":"codeVoice"},{"text":" header is set","type":"text"},{"text":" ","type":"text"},{"text":"using the access token and token type. The ","type":"text"},{"code":"DPoP","type":"codeVoice"},{"text":" header contains the generated DPoP proof.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP\/addHeaders(to:accessToken:tokenType:nonce:keychainIdentifier:)","title":"addHeaders(to:accessToken:tokenType:nonce:keychainIdentifier:)","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError":{"kind":"symbol","abstract":[{"type":"text","text":"Represents an error during a DPoP operation."}],"navigatorTitle":[{"text":"DPoPError","kind":"identifier"}],"title":"DPoPError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"DPoPError","kind":"identifier"}],"url":"\/documentation\/auth0\/dpoperror","role":"symbol"},"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":[{"text":"audience","type":"text"}],"type":"strong"},{"type":"text","text":" value used on login)."}],"type":"topic","url":"\/documentation\/auth0\/credentials\/accesstoken","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/accessToken","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"accessToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"kind":"symbol","title":"accessToken"},"https://datatracker.ietf.org/doc/html/rfc9449":{"identifier":"https:\/\/datatracker.ietf.org\/doc\/html\/rfc9449","type":"link","url":"https:\/\/datatracker.ietf.org\/doc\/html\/rfc9449","title":"RFC 9449","titleInlineContent":[{"type":"text","text":"RFC 9449"}]},"https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access":{"identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","type":"link","url":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","title":"Early Access","titleInlineContent":[{"text":"Early Access","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/dpop\/addheaders(to:accesstoken:tokentype:nonce:keychainidentifier:)"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP"]]},"abstract":[{"type":"text","text":"Adds the "},{"type":"codeVoice","code":"Authorization"},{"type":"text","text":" and "},{"type":"codeVoice","code":"DPoP"},{"type":"text","text":" headers to the provided "},{"type":"codeVoice","code":"URLRequest"},{"type":"text","text":". The "},{"type":"codeVoice","code":"Authorization"},{"type":"text","text":" header is set"},{"type":"text","text":" "},{"type":"text","text":"using the access token and token type. The "},{"type":"codeVoice","code":"DPoP"},{"type":"text","text":" header contains the generated DPoP proof."}],"primaryContentSections":[{"declarations":[{"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"addHeaders","kind":"identifier"},{"text":"(","kind":"text"},{"text":"to","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"request","kind":"internalParam"},{"text":": ","kind":"text"},{"kind":"keyword","text":"inout"},{"kind":"text","text":" "},{"kind":"typeIdentifier","text":"URLRequest","preciseIdentifier":"s:10Foundation10URLRequestV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"accessToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"tokenType"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"nonce","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"? = nil, "},{"kind":"externalParam","text":"keychainIdentifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" = defaultKeychainIdentifier) ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":"(","kind":"text"},{"text":"DPoPError","preciseIdentifier":"s:5Auth09DPoPErrorV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError"},{"text":")","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"},{"parameters":[{"name":"request","content":[{"inlineContent":[{"text":"The ","type":"text"},{"code":"URLRequest","type":"codeVoice"},{"text":" to which the headers will be added.","type":"text"}],"type":"paragraph"}]},{"name":"accessToken","content":[{"inlineContent":[{"text":"The access token to include in the ","type":"text"},{"code":"Authorization","type":"codeVoice"},{"text":" header. See ","type":"text"},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/accessToken"},{"text":".","type":"text"}],"type":"paragraph"}]},{"name":"tokenType","content":[{"inlineContent":[{"text":"Either ","type":"text"},{"code":"DPoP","type":"codeVoice"},{"text":" or ","type":"text"},{"code":"Bearer","type":"codeVoice"},{"text":". See ","type":"text"},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/tokenType"},{"text":".","type":"text"}],"type":"paragraph"}]},{"name":"nonce","content":[{"inlineContent":[{"text":"Optional nonce value to include in the DPoP proof.","type":"text"}],"type":"paragraph"}]},{"name":"keychainIdentifier","content":[{"inlineContent":[{"text":"The identifier used to store the key pair on the Keychain. Defaults to the bundle identifier.","type":"text"}],"type":"paragraph"}]}],"kind":"parameters"},{"content":[{"type":"heading","text":"Availability","anchor":"Availability","level":2},{"type":"paragraph","inlineContent":[{"text":"This feature is currently available in","type":"text"},{"text":" ","type":"text"},{"isActive":true,"identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","type":"reference"},{"text":".","type":"text"},{"text":" ","type":"text"},{"text":"Please reach out to Auth0 support to get it enabled for your tenant.","type":"text"}]},{"type":"heading","text":"Usage","anchor":"Usage","level":2},{"type":"codeListing","code":["var request = URLRequest(url: URL(string: \"https:\/\/example.com\/api\/endpoint\")!)","request.httpMethod = \"POST\"","","do {"," try DPoP.addHeaders(to: &request,"," accessToken: credentials.accessToken,"," tokenType: credentials.tokenType)","} catch {"," print(error)","}"],"syntax":"swift"},{"type":"aside","name":"Important","style":"important","content":[{"inlineContent":[{"text":"The HTTP method is needed for the generation of the DPoP proof, and must already be set on the ","type":"text"},{"code":"URLRequest","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"}]},{"type":"aside","name":"Throws","style":"note","content":[{"inlineContent":[{"text":"","type":"text"},{"code":"DPoPError","type":"codeVoice"},{"text":" if the DPoP proof generation fails.","type":"text"}],"type":"paragraph"}]}],"kind":"content"}],"sections":[],"schemaVersion":{"patch":0,"major":0,"minor":3},"kind":"symbol","metadata":{"symbolKind":"method","modules":[{"name":"Auth0"}],"title":"addHeaders(to:accessToken:tokenType:nonce:keychainIdentifier:)","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"addHeaders"},{"text":"(","kind":"text"},{"text":"to","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"keyword","text":"inout"},{"kind":"text","text":" "},{"preciseIdentifier":"s:10Foundation10URLRequestV","kind":"typeIdentifier","text":"URLRequest"},{"kind":"text","text":", "},{"kind":"externalParam","text":"accessToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"tokenType"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"nonce"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"keychainIdentifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"DPoPError","preciseIdentifier":"s:5Auth09DPoPErrorV"},{"kind":"text","text":")"}],"externalID":"s:5Auth04DPoPV10addHeaders2to11accessToken9tokenType5nonce18keychainIdentifiery10Foundation10URLRequestVz_S3SSgSStAA0B6PErrorVYKFZ","role":"symbol","roleHeading":"Type Method"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP\/addHeaders(to:accessToken:tokenType:nonce:keychainIdentifier:)","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/DPoPError":{"role":"symbol","title":"DPoPError","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"DPoPError","kind":"identifier"}],"navigatorTitle":[{"text":"DPoPError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a DPoP operation."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError","url":"\/documentation\/auth0\/dpoperror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/DPoP/addHeaders(to:accessToken:tokenType:nonce:keychainIdentifier:)":{"type":"topic","abstract":[{"type":"text","text":"Adds the "},{"type":"codeVoice","code":"Authorization"},{"text":" and ","type":"text"},{"code":"DPoP","type":"codeVoice"},{"text":" headers to the provided ","type":"text"},{"code":"URLRequest","type":"codeVoice"},{"type":"text","text":". The "},{"type":"codeVoice","code":"Authorization"},{"type":"text","text":" header is set"},{"text":" ","type":"text"},{"text":"using the access token and token type. The ","type":"text"},{"code":"DPoP","type":"codeVoice"},{"text":" header contains the generated DPoP proof.","type":"text"}],"title":"addHeaders(to:accessToken:tokenType:nonce:keychainIdentifier:)","url":"\/documentation\/auth0\/dpop\/addheaders(to:accesstoken:tokentype:nonce:keychainidentifier:)","kind":"symbol","role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"addHeaders","kind":"identifier"},{"text":"(","kind":"text"},{"text":"to","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"inout","kind":"keyword"},{"text":" ","kind":"text"},{"preciseIdentifier":"s:10Foundation10URLRequestV","text":"URLRequest","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"accessToken","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"tokenType","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"nonce","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"keychainIdentifier","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:5Auth09DPoPErrorV","text":"DPoPError","kind":"typeIdentifier"},{"text":")","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP\/addHeaders(to:accessToken:tokenType:nonce:keychainIdentifier:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/accessToken":{"url":"\/documentation\/auth0\/credentials\/accesstoken","title":"accessToken","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"}]},{"type":"text","text":" value used on login)."}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"accessToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/accessToken","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials/tokenType":{"type":"topic","title":"tokenType","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials\/tokenType","url":"\/documentation\/auth0\/credentials\/tokentype","abstract":[{"text":"Indicates how the access token should be used. For example, as a bearer token.","type":"text"}],"kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"tokenType"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}]},"doc://com.auth0.Auth0/documentation/Auth0/DPoP":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP","type":"topic","title":"DPoP","role":"symbol","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"DPoP","kind":"identifier"}],"abstract":[{"type":"text","text":"Utilities for securing requests with DPoP (Demonstrating Proof of Possession) as described in"},{"type":"text","text":" "},{"isActive":true,"type":"reference","identifier":"https:\/\/datatracker.ietf.org\/doc\/html\/rfc9449"},{"type":"text","text":"."}],"url":"\/documentation\/auth0\/dpop","navigatorTitle":[{"text":"DPoP","kind":"identifier"}]},"https://datatracker.ietf.org/doc/html/rfc9449":{"identifier":"https:\/\/datatracker.ietf.org\/doc\/html\/rfc9449","type":"link","title":"RFC 9449","titleInlineContent":[{"text":"RFC 9449","type":"text"}],"url":"https:\/\/datatracker.ietf.org\/doc\/html\/rfc9449"},"https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access":{"identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","type":"link","title":"Early Access","titleInlineContent":[{"type":"text","text":"Early Access"}],"url":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/dpop/clearkeypair(for:).json b/docs/data/documentation/auth0/dpop/clearkeypair(for:).json index d643f21e8..747123df4 100644 --- a/docs/data/documentation/auth0/dpop/clearkeypair(for:).json +++ b/docs/data/documentation/auth0/dpop/clearkeypair(for:).json @@ -1 +1 @@ -{"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP\/clearKeypair(for:)","interfaceLanguage":"swift"},"schemaVersion":{"minor":3,"major":0,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"clearKeypair","kind":"identifier"},{"text":"(","kind":"text"},{"text":"for","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"keychainIdentifier","kind":"internalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" = defaultKeychainIdentifier) ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":"(","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError","preciseIdentifier":"s:5Auth09DPoPErrorV","text":"DPoPError","kind":"typeIdentifier"},{"text":")","kind":"text"}]}]},{"kind":"parameters","parameters":[{"name":"keychainIdentifier","content":[{"type":"paragraph","inlineContent":[{"text":"The identifier used to store the key pair on the Keychain. Defaults to the bundle identifier.","type":"text"}]}]}]},{"kind":"content","content":[{"type":"heading","anchor":"discussion","level":2,"text":"Discussion"},{"type":"paragraph","inlineContent":[{"text":"This method should be called as part of the logout process, along with ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/clear()","type":"reference","isActive":true},{"text":", and","type":"text"},{"text":" ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:callback:)","type":"reference","isActive":true},{"text":" –when using web-based authentication.","type":"text"}]},{"type":"heading","anchor":"Availability","level":2,"text":"Availability"},{"type":"paragraph","inlineContent":[{"text":"This feature is currently available in","type":"text"},{"text":" ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access"},{"text":".","type":"text"},{"text":" ","type":"text"},{"text":"Please reach out to Auth0 support to get it enabled for your tenant.","type":"text"}]},{"type":"heading","anchor":"Usage","level":2,"text":"Usage"},{"type":"codeListing","syntax":"swift","code":["do {"," try DPoP.clearKeypair()","} catch {"," print(error)","}"]},{"style":"note","type":"aside","name":"Throws","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":""},{"type":"codeVoice","code":"DPoPError"},{"type":"text","text":" if the key pair removal fails."}]}]}]}],"kind":"symbol","abstract":[{"type":"text","text":"Clears the key pair stored in the Keychain."}],"variants":[{"paths":["\/documentation\/auth0\/dpop\/clearkeypair(for:)"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP"]]},"metadata":{"fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"clearKeypair","kind":"identifier"},{"text":"(","kind":"text"},{"text":"for","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":"(","kind":"text"},{"text":"DPoPError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth09DPoPErrorV"},{"text":")","kind":"text"}],"externalID":"s:5Auth04DPoPV12clearKeypair3forySS_tAA0B6PErrorVYKFZ","roleHeading":"Type Method","title":"clearKeypair(for:)","modules":[{"name":"Auth0"}],"symbolKind":"method","role":"symbol"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/DPoP/clearKeypair(for:)":{"type":"topic","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"clearKeypair","kind":"identifier"},{"text":"(","kind":"text"},{"text":"for","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":"(","kind":"text"},{"text":"DPoPError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth09DPoPErrorV"},{"text":")","kind":"text"}],"abstract":[{"text":"Clears the key pair stored in the Keychain.","type":"text"}],"title":"clearKeypair(for:)","role":"symbol","url":"\/documentation\/auth0\/dpop\/clearkeypair(for:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP\/clearKeypair(for:)"},"https://datatracker.ietf.org/doc/html/rfc9449":{"url":"https:\/\/datatracker.ietf.org\/doc\/html\/rfc9449","title":"RFC 9449","titleInlineContent":[{"text":"RFC 9449","type":"text"}],"identifier":"https:\/\/datatracker.ietf.org\/doc\/html\/rfc9449","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/clear()":{"abstract":[{"text":"Clears credentials stored in the Keychain.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanager\/clear()","kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"clear"},{"kind":"text","text":"() -> "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/clear()","role":"symbol","title":"clear()","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/DPoP":{"role":"symbol","type":"topic","title":"DPoP","kind":"symbol","url":"\/documentation\/auth0\/dpop","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"DPoP","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP","abstract":[{"text":"Utilities for securing requests with DPoP (Demonstrating Proof of Possession) as described in","type":"text"},{"text":" ","type":"text"},{"type":"reference","identifier":"https:\/\/datatracker.ietf.org\/doc\/html\/rfc9449","isActive":true},{"text":".","type":"text"}],"navigatorTitle":[{"text":"DPoP","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError":{"kind":"symbol","abstract":[{"type":"text","text":"Represents an error during a DPoP operation."}],"navigatorTitle":[{"text":"DPoPError","kind":"identifier"}],"title":"DPoPError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"DPoPError","kind":"identifier"}],"url":"\/documentation\/auth0\/dpoperror","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:callback:)":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"clearSession","kind":"identifier"},{"text":"(","kind":"text"},{"text":"federated","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"callback","kind":"externalParam"},{"text":": (","kind":"text"},{"text":"WebAuthResult","preciseIdentifier":"s:5Auth013WebAuthResulta","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:s4Voida","kind":"typeIdentifier","text":"Void"},{"kind":"text","text":">) -> "},{"preciseIdentifier":"s:s4Voida","kind":"typeIdentifier","text":"Void"},{"kind":"text","text":")"}],"type":"topic","defaultImplementations":1,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:callback:)","required":true,"title":"clearSession(federated:callback:)","kind":"symbol","url":"\/documentation\/auth0\/webauth\/clearsession(federated:callback:)","abstract":[{"text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session.","type":"text"}],"role":"symbol"},"https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access":{"type":"link","titleInlineContent":[{"text":"Early Access","type":"text"}],"url":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","title":"Early Access"}}} \ No newline at end of file +{"abstract":[{"type":"text","text":"Clears the key pair stored in the Keychain."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"clearKeypair","kind":"identifier"},{"text":"(","kind":"text"},{"text":"for","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"keychainIdentifier","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" = defaultKeychainIdentifier) ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":"(","kind":"text"},{"text":"DPoPError","preciseIdentifier":"s:5Auth09DPoPErrorV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError"},{"text":")","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]},{"parameters":[{"name":"keychainIdentifier","content":[{"inlineContent":[{"text":"The identifier used to store the key pair on the Keychain. Defaults to the bundle identifier.","type":"text"}],"type":"paragraph"}]}],"kind":"parameters"},{"kind":"content","content":[{"type":"heading","text":"Discussion","anchor":"discussion","level":2},{"type":"paragraph","inlineContent":[{"text":"This method should be called as part of the logout process, along with ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/clear()","type":"reference"},{"text":", and","type":"text"},{"text":" ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:callback:)","type":"reference"},{"text":" –when using web-based authentication.","type":"text"}]},{"type":"heading","text":"Availability","anchor":"Availability","level":2},{"type":"paragraph","inlineContent":[{"text":"This feature is currently available in","type":"text"},{"text":" ","type":"text"},{"isActive":true,"identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","type":"reference"},{"text":".","type":"text"},{"text":" ","type":"text"},{"text":"Please reach out to Auth0 support to get it enabled for your tenant.","type":"text"}]},{"type":"heading","text":"Usage","anchor":"Usage","level":2},{"type":"codeListing","code":["do {"," try DPoP.clearKeypair()","} catch {"," print(error)","}"],"syntax":"swift"},{"type":"aside","name":"Throws","style":"note","content":[{"inlineContent":[{"text":"","type":"text"},{"code":"DPoPError","type":"codeVoice"},{"text":" if the key pair removal fails.","type":"text"}],"type":"paragraph"}]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/dpop\/clearkeypair(for:)"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP"]]},"metadata":{"modules":[{"name":"Auth0"}],"symbolKind":"method","roleHeading":"Type Method","title":"clearKeypair(for:)","role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"clearKeypair","kind":"identifier"},{"text":"(","kind":"text"},{"text":"for","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":"(","kind":"text"},{"text":"DPoPError","preciseIdentifier":"s:5Auth09DPoPErrorV","kind":"typeIdentifier"},{"text":")","kind":"text"}],"externalID":"s:5Auth04DPoPV12clearKeypair3forySS_tAA0B6PErrorVYKFZ"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP\/clearKeypair(for:)"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/DPoP/clearKeypair(for:)":{"kind":"symbol","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"clearKeypair","kind":"identifier"},{"kind":"text","text":"("},{"text":"for","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":"(","kind":"text"},{"text":"DPoPError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth09DPoPErrorV"},{"kind":"text","text":")"}],"title":"clearKeypair(for:)","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Clears the key pair stored in the Keychain."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP\/clearKeypair(for:)","url":"\/documentation\/auth0\/dpop\/clearkeypair(for:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access":{"title":"Early Access","url":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","type":"link","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","titleInlineContent":[{"type":"text","text":"Early Access"}]},"doc://com.auth0.Auth0/documentation/Auth0/DPoP":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP","type":"topic","title":"DPoP","role":"symbol","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"DPoP","kind":"identifier"}],"abstract":[{"type":"text","text":"Utilities for securing requests with DPoP (Demonstrating Proof of Possession) as described in"},{"type":"text","text":" "},{"isActive":true,"type":"reference","identifier":"https:\/\/datatracker.ietf.org\/doc\/html\/rfc9449"},{"type":"text","text":"."}],"url":"\/documentation\/auth0\/dpop","navigatorTitle":[{"text":"DPoP","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError":{"role":"symbol","title":"DPoPError","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"DPoPError","kind":"identifier"}],"navigatorTitle":[{"text":"DPoPError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a DPoP operation."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError","url":"\/documentation\/auth0\/dpoperror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/clear()":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/clear()","kind":"symbol","title":"clear()","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"clear","kind":"identifier"},{"text":"() -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"role":"symbol","url":"\/documentation\/auth0\/credentialsmanager\/clear()","abstract":[{"type":"text","text":"Clears credentials stored in the Keychain."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:callback:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:callback:)","kind":"symbol","title":"clearSession(federated:callback:)","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"clearSession"},{"kind":"text","text":"("},{"kind":"externalParam","text":"federated"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":", "},{"kind":"externalParam","text":"callback"},{"kind":"text","text":": ("},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth013WebAuthResulta","text":"WebAuthResult"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"kind":"text","text":">) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"kind":"text","text":")"}],"defaultImplementations":1,"role":"symbol","required":true,"url":"\/documentation\/auth0\/webauth\/clearsession(federated:callback:)","abstract":[{"type":"text","text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session."}],"type":"topic"},"https://datatracker.ietf.org/doc/html/rfc9449":{"title":"RFC 9449","type":"link","identifier":"https:\/\/datatracker.ietf.org\/doc\/html\/rfc9449","titleInlineContent":[{"type":"text","text":"RFC 9449"}],"url":"https:\/\/datatracker.ietf.org\/doc\/html\/rfc9449"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/dpop/defaultkeychainidentifier.json b/docs/data/documentation/auth0/dpop/defaultkeychainidentifier.json index 5a8a402fb..e756f2a80 100644 --- a/docs/data/documentation/auth0/dpop/defaultkeychainidentifier.json +++ b/docs/data/documentation/auth0/dpop/defaultkeychainidentifier.json @@ -1 +1 @@ -{"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP\/defaultKeychainIdentifier"},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"defaultKeychainIdentifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}]}],"kind":"declarations"}],"abstract":[{"type":"text","text":"The default identifier used to store the key pair on the Keychain, which is the bundle identifier."}],"schemaVersion":{"minor":3,"patch":0,"major":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP"]]},"metadata":{"symbolKind":"property","modules":[{"name":"Auth0"}],"roleHeading":"Type Property","externalID":"s:5Auth04DPoPV25defaultKeychainIdentifierSSvpZ","title":"defaultKeychainIdentifier","role":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"defaultKeychainIdentifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}]},"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/dpop\/defaultkeychainidentifier"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/DPoP":{"role":"symbol","type":"topic","title":"DPoP","kind":"symbol","url":"\/documentation\/auth0\/dpop","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"DPoP","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP","abstract":[{"text":"Utilities for securing requests with DPoP (Demonstrating Proof of Possession) as described in","type":"text"},{"text":" ","type":"text"},{"type":"reference","identifier":"https:\/\/datatracker.ietf.org\/doc\/html\/rfc9449","isActive":true},{"text":".","type":"text"}],"navigatorTitle":[{"text":"DPoP","kind":"identifier"}]},"https://datatracker.ietf.org/doc/html/rfc9449":{"type":"link","identifier":"https:\/\/datatracker.ietf.org\/doc\/html\/rfc9449","title":"RFC 9449","titleInlineContent":[{"type":"text","text":"RFC 9449"}],"url":"https:\/\/datatracker.ietf.org\/doc\/html\/rfc9449"},"doc://com.auth0.Auth0/documentation/Auth0/DPoP/defaultKeychainIdentifier":{"url":"\/documentation\/auth0\/dpop\/defaultkeychainidentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP\/defaultKeychainIdentifier","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"defaultKeychainIdentifier","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"role":"symbol","kind":"symbol","abstract":[{"text":"The default identifier used to store the key pair on the Keychain, which is the bundle identifier.","type":"text"}],"title":"defaultKeychainIdentifier","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP\/defaultKeychainIdentifier"},"metadata":{"modules":[{"name":"Auth0"}],"externalID":"s:5Auth04DPoPV25defaultKeychainIdentifierSSvpZ","title":"defaultKeychainIdentifier","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"defaultKeychainIdentifier","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"roleHeading":"Type Property","role":"symbol","symbolKind":"property"},"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/dpop\/defaultkeychainidentifier"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"defaultKeychainIdentifier","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"languages":["swift"],"platforms":["iOS"]}]}],"abstract":[{"type":"text","text":"The default identifier used to store the key pair on the Keychain, which is the bundle identifier."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/DPoP":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP","type":"topic","title":"DPoP","role":"symbol","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"DPoP","kind":"identifier"}],"abstract":[{"type":"text","text":"Utilities for securing requests with DPoP (Demonstrating Proof of Possession) as described in"},{"type":"text","text":" "},{"isActive":true,"type":"reference","identifier":"https:\/\/datatracker.ietf.org\/doc\/html\/rfc9449"},{"type":"text","text":"."}],"url":"\/documentation\/auth0\/dpop","navigatorTitle":[{"text":"DPoP","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/DPoP/defaultKeychainIdentifier":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP\/defaultKeychainIdentifier","kind":"symbol","title":"defaultKeychainIdentifier","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"defaultKeychainIdentifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"role":"symbol","url":"\/documentation\/auth0\/dpop\/defaultkeychainidentifier","abstract":[{"type":"text","text":"The default identifier used to store the key pair on the Keychain, which is the bundle identifier."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"https://datatracker.ietf.org/doc/html/rfc9449":{"title":"RFC 9449","type":"link","identifier":"https:\/\/datatracker.ietf.org\/doc\/html\/rfc9449","titleInlineContent":[{"type":"text","text":"RFC 9449"}],"url":"https:\/\/datatracker.ietf.org\/doc\/html\/rfc9449"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/dpop/isnoncerequired(by:).json b/docs/data/documentation/auth0/dpop/isnoncerequired(by:).json index 71d11292a..d611ff84b 100644 --- a/docs/data/documentation/auth0/dpop/isnoncerequired(by:).json +++ b/docs/data/documentation/auth0/dpop/isnoncerequired(by:).json @@ -1 +1 @@ -{"abstract":[{"type":"text","text":"Checks the "},{"code":"WWW-Authenticate","type":"codeVoice"},{"type":"text","text":" header of a failed "},{"code":"HTTPURLResponse","type":"codeVoice"},{"type":"text","text":" to determine if a nonce must be included in"},{"type":"text","text":" "},{"type":"text","text":"the DPoP proof. If so, a new nonce value should be present in the "},{"code":"DPoP-Nonce","type":"codeVoice"},{"type":"text","text":" header of the response. This"},{"type":"text","text":" "},{"type":"text","text":"nonce should be extracted and used to generate a new DPoP proof. The failed request should then be retried with"},{"type":"text","text":" "},{"type":"text","text":"the new DPoP proof."}],"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"modules":[{"name":"Auth0"}],"symbolKind":"method","role":"symbol","externalID":"s:5Auth04DPoPV15isNonceRequired2bySbSo17NSHTTPURLResponseC_tFZ","title":"isNonceRequired(by:)","roleHeading":"Type Method","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isNonceRequired","kind":"identifier"},{"text":"(","kind":"text"},{"text":"by","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:objc(cs)NSHTTPURLResponse","text":"HTTPURLResponse","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP\/isNonceRequired(by:)"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP"]]},"sections":[],"variants":[{"paths":["\/documentation\/auth0\/dpop\/isnoncerequired(by:)"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isNonceRequired","kind":"identifier"},{"text":"(","kind":"text"},{"text":"by","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"response","kind":"internalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:objc(cs)NSHTTPURLResponse","text":"HTTPURLResponse","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}]}]},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The HTTP response to check."}]}],"name":"response"}]},{"content":[{"text":"Return Value","anchor":"return-value","type":"heading","level":2},{"type":"paragraph","inlineContent":[{"type":"text","text":""},{"type":"codeVoice","code":"true"},{"type":"text","text":" if a DPoP nonce is required, "},{"type":"codeVoice","code":"false"},{"type":"text","text":" otherwise."}]}],"kind":"content"},{"content":[{"level":2,"text":"Availability","anchor":"Availability","type":"heading"},{"inlineContent":[{"text":"This feature is currently available in","type":"text"},{"text":" ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","type":"reference","isActive":true},{"text":".","type":"text"},{"text":" ","type":"text"},{"text":"Please reach out to Auth0 support to get it enabled for your tenant.","type":"text"}],"type":"paragraph"},{"level":2,"text":"Usage","anchor":"Usage","type":"heading"},{"syntax":"swift","code":["if DPoP.isNonceRequired(by: response),"," let nonce = response.value(forHTTPHeaderField: \"DPoP-Nonce\") {"," try DPoP.addHeaders(to: &request,"," accessToken: credentials.accessToken,"," tokenType: credentials.tokenType,"," nonce: nonce)",""," \/\/ Retry the request with the new DPoP proof that includes the nonce","}"],"type":"codeListing"}],"kind":"content"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/DPoP":{"role":"symbol","type":"topic","title":"DPoP","kind":"symbol","url":"\/documentation\/auth0\/dpop","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"DPoP","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP","abstract":[{"text":"Utilities for securing requests with DPoP (Demonstrating Proof of Possession) as described in","type":"text"},{"text":" ","type":"text"},{"type":"reference","identifier":"https:\/\/datatracker.ietf.org\/doc\/html\/rfc9449","isActive":true},{"text":".","type":"text"}],"navigatorTitle":[{"text":"DPoP","kind":"identifier"}]},"https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access":{"type":"link","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","titleInlineContent":[{"type":"text","text":"Early Access"}],"url":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","title":"Early Access"},"doc://com.auth0.Auth0/documentation/Auth0/DPoP/isNonceRequired(by:)":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP\/isNonceRequired(by:)","role":"symbol","url":"\/documentation\/auth0\/dpop\/isnoncerequired(by:)","abstract":[{"text":"Checks the ","type":"text"},{"code":"WWW-Authenticate","type":"codeVoice"},{"text":" header of a failed ","type":"text"},{"code":"HTTPURLResponse","type":"codeVoice"},{"text":" to determine if a nonce must be included in","type":"text"},{"text":" ","type":"text"},{"text":"the DPoP proof. If so, a new nonce value should be present in the ","type":"text"},{"code":"DPoP-Nonce","type":"codeVoice"},{"text":" header of the response. This","type":"text"},{"text":" ","type":"text"},{"text":"nonce should be extracted and used to generate a new DPoP proof. The failed request should then be retried with","type":"text"},{"text":" ","type":"text"},{"text":"the new DPoP proof.","type":"text"}],"fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isNonceRequired","kind":"identifier"},{"text":"(","kind":"text"},{"text":"by","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"HTTPURLResponse","kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSHTTPURLResponse"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"title":"isNonceRequired(by:)","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"https://datatracker.ietf.org/doc/html/rfc9449":{"url":"https:\/\/datatracker.ietf.org\/doc\/html\/rfc9449","type":"link","identifier":"https:\/\/datatracker.ietf.org\/doc\/html\/rfc9449","titleInlineContent":[{"type":"text","text":"RFC 9449"}],"title":"RFC 9449"}}} \ No newline at end of file +{"schemaVersion":{"patch":0,"major":0,"minor":3},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"isNonceRequired"},{"kind":"text","text":"("},{"kind":"externalParam","text":"by"},{"kind":"text","text":" "},{"text":"response","kind":"internalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:objc(cs)NSHTTPURLResponse","text":"HTTPURLResponse","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"},{"parameters":[{"name":"response","content":[{"inlineContent":[{"text":"The HTTP response to check.","type":"text"}],"type":"paragraph"}]}],"kind":"parameters"},{"content":[{"level":2,"text":"Return Value","anchor":"return-value","type":"heading"},{"inlineContent":[{"text":"","type":"text"},{"type":"codeVoice","code":"true"},{"text":" if a DPoP nonce is required, ","type":"text"},{"code":"false","type":"codeVoice"},{"text":" otherwise.","type":"text"}],"type":"paragraph"}],"kind":"content"},{"content":[{"text":"Availability","level":2,"type":"heading","anchor":"Availability"},{"inlineContent":[{"text":"This feature is currently available in","type":"text"},{"text":" ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","isActive":true,"type":"reference"},{"text":".","type":"text"},{"text":" ","type":"text"},{"text":"Please reach out to Auth0 support to get it enabled for your tenant.","type":"text"}],"type":"paragraph"},{"type":"heading","level":2,"anchor":"Usage","text":"Usage"},{"syntax":"swift","code":["if DPoP.isNonceRequired(by: response),"," let nonce = response.value(forHTTPHeaderField: \"DPoP-Nonce\") {"," try DPoP.addHeaders(to: &request,"," accessToken: credentials.accessToken,"," tokenType: credentials.tokenType,"," nonce: nonce)",""," \/\/ Retry the request with the new DPoP proof that includes the nonce","}"],"type":"codeListing"}],"kind":"content"}],"sections":[],"abstract":[{"text":"Checks the ","type":"text"},{"code":"WWW-Authenticate","type":"codeVoice"},{"text":" header of a failed ","type":"text"},{"code":"HTTPURLResponse","type":"codeVoice"},{"text":" to determine if a nonce must be included in","type":"text"},{"text":" ","type":"text"},{"text":"the DPoP proof. If so, a new nonce value should be present in the ","type":"text"},{"code":"DPoP-Nonce","type":"codeVoice"},{"text":" header of the response. This","type":"text"},{"text":" ","type":"text"},{"text":"nonce should be extracted and used to generate a new DPoP proof. The failed request should then be retried with","type":"text"},{"text":" ","type":"text"},{"text":"the new DPoP proof.","type":"text"}],"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/dpop\/isnoncerequired(by:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP\/isNonceRequired(by:)","interfaceLanguage":"swift"},"metadata":{"roleHeading":"Type Method","modules":[{"name":"Auth0"}],"title":"isNonceRequired(by:)","symbolKind":"method","externalID":"s:5Auth04DPoPV15isNonceRequired2bySbSo17NSHTTPURLResponseC_tFZ","role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"isNonceRequired"},{"text":"(","kind":"text"},{"text":"by","kind":"externalParam"},{"kind":"text","text":": "},{"text":"HTTPURLResponse","preciseIdentifier":"c:objc(cs)NSHTTPURLResponse","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}]},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP"]]},"references":{"https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access":{"title":"Early Access","type":"link","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","titleInlineContent":[{"type":"text","text":"Early Access"}],"url":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access"},"doc://com.auth0.Auth0/documentation/Auth0/DPoP":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP","type":"topic","title":"DPoP","role":"symbol","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"DPoP","kind":"identifier"}],"abstract":[{"type":"text","text":"Utilities for securing requests with DPoP (Demonstrating Proof of Possession) as described in"},{"type":"text","text":" "},{"isActive":true,"type":"reference","identifier":"https:\/\/datatracker.ietf.org\/doc\/html\/rfc9449"},{"type":"text","text":"."}],"url":"\/documentation\/auth0\/dpop","navigatorTitle":[{"text":"DPoP","kind":"identifier"}]},"https://datatracker.ietf.org/doc/html/rfc9449":{"title":"RFC 9449","type":"link","titleInlineContent":[{"type":"text","text":"RFC 9449"}],"identifier":"https:\/\/datatracker.ietf.org\/doc\/html\/rfc9449","url":"https:\/\/datatracker.ietf.org\/doc\/html\/rfc9449"},"doc://com.auth0.Auth0/documentation/Auth0/DPoP/isNonceRequired(by:)":{"kind":"symbol","abstract":[{"type":"text","text":"Checks the "},{"type":"codeVoice","code":"WWW-Authenticate"},{"type":"text","text":" header of a failed "},{"code":"HTTPURLResponse","type":"codeVoice"},{"type":"text","text":" to determine if a nonce must be included in"},{"type":"text","text":" "},{"type":"text","text":"the DPoP proof. If so, a new nonce value should be present in the "},{"code":"DPoP-Nonce","type":"codeVoice"},{"type":"text","text":" header of the response. This"},{"type":"text","text":" "},{"type":"text","text":"nonce should be extracted and used to generate a new DPoP proof. The failed request should then be retried with"},{"type":"text","text":" "},{"type":"text","text":"the new DPoP proof."}],"type":"topic","title":"isNonceRequired(by:)","url":"\/documentation\/auth0\/dpop\/isnoncerequired(by:)","role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"isNonceRequired"},{"kind":"text","text":"("},{"kind":"externalParam","text":"by"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSHTTPURLResponse","text":"HTTPURLResponse"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP\/isNonceRequired(by:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/dpop/keychainidentifier.json b/docs/data/documentation/auth0/dpop/keychainidentifier.json index 28f996ec9..2f4be21b7 100644 --- a/docs/data/documentation/auth0/dpop/keychainidentifier.json +++ b/docs/data/documentation/auth0/dpop/keychainidentifier.json @@ -1 +1 @@ -{"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP"]]},"metadata":{"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"keychainIdentifier","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"symbolKind":"property","externalID":"s:5Auth04DPoPV18keychainIdentifierSSvp","roleHeading":"Instance Property","title":"keychainIdentifier","modules":[{"name":"Auth0"}],"role":"symbol"},"kind":"symbol","schemaVersion":{"minor":3,"patch":0,"major":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP\/keychainIdentifier","interfaceLanguage":"swift"},"variants":[{"paths":["\/documentation\/auth0\/dpop\/keychainidentifier"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"type":"text","text":"The identifier used to store the key pair on the Keychain."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"keychainIdentifier","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"languages":["swift"],"platforms":["iOS"]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/DPoP/keychainIdentifier":{"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"keychainIdentifier","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"title":"keychainIdentifier","abstract":[{"text":"The identifier used to store the key pair on the Keychain.","type":"text"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP\/keychainIdentifier","role":"symbol","type":"topic","url":"\/documentation\/auth0\/dpop\/keychainidentifier"},"doc://com.auth0.Auth0/documentation/Auth0/DPoP":{"role":"symbol","type":"topic","title":"DPoP","kind":"symbol","url":"\/documentation\/auth0\/dpop","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"DPoP","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP","abstract":[{"text":"Utilities for securing requests with DPoP (Demonstrating Proof of Possession) as described in","type":"text"},{"text":" ","type":"text"},{"type":"reference","identifier":"https:\/\/datatracker.ietf.org\/doc\/html\/rfc9449","isActive":true},{"text":".","type":"text"}],"navigatorTitle":[{"text":"DPoP","kind":"identifier"}]},"https://datatracker.ietf.org/doc/html/rfc9449":{"type":"link","identifier":"https:\/\/datatracker.ietf.org\/doc\/html\/rfc9449","titleInlineContent":[{"text":"RFC 9449","type":"text"}],"url":"https:\/\/datatracker.ietf.org\/doc\/html\/rfc9449","title":"RFC 9449"}}} \ No newline at end of file +{"schemaVersion":{"patch":0,"major":0,"minor":3},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"keychainIdentifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}]}]}],"sections":[],"abstract":[{"type":"text","text":"The identifier used to store the key pair on the Keychain."}],"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/dpop\/keychainidentifier"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"role":"symbol","modules":[{"name":"Auth0"}],"title":"keychainIdentifier","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"keychainIdentifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"externalID":"s:5Auth04DPoPV18keychainIdentifierSSvp","roleHeading":"Instance Property","symbolKind":"property"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP\/keychainIdentifier","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/DPoP":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP","type":"topic","title":"DPoP","role":"symbol","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"DPoP","kind":"identifier"}],"abstract":[{"type":"text","text":"Utilities for securing requests with DPoP (Demonstrating Proof of Possession) as described in"},{"type":"text","text":" "},{"isActive":true,"type":"reference","identifier":"https:\/\/datatracker.ietf.org\/doc\/html\/rfc9449"},{"type":"text","text":"."}],"url":"\/documentation\/auth0\/dpop","navigatorTitle":[{"text":"DPoP","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/DPoP/keychainIdentifier":{"kind":"symbol","title":"keychainIdentifier","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"keychainIdentifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP\/keychainIdentifier","abstract":[{"type":"text","text":"The identifier used to store the key pair on the Keychain."}],"url":"\/documentation\/auth0\/dpop\/keychainidentifier"},"https://datatracker.ietf.org/doc/html/rfc9449":{"titleInlineContent":[{"type":"text","text":"RFC 9449"}],"url":"https:\/\/datatracker.ietf.org\/doc\/html\/rfc9449","type":"link","title":"RFC 9449","identifier":"https:\/\/datatracker.ietf.org\/doc\/html\/rfc9449"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/dpoperror.json b/docs/data/documentation/auth0/dpoperror.json index d8cd60ffb..965c2d70a 100644 --- a/docs/data/documentation/auth0/dpoperror.json +++ b/docs/data/documentation/auth0/dpoperror.json @@ -1 +1 @@ -{"schemaVersion":{"patch":0,"major":0,"minor":3},"metadata":{"externalID":"s:5Auth09DPoPErrorV","navigatorTitle":[{"text":"DPoPError","kind":"identifier"}],"symbolKind":"struct","modules":[{"name":"Auth0"}],"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"DPoPError","kind":"identifier"}],"title":"DPoPError","roleHeading":"Structure"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError","interfaceLanguage":"swift"},"sections":[],"abstract":[{"text":"Represents an error during a DPoP operation.","type":"text"}],"topicSections":[{"anchor":"Operators","generated":true,"title":"Operators","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/~=(_:_:)-2g6ss","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/~=(_:_:)-8r7xi"]},{"anchor":"Instance-Properties","generated":true,"title":"Instance Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/cause","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/debugDescription"]},{"anchor":"Type-Properties","generated":true,"title":"Type Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/cryptoKitOperationFailed","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/keychainOperationFailed","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/other","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/secKeyOperationFailed","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/secureEnclaveOperationFailed","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/unknown"]},{"anchor":"Default-Implementations","generated":true,"title":"Default Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/Auth0Error-Implementations","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/Equatable-Implementations","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/LocalizedError-Implementations"]}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"DPoPError"}],"platforms":["iOS"]}],"kind":"declarations"},{"content":[{"text":"Overview","level":2,"type":"heading","anchor":"overview"},{"inlineContent":[{"type":"text","text":"This error type encapsulates various issues that can occur while performing DPoP-related operations, such as key"},{"type":"text","text":" "},{"type":"text","text":"generation or cryptographic failures."}],"type":"paragraph"}],"kind":"content"}],"relationshipsSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","doc:\/\/com.auth0.Auth0\/10Foundation14LocalizedErrorP","doc:\/\/com.auth0.Auth0\/s8CopyableP","doc:\/\/com.auth0.Auth0\/s28CustomDebugStringConvertibleP","doc:\/\/com.auth0.Auth0\/SQ","doc:\/\/com.auth0.Auth0\/s5ErrorP","doc:\/\/com.auth0.Auth0\/s8SendableP","doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP"],"type":"conformsTo","kind":"relationships","title":"Conforms To"}],"variants":[{"paths":["\/documentation\/auth0\/dpoperror"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/DPoPError/other":{"role":"symbol","url":"\/documentation\/auth0\/dpoperror\/other","kind":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"other"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"DPoPError","preciseIdentifier":"s:5Auth09DPoPErrorV"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/other","title":"other","type":"topic","abstract":[{"type":"text","text":"An unexpected error occurred, and an "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value is available."},{"type":"text","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","isActive":true,"type":"reference"},{"text":" property.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError/secureEnclaveOperationFailed":{"kind":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"secureEnclaveOperationFailed"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"DPoPError","preciseIdentifier":"s:5Auth09DPoPErrorV"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/secureEnclaveOperationFailed","url":"\/documentation\/auth0\/dpoperror\/secureenclaveoperationfailed","title":"secureEnclaveOperationFailed","abstract":[{"text":"A Secure Enclave operation failed.","type":"text"},{"text":" ","type":"text"},{"text":"The underlying ","type":"text"},{"code":"Error","type":"codeVoice"},{"text":" value 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"}],"type":"topic","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error":{"url":"\/documentation\/auth0\/auth0error","title":"Auth0Error","kind":"symbol","type":"topic","abstract":[{"type":"text","text":"Generic representation of Auth0 errors."}],"role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Auth0Error"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","navigatorTitle":[{"kind":"identifier","text":"Auth0Error"}]},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError/keychainOperationFailed":{"fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"keychainOperationFailed","kind":"identifier"},{"text":": ","kind":"text"},{"text":"DPoPError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth09DPoPErrorV"}],"type":"topic","abstract":[{"type":"text","text":"A Keychain operation failed."},{"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"}],"role":"symbol","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/keychainOperationFailed","title":"keychainOperationFailed","url":"\/documentation\/auth0\/dpoperror\/keychainoperationfailed"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError/cryptoKitOperationFailed":{"kind":"symbol","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/cryptoKitOperationFailed","abstract":[{"type":"text","text":"A CryptoKit operation failed."},{"type":"text","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."}],"fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"cryptoKitOperationFailed"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth09DPoPErrorV","kind":"typeIdentifier","text":"DPoPError"}],"type":"topic","url":"\/documentation\/auth0\/dpoperror\/cryptokitoperationfailed","title":"cryptoKitOperationFailed"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError/Auth0Error-Implementations":{"abstract":[],"role":"collectionGroup","title":"Auth0Error Implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/Auth0Error-Implementations","url":"\/documentation\/auth0\/dpoperror\/auth0error-implementations","kind":"article","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"title":"cause","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","kind":"symbol","abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":"?"}],"role":"symbol","type":"topic"},"doc://com.auth0.Auth0/10Foundation14LocalizedErrorP":{"identifier":"doc:\/\/com.auth0.Auth0\/10Foundation14LocalizedErrorP","type":"unresolvable","title":"Foundation.LocalizedError"},"doc://com.auth0.Auth0/s8SendableP":{"identifier":"doc:\/\/com.auth0.Auth0\/s8SendableP","title":"Swift.Sendable","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError/Equatable-Implementations":{"abstract":[],"role":"collectionGroup","title":"Equatable Implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/Equatable-Implementations","url":"\/documentation\/auth0\/dpoperror\/equatable-implementations","kind":"article","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError/~=(_:_:)-8r7xi":{"abstract":[{"type":"text","text":"Matches "},{"type":"codeVoice","code":"DPoPError"},{"type":"text","text":" values in a switch statement."}],"url":"\/documentation\/auth0\/dpoperror\/~=(_:_:)-8r7xi","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:5Auth09DPoPErrorV","text":"DPoPError"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth09DPoPErrorV","text":"DPoPError"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"title":"~=(_:_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/~=(_:_:)-8r7xi","kind":"symbol","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError/LocalizedError-Implementations":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/LocalizedError-Implementations","abstract":[],"role":"collectionGroup","type":"topic","title":"LocalizedError Implementations","url":"\/documentation\/auth0\/dpoperror\/localizederror-implementations","kind":"article"},"doc://com.auth0.Auth0/s28CustomDebugStringConvertibleP":{"identifier":"doc:\/\/com.auth0.Auth0\/s28CustomDebugStringConvertibleP","title":"Swift.CustomDebugStringConvertible","type":"unresolvable"},"doc://com.auth0.Auth0/s8CopyableP":{"title":"Swift.Copyable","identifier":"doc:\/\/com.auth0.Auth0\/s8CopyableP","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError/debugDescription":{"abstract":[{"type":"text","text":"Description of the error."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/debugDescription","title":"debugDescription","url":"\/documentation\/auth0\/dpoperror\/debugdescription","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"debugDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError/secKeyOperationFailed":{"role":"symbol","abstract":[{"type":"text","text":"A SecKey operation failed."},{"type":"text","text":" "},{"type":"text","text":"When available, the underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value can be accessed via the "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true,"type":"reference"},{"type":"text","text":" property."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/secKeyOperationFailed","type":"topic","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"secKeyOperationFailed","kind":"identifier"},{"text":": ","kind":"text"},{"text":"DPoPError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth09DPoPErrorV"}],"kind":"symbol","url":"\/documentation\/auth0\/dpoperror\/seckeyoperationfailed","title":"secKeyOperationFailed"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError/cause":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/cause","title":"cause","url":"\/documentation\/auth0\/dpoperror\/cause","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP","text":"Error"},{"kind":"text","text":"?"}],"role":"symbol","kind":"symbol","type":"topic","abstract":[{"text":"The underlying ","type":"text"},{"type":"codeVoice","code":"Error"},{"text":" value, if any. Defaults to ","type":"text"},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}]},"doc://com.auth0.Auth0/SQ":{"identifier":"doc:\/\/com.auth0.Auth0\/SQ","type":"unresolvable","title":"Swift.Equatable"},"doc://com.auth0.Auth0/s5ErrorP":{"identifier":"doc:\/\/com.auth0.Auth0\/s5ErrorP","type":"unresolvable","title":"Swift.Error"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError/~=(_:_:)-2g6ss":{"url":"\/documentation\/auth0\/dpoperror\/~=(_:_:)-2g6ss","kind":"symbol","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","text":"DPoPError","preciseIdentifier":"s:5Auth09DPoPErrorV"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"abstract":[{"type":"text","text":"Matches "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" values in a switch statement."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/~=(_:_:)-2g6ss","type":"topic","title":"~=(_:_:)","role":"symbol"},"doc://com.auth0.Auth0/s16SendableMetatypeP":{"identifier":"doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP","type":"unresolvable","title":"Swift.SendableMetatype"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError/unknown":{"abstract":[{"type":"text","text":"An unexpected error occurred, but an "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value is not available."},{"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":"."}],"fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"unknown"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"DPoPError","preciseIdentifier":"s:5Auth09DPoPErrorV"}],"kind":"symbol","url":"\/documentation\/auth0\/dpoperror\/unknown","title":"unknown","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/unknown","type":"topic","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError":{"kind":"symbol","abstract":[{"type":"text","text":"Represents an error during a DPoP operation."}],"navigatorTitle":[{"text":"DPoPError","kind":"identifier"}],"title":"DPoPError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"DPoPError","kind":"identifier"}],"url":"\/documentation\/auth0\/dpoperror","role":"symbol"}}} \ No newline at end of file +{"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError"},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"DPoPError"}]}]},{"kind":"content","content":[{"anchor":"overview","type":"heading","level":2,"text":"Overview"},{"inlineContent":[{"type":"text","text":"This error type encapsulates various issues that can occur while performing DPoP-related operations, such as key"},{"type":"text","text":" "},{"text":"generation or cryptographic failures.","type":"text"}],"type":"paragraph"}]}],"relationshipsSections":[{"type":"conformsTo","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","doc:\/\/com.auth0.Auth0\/10Foundation14LocalizedErrorP","doc:\/\/com.auth0.Auth0\/s8CopyableP","doc:\/\/com.auth0.Auth0\/s28CustomDebugStringConvertibleP","doc:\/\/com.auth0.Auth0\/SQ","doc:\/\/com.auth0.Auth0\/s5ErrorP","doc:\/\/com.auth0.Auth0\/s8SendableP","doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP"],"kind":"relationships","title":"Conforms To"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/dpoperror"]}],"kind":"symbol","metadata":{"roleHeading":"Structure","navigatorTitle":[{"text":"DPoPError","kind":"identifier"}],"modules":[{"name":"Auth0"}],"role":"symbol","symbolKind":"struct","title":"DPoPError","externalID":"s:5Auth09DPoPErrorV","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"DPoPError","kind":"identifier"}]},"schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"type":"text","text":"Represents an error during a DPoP operation."}],"topicSections":[{"generated":true,"title":"Operators","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/~=(_:_:)-2g6ss","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/~=(_:_:)-8r7xi"],"anchor":"Operators"},{"generated":true,"title":"Instance Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/cause","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/debugDescription"],"anchor":"Instance-Properties"},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/cryptoKitOperationFailed","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/keychainOperationFailed","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/other","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/secKeyOperationFailed","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/secureEnclaveOperationFailed","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/unknown"],"generated":true,"title":"Type Properties","anchor":"Type-Properties"},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/Auth0Error-Implementations","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/Equatable-Implementations","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/LocalizedError-Implementations"],"generated":true,"title":"Default Implementations","anchor":"Default-Implementations"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/DPoPError/unknown":{"role":"symbol","title":"unknown","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"unknown"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth09DPoPErrorV","text":"DPoPError","kind":"typeIdentifier"}],"abstract":[{"type":"text","text":"An unexpected error occurred, but an "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value is not available."},{"type":"text","text":" "},{"type":"text","text":"This error does not include a "},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},{"type":"text","text":"."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/unknown","url":"\/documentation\/auth0\/dpoperror\/unknown","type":"topic"},"doc://com.auth0.Auth0/s5ErrorP":{"type":"unresolvable","title":"Swift.Error","identifier":"doc:\/\/com.auth0.Auth0\/s5ErrorP"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError/Auth0Error-Implementations":{"role":"collectionGroup","title":"Auth0Error Implementations","abstract":[],"kind":"article","url":"\/documentation\/auth0\/dpoperror\/auth0error-implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/Auth0Error-Implementations","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError/keychainOperationFailed":{"kind":"symbol","abstract":[{"text":"A Keychain operation failed.","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"},{"text":".","type":"text"}],"type":"topic","url":"\/documentation\/auth0\/dpoperror\/keychainoperationfailed","title":"keychainOperationFailed","role":"symbol","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"keychainOperationFailed","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth09DPoPErrorV","text":"DPoPError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/keychainOperationFailed"},"doc://com.auth0.Auth0/SQ":{"type":"unresolvable","title":"Swift.Equatable","identifier":"doc:\/\/com.auth0.Auth0\/SQ"},"doc://com.auth0.Auth0/s8SendableP":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s8SendableP","title":"Swift.Sendable"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError/~=(_:_:)-2g6ss":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/~=(_:_:)-2g6ss","type":"topic","title":"~=(_:_:)","role":"symbol","kind":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"~=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"DPoPError","preciseIdentifier":"s:5Auth09DPoPErrorV","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP","text":"Error"},{"text":") -> ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"abstract":[{"type":"text","text":"Matches "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" values in a switch statement."}],"url":"\/documentation\/auth0\/dpoperror\/~=(_:_:)-2g6ss"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError/cryptoKitOperationFailed":{"url":"\/documentation\/auth0\/dpoperror\/cryptokitoperationfailed","abstract":[{"type":"text","text":"A CryptoKit operation failed."},{"type":"text","text":" "},{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value can be accessed via the "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference","isActive":true},{"type":"text","text":" property."}],"title":"cryptoKitOperationFailed","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cryptoKitOperationFailed","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth09DPoPErrorV","text":"DPoPError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/cryptoKitOperationFailed","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/s16SendableMetatypeP":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP","title":"Swift.SendableMetatype"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError/cause":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/cause","type":"topic","title":"cause","role":"symbol","kind":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP","text":"Error"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"text":" value, if any. Defaults to ","type":"text"},{"code":"nil","type":"codeVoice"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/dpoperror\/cause"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError/other":{"role":"symbol","title":"other","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"other"},{"kind":"text","text":": "},{"text":"DPoPError","preciseIdentifier":"s:5Auth09DPoPErrorV","kind":"typeIdentifier"}],"abstract":[{"type":"text","text":"An unexpected error occurred, and an "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value is available."},{"type":"text","text":" "},{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value can be accessed via the "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true},{"type":"text","text":" property."}],"kind":"symbol","url":"\/documentation\/auth0\/dpoperror\/other","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/other","type":"topic"},"doc://com.auth0.Auth0/s8CopyableP":{"identifier":"doc:\/\/com.auth0.Auth0\/s8CopyableP","type":"unresolvable","title":"Swift.Copyable"},"doc://com.auth0.Auth0/s28CustomDebugStringConvertibleP":{"identifier":"doc:\/\/com.auth0.Auth0\/s28CustomDebugStringConvertibleP","type":"unresolvable","title":"Swift.CustomDebugStringConvertible"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError/secKeyOperationFailed":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/secKeyOperationFailed","type":"topic","title":"secKeyOperationFailed","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"secKeyOperationFailed"},{"text":": ","kind":"text"},{"text":"DPoPError","preciseIdentifier":"s:5Auth09DPoPErrorV","kind":"typeIdentifier"}],"abstract":[{"type":"text","text":"A SecKey operation failed."},{"type":"text","text":" "},{"type":"text","text":"When available, the underlying "},{"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."}],"url":"\/documentation\/auth0\/dpoperror\/seckeyoperationfailed"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError/Equatable-Implementations":{"role":"collectionGroup","title":"Equatable Implementations","abstract":[],"kind":"article","url":"\/documentation\/auth0\/dpoperror\/equatable-implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/Equatable-Implementations","type":"topic"},"doc://com.auth0.Auth0/10Foundation14LocalizedErrorP":{"type":"unresolvable","title":"Foundation.LocalizedError","identifier":"doc:\/\/com.auth0.Auth0\/10Foundation14LocalizedErrorP"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError/debugDescription":{"url":"\/documentation\/auth0\/dpoperror\/debugdescription","abstract":[{"type":"text","text":"Description of the error."}],"title":"debugDescription","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"debugDescription"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/debugDescription","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error":{"url":"\/documentation\/auth0\/auth0error","title":"Auth0Error","abstract":[{"type":"text","text":"Generic representation of Auth0 errors."}],"navigatorTitle":[{"kind":"identifier","text":"Auth0Error"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Auth0Error"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"kind":"symbol","title":"cause","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier","text":"Error"},{"kind":"text","text":"?"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","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":"."}],"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError":{"role":"symbol","title":"DPoPError","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"DPoPError","kind":"identifier"}],"navigatorTitle":[{"text":"DPoPError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a DPoP operation."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError","url":"\/documentation\/auth0\/dpoperror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError/~=(_:_:)-8r7xi":{"url":"\/documentation\/auth0\/dpoperror\/~=(_:_:)-8r7xi","abstract":[{"text":"Matches ","type":"text"},{"code":"DPoPError","type":"codeVoice"},{"text":" values in a switch statement.","type":"text"}],"title":"~=(_:_:)","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","preciseIdentifier":"s:5Auth09DPoPErrorV","text":"DPoPError"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth09DPoPErrorV","text":"DPoPError"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/~=(_:_:)-8r7xi","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError/LocalizedError-Implementations":{"role":"collectionGroup","title":"LocalizedError Implementations","abstract":[],"kind":"article","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/LocalizedError-Implementations","url":"\/documentation\/auth0\/dpoperror\/localizederror-implementations","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError/secureEnclaveOperationFailed":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/secureEnclaveOperationFailed","type":"topic","title":"secureEnclaveOperationFailed","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"secureEnclaveOperationFailed"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth09DPoPErrorV","text":"DPoPError"}],"abstract":[{"type":"text","text":"A Secure Enclave operation failed."},{"type":"text","text":" "},{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value 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\/dpoperror\/secureenclaveoperationfailed"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/dpoperror/!=(_:_:).json b/docs/data/documentation/auth0/dpoperror/!=(_:_:).json index e2611c24d..2ef1ba4aa 100644 --- a/docs/data/documentation/auth0/dpoperror/!=(_:_:).json +++ b/docs/data/documentation/auth0/dpoperror/!=(_:_:).json @@ -1 +1 @@ -{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/!=(_:_:)"},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"lhs","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"internalParam","text":"rhs"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"sections":[],"abstract":[{"type":"text","text":"Inherited from "},{"code":"Equatable.!=(_:_:)","type":"codeVoice"},{"type":"text","text":"."}],"metadata":{"modules":[{"relatedModules":["Swift"],"name":"Auth0"}],"symbolKind":"op","role":"symbol","externalID":"s:SQsE2neoiySbx_xtFZ::SYNTHESIZED::s:5Auth09DPoPErrorV","title":"!=(_:_:)","extendedModule":"Swift","roleHeading":"Operator","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","text":"Self"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}]},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError"]]},"kind":"symbol","schemaVersion":{"minor":3,"patch":0,"major":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/dpoperror\/!=(_:_:)"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/DPoPError/!=(_:_:)":{"fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"url":"\/documentation\/auth0\/dpoperror\/!=(_:_:)","role":"symbol","type":"topic","kind":"symbol","title":"!=(_:_:)","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/!=(_:_:)"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError":{"kind":"symbol","abstract":[{"type":"text","text":"Represents an error during a DPoP operation."}],"navigatorTitle":[{"text":"DPoPError","kind":"identifier"}],"title":"DPoPError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"DPoPError","kind":"identifier"}],"url":"\/documentation\/auth0\/dpoperror","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"schemaVersion":{"patch":0,"major":0,"minor":3},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"!="},{"kind":"text","text":" "},{"kind":"text","text":"("},{"kind":"internalParam","text":"lhs"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":", "},{"kind":"internalParam","text":"rhs"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"platforms":["iOS"]}]}],"sections":[],"abstract":[{"text":"Inherited from ","type":"text"},{"code":"Equatable.!=(_:_:)","type":"codeVoice"},{"text":".","type":"text"}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/dpoperror\/!=(_:_:)"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/!=(_:_:)","interfaceLanguage":"swift"},"metadata":{"symbolKind":"op","roleHeading":"Operator","externalID":"s:SQsE2neoiySbx_xtFZ::SYNTHESIZED::s:5Auth09DPoPErrorV","extendedModule":"Swift","title":"!=(_:_:)","modules":[{"name":"Auth0","relatedModules":["Swift"]}],"fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"role":"symbol"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/DPoPError/!=(_:_:)":{"role":"symbol","title":"!=(_:_:)","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"abstract":[],"kind":"symbol","url":"\/documentation\/auth0\/dpoperror\/!=(_:_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/!=(_:_:)","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError":{"role":"symbol","title":"DPoPError","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"DPoPError","kind":"identifier"}],"navigatorTitle":[{"text":"DPoPError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a DPoP operation."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError","url":"\/documentation\/auth0\/dpoperror","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/dpoperror/==(_:_:).json b/docs/data/documentation/auth0/dpoperror/==(_:_:).json index 2abc9b139..515770596 100644 --- a/docs/data/documentation/auth0/dpoperror/==(_:_:).json +++ b/docs/data/documentation/auth0/dpoperror/==(_:_:).json @@ -1 +1 @@ -{"abstract":[{"text":"Conformance to ","type":"text"},{"code":"Equatable","type":"codeVoice"},{"text":".","type":"text"}],"kind":"symbol","metadata":{"externalID":"s:5Auth09DPoPErrorV2eeoiySbAC_ACtFZ","role":"symbol","title":"==(_:_:)","extendedModule":"Auth0","roleHeading":"Operator","modules":[{"name":"Auth0"}],"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","text":"DPoPError","preciseIdentifier":"s:5Auth09DPoPErrorV"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"DPoPError","preciseIdentifier":"s:5Auth09DPoPErrorV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}]},"variants":[{"paths":["\/documentation\/auth0\/dpoperror\/==(_:_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/==(_:_:)","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError"]]},"schemaVersion":{"minor":3,"major":0,"patch":0},"sections":[],"primaryContentSections":[{"declarations":[{"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"==","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"lhs","kind":"internalParam"},{"text":": ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError","text":"DPoPError","preciseIdentifier":"s:5Auth09DPoPErrorV","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"rhs","kind":"internalParam"},{"text":": ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError","text":"DPoPError","preciseIdentifier":"s:5Auth09DPoPErrorV","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/DPoPError/==(_:_:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/==(_:_:)","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"==","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"DPoPError","preciseIdentifier":"s:5Auth09DPoPErrorV","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"DPoPError","preciseIdentifier":"s:5Auth09DPoPErrorV","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"kind":"symbol","role":"symbol","abstract":[{"text":"Conformance to ","type":"text"},{"code":"Equatable","type":"codeVoice"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/dpoperror\/==(_:_:)","title":"==(_:_:)","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError":{"kind":"symbol","abstract":[{"type":"text","text":"Represents an error during a DPoP operation."}],"navigatorTitle":[{"text":"DPoPError","kind":"identifier"}],"title":"DPoPError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"DPoPError","kind":"identifier"}],"url":"\/documentation\/auth0\/dpoperror","role":"symbol"}}} \ No newline at end of file +{"sections":[],"kind":"symbol","metadata":{"modules":[{"name":"Auth0"}],"title":"==(_:_:)","externalID":"s:5Auth09DPoPErrorV2eeoiySbAC_ACtFZ","role":"symbol","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":"DPoPError","preciseIdentifier":"s:5Auth09DPoPErrorV","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"DPoPError","preciseIdentifier":"s:5Auth09DPoPErrorV","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"extendedModule":"Auth0","roleHeading":"Operator","symbolKind":"op"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/==(_:_:)"},"variants":[{"paths":["\/documentation\/auth0\/dpoperror\/==(_:_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError"]]},"schemaVersion":{"minor":3,"patch":0,"major":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"==","kind":"identifier"},{"kind":"text","text":" "},{"kind":"text","text":"("},{"kind":"internalParam","text":"lhs"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError","text":"DPoPError","preciseIdentifier":"s:5Auth09DPoPErrorV"},{"kind":"text","text":", "},{"kind":"internalParam","text":"rhs"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth09DPoPErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError","kind":"typeIdentifier","text":"DPoPError"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}]}]}],"abstract":[{"type":"text","text":"Conformance to "},{"type":"codeVoice","code":"Equatable"},{"type":"text","text":"."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/DPoPError":{"role":"symbol","title":"DPoPError","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"DPoPError","kind":"identifier"}],"navigatorTitle":[{"text":"DPoPError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a DPoP operation."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError","url":"\/documentation\/auth0\/dpoperror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError/==(_:_:)":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/==(_:_:)","title":"==(_:_:)","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"=="},{"kind":"text","text":" "},{"kind":"text","text":"("},{"preciseIdentifier":"s:5Auth09DPoPErrorV","text":"DPoPError","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"DPoPError","preciseIdentifier":"s:5Auth09DPoPErrorV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"role":"symbol","url":"\/documentation\/auth0\/dpoperror\/==(_:_:)","abstract":[{"text":"Conformance to ","type":"text"},{"type":"codeVoice","code":"Equatable"},{"type":"text","text":"."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/dpoperror/auth0error-implementations.json b/docs/data/documentation/auth0/dpoperror/auth0error-implementations.json index 7dbcac26f..95d184953 100644 --- a/docs/data/documentation/auth0/dpoperror/auth0error-implementations.json +++ b/docs/data/documentation/auth0/dpoperror/auth0error-implementations.json @@ -1 +1 @@ -{"metadata":{"title":"Auth0Error Implementations","role":"collectionGroup","modules":[{"name":"Auth0"}],"roleHeading":"API Collection"},"kind":"article","variants":[{"paths":["\/documentation\/auth0\/dpoperror\/auth0error-implementations"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/Auth0Error-Implementations"},"sections":[],"schemaVersion":{"major":0,"patch":0,"minor":3},"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/errorDescription","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/localizedDescription"],"anchor":"Instance-Properties","generated":true,"title":"Instance Properties"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/DPoPError":{"kind":"symbol","abstract":[{"type":"text","text":"Represents an error during a DPoP operation."}],"navigatorTitle":[{"text":"DPoPError","kind":"identifier"}],"title":"DPoPError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"DPoPError","kind":"identifier"}],"url":"\/documentation\/auth0\/dpoperror","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError/localizedDescription":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/localizedDescription","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"localizedDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"kind":"symbol","title":"localizedDescription","url":"\/documentation\/auth0\/dpoperror\/localizeddescription","abstract":[{"text":"Description of the error.","type":"text"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError/errorDescription":{"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"errorDescription"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}],"kind":"symbol","type":"topic","title":"errorDescription","abstract":[{"type":"text","text":"Description of the error."}],"role":"symbol","url":"\/documentation\/auth0\/dpoperror\/errordescription","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/errorDescription"}}} \ No newline at end of file +{"variants":[{"paths":["\/documentation\/auth0\/dpoperror\/auth0error-implementations"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError"]]},"topicSections":[{"title":"Instance Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/errorDescription","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/localizedDescription"],"generated":true,"anchor":"Instance-Properties"}],"schemaVersion":{"patch":0,"minor":3,"major":0},"kind":"article","sections":[],"metadata":{"title":"Auth0Error Implementations","modules":[{"name":"Auth0"}],"roleHeading":"API Collection","role":"collectionGroup"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/Auth0Error-Implementations"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError":{"role":"symbol","title":"DPoPError","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"DPoPError","kind":"identifier"}],"navigatorTitle":[{"text":"DPoPError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a DPoP operation."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError","url":"\/documentation\/auth0\/dpoperror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError/localizedDescription":{"url":"\/documentation\/auth0\/dpoperror\/localizeddescription","title":"localizedDescription","abstract":[{"type":"text","text":"Description of the error."}],"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"localizedDescription","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/localizedDescription","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError/errorDescription":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/errorDescription","kind":"symbol","title":"errorDescription","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"errorDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"role":"symbol","url":"\/documentation\/auth0\/dpoperror\/errordescription","abstract":[{"type":"text","text":"Description of the error."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/dpoperror/cause.json b/docs/data/documentation/auth0/dpoperror/cause.json index 631aad35f..6f9edde19 100644 --- a/docs/data/documentation/auth0/dpoperror/cause.json +++ b/docs/data/documentation/auth0/dpoperror/cause.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/cause","interfaceLanguage":"swift"},"sections":[],"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":"."}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier","text":"Error"},{"kind":"text","text":"?"}],"languages":["swift"]}],"kind":"declarations"}],"schemaVersion":{"minor":3,"patch":0,"major":0},"variants":[{"paths":["\/documentation\/auth0\/dpoperror\/cause"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","metadata":{"externalID":"s:5Auth09DPoPErrorV5causes5Error_pSgvp","title":"cause","roleHeading":"Instance Property","symbolKind":"property","modules":[{"name":"Auth0"}],"role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":"?"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError":{"kind":"symbol","abstract":[{"type":"text","text":"Represents an error during a DPoP operation."}],"navigatorTitle":[{"text":"DPoPError","kind":"identifier"}],"title":"DPoPError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"DPoPError","kind":"identifier"}],"url":"\/documentation\/auth0\/dpoperror","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError/cause":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/cause","title":"cause","url":"\/documentation\/auth0\/dpoperror\/cause","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP","text":"Error"},{"kind":"text","text":"?"}],"role":"symbol","kind":"symbol","type":"topic","abstract":[{"text":"The underlying ","type":"text"},{"type":"codeVoice","code":"Error"},{"text":" value, if any. Defaults to ","type":"text"},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}]}}} \ No newline at end of file +{"variants":[{"paths":["\/documentation\/auth0\/dpoperror\/cause"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError"]]},"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"}],"primaryContentSections":[{"declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":"?"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"sections":[],"kind":"symbol","schemaVersion":{"patch":0,"minor":3,"major":0},"metadata":{"externalID":"s:5Auth09DPoPErrorV5causes5Error_pSgvp","symbolKind":"property","title":"cause","role":"symbol","roleHeading":"Instance Property","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP","text":"Error"},{"kind":"text","text":"?"}],"modules":[{"name":"Auth0"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/cause","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError/cause":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/cause","type":"topic","title":"cause","role":"symbol","kind":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP","text":"Error"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"text":" value, if any. Defaults to ","type":"text"},{"code":"nil","type":"codeVoice"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/dpoperror\/cause"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError":{"role":"symbol","title":"DPoPError","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"DPoPError","kind":"identifier"}],"navigatorTitle":[{"text":"DPoPError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a DPoP operation."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError","url":"\/documentation\/auth0\/dpoperror","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/dpoperror/cryptokitoperationfailed.json b/docs/data/documentation/auth0/dpoperror/cryptokitoperationfailed.json index 3aa4b189f..783bad46a 100644 --- a/docs/data/documentation/auth0/dpoperror/cryptokitoperationfailed.json +++ b/docs/data/documentation/auth0/dpoperror/cryptokitoperationfailed.json @@ -1 +1 @@ -{"metadata":{"symbolKind":"property","roleHeading":"Type Property","title":"cryptoKitOperationFailed","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cryptoKitOperationFailed","kind":"identifier"},{"text":": ","kind":"text"},{"text":"DPoPError","preciseIdentifier":"s:5Auth09DPoPErrorV","kind":"typeIdentifier"}],"externalID":"s:5Auth09DPoPErrorV24cryptoKitOperationFailedACvpZ","modules":[{"name":"Auth0"}],"role":"symbol"},"sections":[],"primaryContentSections":[{"declarations":[{"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cryptoKitOperationFailed","kind":"identifier"},{"text":": ","kind":"text"},{"text":"DPoPError","preciseIdentifier":"s:5Auth09DPoPErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError","kind":"typeIdentifier"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"variants":[{"paths":["\/documentation\/auth0\/dpoperror\/cryptokitoperationfailed"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/cryptoKitOperationFailed","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError"]]},"schemaVersion":{"minor":3,"patch":0,"major":0},"abstract":[{"type":"text","text":"A CryptoKit operation failed."},{"type":"text","text":" "},{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value can be accessed via the "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true},{"type":"text","text":" property."}],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/DPoPError":{"kind":"symbol","abstract":[{"type":"text","text":"Represents an error during a DPoP operation."}],"navigatorTitle":[{"text":"DPoPError","kind":"identifier"}],"title":"DPoPError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"DPoPError","kind":"identifier"}],"url":"\/documentation\/auth0\/dpoperror","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"title":"cause","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","kind":"symbol","abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":"?"}],"role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError/cryptoKitOperationFailed":{"kind":"symbol","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/cryptoKitOperationFailed","abstract":[{"type":"text","text":"A CryptoKit operation failed."},{"type":"text","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."}],"fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"cryptoKitOperationFailed"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth09DPoPErrorV","kind":"typeIdentifier","text":"DPoPError"}],"type":"topic","url":"\/documentation\/auth0\/dpoperror\/cryptokitoperationfailed","title":"cryptoKitOperationFailed"}}} \ No newline at end of file +{"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/cryptoKitOperationFailed","interfaceLanguage":"swift"},"kind":"symbol","metadata":{"externalID":"s:5Auth09DPoPErrorV24cryptoKitOperationFailedACvpZ","modules":[{"name":"Auth0"}],"title":"cryptoKitOperationFailed","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cryptoKitOperationFailed","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth09DPoPErrorV","text":"DPoPError","kind":"typeIdentifier"}],"roleHeading":"Type Property","role":"symbol","symbolKind":"property"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/dpoperror\/cryptokitoperationfailed"]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError"]]},"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cryptoKitOperationFailed","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth09DPoPErrorV","text":"DPoPError","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError"}],"platforms":["iOS"]}],"kind":"declarations"}],"abstract":[{"text":"A CryptoKit operation failed.","type":"text"},{"text":" ","type":"text"},{"text":"The underlying ","type":"text"},{"code":"Error","type":"codeVoice"},{"text":" value 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"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError":{"role":"symbol","title":"DPoPError","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"DPoPError","kind":"identifier"}],"navigatorTitle":[{"text":"DPoPError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a DPoP operation."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError","url":"\/documentation\/auth0\/dpoperror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"kind":"symbol","title":"cause","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier","text":"Error"},{"kind":"text","text":"?"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","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":"."}],"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError/cryptoKitOperationFailed":{"url":"\/documentation\/auth0\/dpoperror\/cryptokitoperationfailed","abstract":[{"type":"text","text":"A CryptoKit operation failed."},{"type":"text","text":" "},{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value can be accessed via the "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference","isActive":true},{"type":"text","text":" property."}],"title":"cryptoKitOperationFailed","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cryptoKitOperationFailed","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth09DPoPErrorV","text":"DPoPError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/cryptoKitOperationFailed","role":"symbol","kind":"symbol","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/dpoperror/debugdescription.json b/docs/data/documentation/auth0/dpoperror/debugdescription.json index 333d956fa..1827902b9 100644 --- a/docs/data/documentation/auth0/dpoperror/debugdescription.json +++ b/docs/data/documentation/auth0/dpoperror/debugdescription.json @@ -1 +1 @@ -{"variants":[{"paths":["\/documentation\/auth0\/dpoperror\/debugdescription"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"type":"text","text":"Description of the error."}],"sections":[],"metadata":{"modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","title":"debugDescription","symbolKind":"property","externalID":"s:5Auth09DPoPErrorV16debugDescriptionSSvp","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"debugDescription","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"role":"symbol"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/debugDescription"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"debugDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"languages":["swift"]}]},{"kind":"content","content":[{"anchor":"discussion","text":"Discussion","type":"heading","level":2},{"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 "},{"inlineContent":[{"type":"text","text":"debugging"}],"type":"strong"},{"type":"text","text":" only."}]}]}]}],"kind":"symbol","schemaVersion":{"patch":0,"minor":3,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError":{"kind":"symbol","abstract":[{"type":"text","text":"Represents an error during a DPoP operation."}],"navigatorTitle":[{"text":"DPoPError","kind":"identifier"}],"title":"DPoPError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"DPoPError","kind":"identifier"}],"url":"\/documentation\/auth0\/dpoperror","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError/debugDescription":{"abstract":[{"type":"text","text":"Description of the error."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/debugDescription","title":"debugDescription","url":"\/documentation\/auth0\/dpoperror\/debugdescription","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"debugDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"kind":"symbol","type":"topic"}}} \ No newline at end of file +{"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"debugDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"platforms":["iOS"]}]},{"kind":"content","content":[{"text":"Discussion","level":2,"anchor":"discussion","type":"heading"},{"name":"Important","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"}]}],"sections":[],"abstract":[{"text":"Description of the error.","type":"text"}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/dpoperror\/debugdescription"]}],"metadata":{"role":"symbol","modules":[{"name":"Auth0"}],"title":"debugDescription","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"debugDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"externalID":"s:5Auth09DPoPErrorV16debugDescriptionSSvp","roleHeading":"Instance Property","symbolKind":"property"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/debugDescription"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/DPoPError/debugDescription":{"url":"\/documentation\/auth0\/dpoperror\/debugdescription","abstract":[{"type":"text","text":"Description of the error."}],"title":"debugDescription","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"debugDescription"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/debugDescription","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError":{"role":"symbol","title":"DPoPError","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"DPoPError","kind":"identifier"}],"navigatorTitle":[{"text":"DPoPError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a DPoP operation."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError","url":"\/documentation\/auth0\/dpoperror","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/dpoperror/equatable-implementations.json b/docs/data/documentation/auth0/dpoperror/equatable-implementations.json index c18883559..eb8c52773 100644 --- a/docs/data/documentation/auth0/dpoperror/equatable-implementations.json +++ b/docs/data/documentation/auth0/dpoperror/equatable-implementations.json @@ -1 +1 @@ -{"kind":"article","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError"]]},"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/Equatable-Implementations"},"metadata":{"role":"collectionGroup","title":"Equatable Implementations","roleHeading":"API Collection","modules":[{"name":"Auth0"}]},"variants":[{"paths":["\/documentation\/auth0\/dpoperror\/equatable-implementations"],"traits":[{"interfaceLanguage":"swift"}]}],"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/!=(_:_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/==(_:_:)"],"generated":true,"title":"Operators","anchor":"Operators"}],"schemaVersion":{"major":0,"patch":0,"minor":3},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError/!=(_:_:)":{"fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"url":"\/documentation\/auth0\/dpoperror\/!=(_:_:)","role":"symbol","type":"topic","kind":"symbol","title":"!=(_:_:)","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/!=(_:_:)"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError":{"kind":"symbol","abstract":[{"type":"text","text":"Represents an error during a DPoP operation."}],"navigatorTitle":[{"text":"DPoPError","kind":"identifier"}],"title":"DPoPError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"DPoPError","kind":"identifier"}],"url":"\/documentation\/auth0\/dpoperror","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError/==(_:_:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/==(_:_:)","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"==","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"DPoPError","preciseIdentifier":"s:5Auth09DPoPErrorV","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"DPoPError","preciseIdentifier":"s:5Auth09DPoPErrorV","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"kind":"symbol","role":"symbol","abstract":[{"text":"Conformance to ","type":"text"},{"code":"Equatable","type":"codeVoice"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/dpoperror\/==(_:_:)","title":"==(_:_:)","type":"topic"}}} \ No newline at end of file +{"topicSections":[{"title":"Operators","generated":true,"anchor":"Operators","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/!=(_:_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/==(_:_:)"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/dpoperror\/equatable-implementations"]}],"kind":"article","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/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\/DPoPError"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError/==(_:_:)":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/==(_:_:)","title":"==(_:_:)","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"=="},{"kind":"text","text":" "},{"kind":"text","text":"("},{"preciseIdentifier":"s:5Auth09DPoPErrorV","text":"DPoPError","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"DPoPError","preciseIdentifier":"s:5Auth09DPoPErrorV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"role":"symbol","url":"\/documentation\/auth0\/dpoperror\/==(_:_:)","abstract":[{"text":"Conformance to ","type":"text"},{"type":"codeVoice","code":"Equatable"},{"type":"text","text":"."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError":{"role":"symbol","title":"DPoPError","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"DPoPError","kind":"identifier"}],"navigatorTitle":[{"text":"DPoPError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a DPoP operation."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError","url":"\/documentation\/auth0\/dpoperror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError/!=(_:_:)":{"role":"symbol","title":"!=(_:_:)","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"abstract":[],"kind":"symbol","url":"\/documentation\/auth0\/dpoperror\/!=(_:_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/!=(_:_:)","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/dpoperror/errordescription.json b/docs/data/documentation/auth0/dpoperror/errordescription.json index c4f2ebbd2..2dfc43e6a 100644 --- a/docs/data/documentation/auth0/dpoperror/errordescription.json +++ b/docs/data/documentation/auth0/dpoperror/errordescription.json @@ -1 +1 @@ -{"kind":"symbol","abstract":[{"type":"text","text":"Description of the error."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError"]]},"metadata":{"externalID":"s:5Auth00A5ErrorPAAE16errorDescriptionSSSgvp::SYNTHESIZED::s:5Auth09DPoPErrorV","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"errorDescription","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"role":"symbol","extendedModule":"Auth0","modules":[{"name":"Auth0"}],"title":"errorDescription","symbolKind":"property","roleHeading":"Instance Property"},"variants":[{"paths":["\/documentation\/auth0\/dpoperror\/errordescription"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"errorDescription","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"? { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"},{"content":[{"type":"heading","text":"Discussion","anchor":"discussion","level":2},{"style":"important","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 "},{"type":"strong","inlineContent":[{"type":"text","text":"debugging"}]},{"type":"text","text":" only."}]}]}],"kind":"content"}],"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/errorDescription","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/DPoPError":{"kind":"symbol","abstract":[{"type":"text","text":"Represents an error during a DPoP operation."}],"navigatorTitle":[{"text":"DPoPError","kind":"identifier"}],"title":"DPoPError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"DPoPError","kind":"identifier"}],"url":"\/documentation\/auth0\/dpoperror","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError/errorDescription":{"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"errorDescription"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}],"kind":"symbol","type":"topic","title":"errorDescription","abstract":[{"type":"text","text":"Description of the error."}],"role":"symbol","url":"\/documentation\/auth0\/dpoperror\/errordescription","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/errorDescription"}}} \ No newline at end of file +{"metadata":{"symbolKind":"property","title":"errorDescription","externalID":"s:5Auth00A5ErrorPAAE16errorDescriptionSSSgvp::SYNTHESIZED::s:5Auth09DPoPErrorV","roleHeading":"Instance Property","extendedModule":"Auth0","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"errorDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"role":"symbol"},"sections":[],"variants":[{"paths":["\/documentation\/auth0\/dpoperror\/errordescription"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/errorDescription","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"type":"text","text":"Description of the error."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError"]]},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"errorDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"? { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}]}],"kind":"declarations"},{"kind":"content","content":[{"level":2,"type":"heading","anchor":"discussion","text":"Discussion"},{"type":"aside","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"You should avoid displaying the error description to the user, it’s meant for "},{"inlineContent":[{"type":"text","text":"debugging"}],"type":"strong"},{"type":"text","text":" only."}]}],"name":"Important","style":"important"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/DPoPError/errorDescription":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/errorDescription","kind":"symbol","title":"errorDescription","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"errorDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"role":"symbol","url":"\/documentation\/auth0\/dpoperror\/errordescription","abstract":[{"type":"text","text":"Description of the error."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError":{"role":"symbol","title":"DPoPError","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"DPoPError","kind":"identifier"}],"navigatorTitle":[{"text":"DPoPError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a DPoP operation."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError","url":"\/documentation\/auth0\/dpoperror","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/dpoperror/failurereason.json b/docs/data/documentation/auth0/dpoperror/failurereason.json index 518a6f17e..dc13287f5 100644 --- a/docs/data/documentation/auth0/dpoperror/failurereason.json +++ b/docs/data/documentation/auth0/dpoperror/failurereason.json @@ -1 +1 @@ -{"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/dpoperror\/failurereason"]}],"abstract":[{"text":"Inherited from ","type":"text"},{"type":"codeVoice","code":"LocalizedError.failureReason"},{"text":".","type":"text"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"failureReason","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"? { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]}],"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/failureReason"},"metadata":{"symbolKind":"property","roleHeading":"Instance Property","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"failureReason"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"title":"failureReason","modules":[{"relatedModules":["Foundation"],"name":"Auth0"}],"role":"symbol","extendedModule":"Foundation","externalID":"s:10Foundation14LocalizedErrorPAAE13failureReasonSSSgvp::SYNTHESIZED::s:5Auth09DPoPErrorV","platforms":[{"unavailable":false,"beta":false,"deprecated":false,"name":"iOS","introducedAt":"8.0"},{"unavailable":false,"beta":false,"deprecated":false,"name":"iPadOS","introducedAt":"8.0"},{"unavailable":false,"beta":false,"deprecated":false,"name":"Mac Catalyst","introducedAt":"8.0"},{"unavailable":false,"beta":false,"deprecated":false,"name":"macOS","introducedAt":"10.10"},{"unavailable":false,"beta":false,"deprecated":false,"name":"tvOS","introducedAt":"9.0"},{"unavailable":false,"beta":false,"deprecated":false,"name":"watchOS","introducedAt":"2.0"}]},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/DPoPError/failureReason":{"title":"failureReason","role":"symbol","url":"\/documentation\/auth0\/dpoperror\/failurereason","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"failureReason"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"abstract":[],"kind":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/failureReason"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError":{"kind":"symbol","abstract":[{"type":"text","text":"Represents an error during a DPoP operation."}],"navigatorTitle":[{"text":"DPoPError","kind":"identifier"}],"title":"DPoPError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"DPoPError","kind":"identifier"}],"url":"\/documentation\/auth0\/dpoperror","role":"symbol"}}} \ No newline at end of file +{"sections":[],"metadata":{"platforms":[{"beta":false,"name":"iOS","introducedAt":"8.0","unavailable":false,"deprecated":false},{"beta":false,"name":"iPadOS","introducedAt":"8.0","unavailable":false,"deprecated":false},{"beta":false,"name":"Mac Catalyst","introducedAt":"8.0","unavailable":false,"deprecated":false},{"beta":false,"name":"macOS","introducedAt":"10.10","unavailable":false,"deprecated":false},{"beta":false,"name":"tvOS","introducedAt":"9.0","unavailable":false,"deprecated":false},{"beta":false,"name":"watchOS","introducedAt":"2.0","unavailable":false,"deprecated":false}],"roleHeading":"Instance Property","symbolKind":"property","modules":[{"name":"Auth0","relatedModules":["Foundation"]}],"title":"failureReason","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"failureReason"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}],"externalID":"s:10Foundation14LocalizedErrorPAAE13failureReasonSSSgvp::SYNTHESIZED::s:5Auth09DPoPErrorV","role":"symbol","extendedModule":"Foundation"},"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/failureReason","interfaceLanguage":"swift"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/dpoperror\/failurereason"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"failureReason"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"? { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"platforms":["iOS"],"languages":["swift"]}]}],"abstract":[{"type":"text","text":"Inherited from "},{"code":"LocalizedError.failureReason","type":"codeVoice"},{"type":"text","text":"."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/DPoPError":{"role":"symbol","title":"DPoPError","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"DPoPError","kind":"identifier"}],"navigatorTitle":[{"text":"DPoPError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a DPoP operation."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError","url":"\/documentation\/auth0\/dpoperror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError/failureReason":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/failureReason","title":"failureReason","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"failureReason"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"role":"symbol","url":"\/documentation\/auth0\/dpoperror\/failurereason","abstract":[],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/dpoperror/helpanchor.json b/docs/data/documentation/auth0/dpoperror/helpanchor.json index e5042462c..650248cc8 100644 --- a/docs/data/documentation/auth0/dpoperror/helpanchor.json +++ b/docs/data/documentation/auth0/dpoperror/helpanchor.json @@ -1 +1 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/helpAnchor","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"helpAnchor"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"? { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}]}]}],"variants":[{"paths":["\/documentation\/auth0\/dpoperror\/helpanchor"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"text":"Inherited from ","type":"text"},{"type":"codeVoice","code":"LocalizedError.helpAnchor"},{"text":".","type":"text"}],"metadata":{"roleHeading":"Instance Property","role":"symbol","externalID":"s:10Foundation14LocalizedErrorPAAE10helpAnchorSSSgvp::SYNTHESIZED::s:5Auth09DPoPErrorV","symbolKind":"property","platforms":[{"beta":false,"name":"iOS","unavailable":false,"deprecated":false,"introducedAt":"8.0"},{"beta":false,"name":"iPadOS","unavailable":false,"deprecated":false,"introducedAt":"8.0"},{"beta":false,"name":"Mac Catalyst","unavailable":false,"deprecated":false,"introducedAt":"8.0"},{"beta":false,"name":"macOS","unavailable":false,"deprecated":false,"introducedAt":"10.10"},{"beta":false,"name":"tvOS","unavailable":false,"deprecated":false,"introducedAt":"9.0"},{"beta":false,"name":"watchOS","unavailable":false,"deprecated":false,"introducedAt":"2.0"}],"extendedModule":"Foundation","modules":[{"name":"Auth0","relatedModules":["Foundation"]}],"title":"helpAnchor","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"helpAnchor","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}]},"sections":[],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/DPoPError/helpAnchor":{"kind":"symbol","abstract":[],"type":"topic","title":"helpAnchor","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"helpAnchor"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/helpAnchor","url":"\/documentation\/auth0\/dpoperror\/helpanchor","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError":{"kind":"symbol","abstract":[{"type":"text","text":"Represents an error during a DPoP operation."}],"navigatorTitle":[{"text":"DPoPError","kind":"identifier"}],"title":"DPoPError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"DPoPError","kind":"identifier"}],"url":"\/documentation\/auth0\/dpoperror","role":"symbol"}}} \ No newline at end of file +{"metadata":{"platforms":[{"deprecated":false,"unavailable":false,"beta":false,"name":"iOS","introducedAt":"8.0"},{"deprecated":false,"unavailable":false,"beta":false,"name":"iPadOS","introducedAt":"8.0"},{"deprecated":false,"unavailable":false,"beta":false,"name":"Mac Catalyst","introducedAt":"8.0"},{"deprecated":false,"unavailable":false,"beta":false,"name":"macOS","introducedAt":"10.10"},{"deprecated":false,"unavailable":false,"beta":false,"name":"tvOS","introducedAt":"9.0"},{"deprecated":false,"unavailable":false,"beta":false,"name":"watchOS","introducedAt":"2.0"}],"symbolKind":"property","roleHeading":"Instance Property","title":"helpAnchor","extendedModule":"Foundation","externalID":"s:10Foundation14LocalizedErrorPAAE10helpAnchorSSSgvp::SYNTHESIZED::s:5Auth09DPoPErrorV","modules":[{"name":"Auth0","relatedModules":["Foundation"]}],"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"helpAnchor","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"role":"symbol"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/dpoperror\/helpanchor"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/helpAnchor"},"kind":"symbol","abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"LocalizedError.helpAnchor"},{"type":"text","text":"."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"helpAnchor","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"? { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/DPoPError":{"role":"symbol","title":"DPoPError","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"DPoPError","kind":"identifier"}],"navigatorTitle":[{"text":"DPoPError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a DPoP operation."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError","url":"\/documentation\/auth0\/dpoperror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError/helpAnchor":{"type":"topic","title":"helpAnchor","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/helpAnchor","kind":"symbol","abstract":[],"url":"\/documentation\/auth0\/dpoperror\/helpanchor","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"helpAnchor"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/dpoperror/keychainoperationfailed.json b/docs/data/documentation/auth0/dpoperror/keychainoperationfailed.json index eb45606c2..98e44fa77 100644 --- a/docs/data/documentation/auth0/dpoperror/keychainoperationfailed.json +++ b/docs/data/documentation/auth0/dpoperror/keychainoperationfailed.json @@ -1 +1 @@ -{"kind":"symbol","sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError"]]},"variants":[{"paths":["\/documentation\/auth0\/dpoperror\/keychainoperationfailed"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"type":"text","text":"A Keychain operation failed."},{"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},{"type":"text","text":"."}],"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"keychainOperationFailed","kind":"identifier"},{"text":": ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError","text":"DPoPError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth09DPoPErrorV"}],"platforms":["iOS"],"languages":["swift"]}]}],"metadata":{"role":"symbol","title":"keychainOperationFailed","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"keychainOperationFailed"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth09DPoPErrorV","text":"DPoPError"}],"externalID":"s:5Auth09DPoPErrorV23keychainOperationFailedACvpZ","symbolKind":"property","roleHeading":"Type Property","modules":[{"name":"Auth0"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/keychainOperationFailed","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/DPoPError":{"kind":"symbol","abstract":[{"type":"text","text":"Represents an error during a DPoP operation."}],"navigatorTitle":[{"text":"DPoPError","kind":"identifier"}],"title":"DPoPError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"DPoPError","kind":"identifier"}],"url":"\/documentation\/auth0\/dpoperror","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError/keychainOperationFailed":{"fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"keychainOperationFailed","kind":"identifier"},{"text":": ","kind":"text"},{"text":"DPoPError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth09DPoPErrorV"}],"type":"topic","abstract":[{"type":"text","text":"A Keychain operation failed."},{"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"}],"role":"symbol","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/keychainOperationFailed","title":"keychainOperationFailed","url":"\/documentation\/auth0\/dpoperror\/keychainoperationfailed"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"title":"cause","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","kind":"symbol","abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":"?"}],"role":"symbol","type":"topic"}}} \ No newline at end of file +{"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"keychainOperationFailed"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth09DPoPErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError","text":"DPoPError"}]}],"kind":"declarations"}],"sections":[],"abstract":[{"type":"text","text":"A Keychain operation failed."},{"type":"text","text":" "},{"type":"text","text":"This error does not include a "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true},{"type":"text","text":"."}],"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/dpoperror\/keychainoperationfailed"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"role":"symbol","modules":[{"name":"Auth0"}],"title":"keychainOperationFailed","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"keychainOperationFailed"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth09DPoPErrorV","text":"DPoPError"}],"externalID":"s:5Auth09DPoPErrorV23keychainOperationFailedACvpZ","roleHeading":"Type Property","symbolKind":"property"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/keychainOperationFailed"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"kind":"symbol","title":"cause","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier","text":"Error"},{"kind":"text","text":"?"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","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":"."}],"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError/keychainOperationFailed":{"kind":"symbol","abstract":[{"text":"A Keychain operation failed.","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"},{"text":".","type":"text"}],"type":"topic","url":"\/documentation\/auth0\/dpoperror\/keychainoperationfailed","title":"keychainOperationFailed","role":"symbol","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"keychainOperationFailed","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth09DPoPErrorV","text":"DPoPError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/keychainOperationFailed"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError":{"role":"symbol","title":"DPoPError","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"DPoPError","kind":"identifier"}],"navigatorTitle":[{"text":"DPoPError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a DPoP operation."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError","url":"\/documentation\/auth0\/dpoperror","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/dpoperror/localizeddescription.json b/docs/data/documentation/auth0/dpoperror/localizeddescription.json index 8d6d0a630..f6011d697 100644 --- a/docs/data/documentation/auth0/dpoperror/localizeddescription.json +++ b/docs/data/documentation/auth0/dpoperror/localizeddescription.json @@ -1 +1 @@ -{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/localizedDescription"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError"]]},"abstract":[{"type":"text","text":"Description of the error."}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"localizedDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"languages":["swift"]}],"kind":"declarations"},{"content":[{"text":"Discussion","type":"heading","anchor":"discussion","level":2},{"content":[{"type":"paragraph","inlineContent":[{"text":"You should avoid displaying the error description to the user, it’s meant for ","type":"text"},{"inlineContent":[{"text":"debugging","type":"text"}],"type":"strong"},{"text":" only.","type":"text"}]}],"name":"Important","type":"aside","style":"important"}],"kind":"content"}],"metadata":{"roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"role":"symbol","title":"localizedDescription","symbolKind":"property","externalID":"s:5Auth00A5ErrorPAAE20localizedDescriptionSSvp::SYNTHESIZED::s:5Auth09DPoPErrorV","extendedModule":"Auth0","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"localizedDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}]},"sections":[],"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"variants":[{"paths":["\/documentation\/auth0\/dpoperror\/localizeddescription"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/DPoPError/localizedDescription":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/localizedDescription","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"localizedDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"kind":"symbol","title":"localizedDescription","url":"\/documentation\/auth0\/dpoperror\/localizeddescription","abstract":[{"text":"Description of the error.","type":"text"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError":{"kind":"symbol","abstract":[{"type":"text","text":"Represents an error during a DPoP operation."}],"navigatorTitle":[{"text":"DPoPError","kind":"identifier"}],"title":"DPoPError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"DPoPError","kind":"identifier"}],"url":"\/documentation\/auth0\/dpoperror","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"metadata":{"symbolKind":"property","title":"localizedDescription","roleHeading":"Instance Property","externalID":"s:5Auth00A5ErrorPAAE20localizedDescriptionSSvp::SYNTHESIZED::s:5Auth09DPoPErrorV","extendedModule":"Auth0","modules":[{"name":"Auth0"}],"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"localizedDescription","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"role":"symbol"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/dpoperror\/localizeddescription"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/localizedDescription","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"text":"Description of the error.","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"localizedDescription","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]},{"kind":"content","content":[{"type":"heading","level":2,"anchor":"discussion","text":"Discussion"},{"type":"aside","name":"Important","content":[{"inlineContent":[{"text":"You should avoid displaying the error description to the user, it’s meant for ","type":"text"},{"inlineContent":[{"text":"debugging","type":"text"}],"type":"strong"},{"text":" only.","type":"text"}],"type":"paragraph"}],"style":"important"}]}],"schemaVersion":{"patch":0,"minor":3,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/DPoPError":{"role":"symbol","title":"DPoPError","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"DPoPError","kind":"identifier"}],"navigatorTitle":[{"text":"DPoPError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a DPoP operation."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError","url":"\/documentation\/auth0\/dpoperror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError/localizedDescription":{"url":"\/documentation\/auth0\/dpoperror\/localizeddescription","title":"localizedDescription","abstract":[{"type":"text","text":"Description of the error."}],"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"localizedDescription","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/localizedDescription","role":"symbol","kind":"symbol","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/dpoperror/localizederror-implementations.json b/docs/data/documentation/auth0/dpoperror/localizederror-implementations.json index f8b3e81ba..e60ab9291 100644 --- a/docs/data/documentation/auth0/dpoperror/localizederror-implementations.json +++ b/docs/data/documentation/auth0/dpoperror/localizederror-implementations.json @@ -1 +1 @@ -{"kind":"article","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError"]]},"sections":[],"metadata":{"role":"collectionGroup","title":"LocalizedError Implementations","roleHeading":"API Collection","modules":[{"name":"Auth0"}]},"schemaVersion":{"minor":3,"patch":0,"major":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/LocalizedError-Implementations","interfaceLanguage":"swift"},"variants":[{"paths":["\/documentation\/auth0\/dpoperror\/localizederror-implementations"],"traits":[{"interfaceLanguage":"swift"}]}],"topicSections":[{"title":"Instance Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/failureReason","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/helpAnchor","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/recoverySuggestion"],"generated":true,"anchor":"Instance-Properties"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/DPoPError/recoverySuggestion":{"abstract":[],"title":"recoverySuggestion","kind":"symbol","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"recoverySuggestion","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"url":"\/documentation\/auth0\/dpoperror\/recoverysuggestion","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/recoverySuggestion"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError":{"kind":"symbol","abstract":[{"type":"text","text":"Represents an error during a DPoP operation."}],"navigatorTitle":[{"text":"DPoPError","kind":"identifier"}],"title":"DPoPError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"DPoPError","kind":"identifier"}],"url":"\/documentation\/auth0\/dpoperror","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError/helpAnchor":{"kind":"symbol","abstract":[],"type":"topic","title":"helpAnchor","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"helpAnchor"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/helpAnchor","url":"\/documentation\/auth0\/dpoperror\/helpanchor","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError/failureReason":{"title":"failureReason","role":"symbol","url":"\/documentation\/auth0\/dpoperror\/failurereason","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"failureReason"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"abstract":[],"kind":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/failureReason"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/dpoperror\/localizederror-implementations"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError"]]},"topicSections":[{"generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/failureReason","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/helpAnchor","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/recoverySuggestion"],"title":"Instance Properties","anchor":"Instance-Properties"}],"kind":"article","schemaVersion":{"minor":3,"major":0,"patch":0},"sections":[],"metadata":{"title":"LocalizedError Implementations","roleHeading":"API Collection","modules":[{"name":"Auth0"}],"role":"collectionGroup"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/LocalizedError-Implementations","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError/recoverySuggestion":{"type":"topic","abstract":[],"title":"recoverySuggestion","kind":"symbol","url":"\/documentation\/auth0\/dpoperror\/recoverysuggestion","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"recoverySuggestion"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/recoverySuggestion"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError/failureReason":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/failureReason","title":"failureReason","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"failureReason"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"role":"symbol","url":"\/documentation\/auth0\/dpoperror\/failurereason","abstract":[],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError/helpAnchor":{"type":"topic","title":"helpAnchor","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/helpAnchor","kind":"symbol","abstract":[],"url":"\/documentation\/auth0\/dpoperror\/helpanchor","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"helpAnchor"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}]},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError":{"role":"symbol","title":"DPoPError","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"DPoPError","kind":"identifier"}],"navigatorTitle":[{"text":"DPoPError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a DPoP operation."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError","url":"\/documentation\/auth0\/dpoperror","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/dpoperror/other.json b/docs/data/documentation/auth0/dpoperror/other.json index 1311876fb..686f9e798 100644 --- a/docs/data/documentation/auth0/dpoperror/other.json +++ b/docs/data/documentation/auth0/dpoperror/other.json @@ -1 +1 @@ -{"schemaVersion":{"patch":0,"minor":3,"major":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/dpoperror\/other"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError"]]},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"other","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth09DPoPErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError","text":"DPoPError","kind":"typeIdentifier"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"metadata":{"fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"other","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth09DPoPErrorV","text":"DPoPError","kind":"typeIdentifier"}],"title":"other","role":"symbol","symbolKind":"property","externalID":"s:5Auth09DPoPErrorV5otherACvpZ","modules":[{"name":"Auth0"}],"roleHeading":"Type Property"},"kind":"symbol","abstract":[{"type":"text","text":"An unexpected error occurred, and an "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value is available."},{"type":"text","text":" "},{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"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."}],"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/other"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/DPoPError/other":{"role":"symbol","url":"\/documentation\/auth0\/dpoperror\/other","kind":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"other"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"DPoPError","preciseIdentifier":"s:5Auth09DPoPErrorV"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/other","title":"other","type":"topic","abstract":[{"type":"text","text":"An unexpected error occurred, and an "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value is available."},{"type":"text","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","isActive":true,"type":"reference"},{"text":" property.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError":{"kind":"symbol","abstract":[{"type":"text","text":"Represents an error during a DPoP operation."}],"navigatorTitle":[{"text":"DPoPError","kind":"identifier"}],"title":"DPoPError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"DPoPError","kind":"identifier"}],"url":"\/documentation\/auth0\/dpoperror","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"title":"cause","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","kind":"symbol","abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":"?"}],"role":"symbol","type":"topic"}}} \ No newline at end of file +{"metadata":{"role":"symbol","modules":[{"name":"Auth0"}],"title":"other","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"other","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth09DPoPErrorV","text":"DPoPError","kind":"typeIdentifier"}],"externalID":"s:5Auth09DPoPErrorV5otherACvpZ","roleHeading":"Type Property","symbolKind":"property"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/dpoperror\/other"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/other"},"kind":"symbol","abstract":[{"type":"text","text":"An unexpected error occurred, and an "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value is available."},{"type":"text","text":" "},{"text":"The underlying ","type":"text"},{"code":"Error","type":"codeVoice"},{"text":" value 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"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"other","kind":"identifier"},{"text":": ","kind":"text"},{"text":"DPoPError","preciseIdentifier":"s:5Auth09DPoPErrorV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError"}]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError/other":{"role":"symbol","title":"other","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"other"},{"kind":"text","text":": "},{"text":"DPoPError","preciseIdentifier":"s:5Auth09DPoPErrorV","kind":"typeIdentifier"}],"abstract":[{"type":"text","text":"An unexpected error occurred, and an "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value is available."},{"type":"text","text":" "},{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value can be accessed via the "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true},{"type":"text","text":" property."}],"kind":"symbol","url":"\/documentation\/auth0\/dpoperror\/other","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/other","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError":{"role":"symbol","title":"DPoPError","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"DPoPError","kind":"identifier"}],"navigatorTitle":[{"text":"DPoPError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a DPoP operation."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError","url":"\/documentation\/auth0\/dpoperror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"kind":"symbol","title":"cause","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier","text":"Error"},{"kind":"text","text":"?"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","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":"."}],"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/dpoperror/recoverysuggestion.json b/docs/data/documentation/auth0/dpoperror/recoverysuggestion.json index c1ebf3ec0..5adc21f55 100644 --- a/docs/data/documentation/auth0/dpoperror/recoverysuggestion.json +++ b/docs/data/documentation/auth0/dpoperror/recoverysuggestion.json @@ -1 +1 @@ -{"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"recoverySuggestion","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"? { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}]}],"schemaVersion":{"major":0,"patch":0,"minor":3},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/dpoperror\/recoverysuggestion"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/recoverySuggestion","interfaceLanguage":"swift"},"kind":"symbol","metadata":{"extendedModule":"Foundation","role":"symbol","symbolKind":"property","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"recoverySuggestion","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"platforms":[{"beta":false,"deprecated":false,"name":"iOS","introducedAt":"8.0","unavailable":false},{"beta":false,"deprecated":false,"name":"iPadOS","introducedAt":"8.0","unavailable":false},{"beta":false,"deprecated":false,"name":"Mac Catalyst","introducedAt":"8.0","unavailable":false},{"beta":false,"deprecated":false,"name":"macOS","introducedAt":"10.10","unavailable":false},{"beta":false,"deprecated":false,"name":"tvOS","introducedAt":"9.0","unavailable":false},{"beta":false,"deprecated":false,"name":"watchOS","introducedAt":"2.0","unavailable":false}],"title":"recoverySuggestion","externalID":"s:10Foundation14LocalizedErrorPAAE18recoverySuggestionSSSgvp::SYNTHESIZED::s:5Auth09DPoPErrorV","modules":[{"relatedModules":["Foundation"],"name":"Auth0"}],"roleHeading":"Instance Property"},"abstract":[{"text":"Inherited from ","type":"text"},{"code":"LocalizedError.recoverySuggestion","type":"codeVoice"},{"text":".","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError/recoverySuggestion":{"abstract":[],"title":"recoverySuggestion","kind":"symbol","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"recoverySuggestion","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"url":"\/documentation\/auth0\/dpoperror\/recoverysuggestion","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/recoverySuggestion"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError":{"kind":"symbol","abstract":[{"type":"text","text":"Represents an error during a DPoP operation."}],"navigatorTitle":[{"text":"DPoPError","kind":"identifier"}],"title":"DPoPError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"DPoPError","kind":"identifier"}],"url":"\/documentation\/auth0\/dpoperror","role":"symbol"}}} \ No newline at end of file +{"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"recoverySuggestion"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"? { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}]}],"kind":"declarations"}],"sections":[],"abstract":[{"type":"text","text":"Inherited from "},{"code":"LocalizedError.recoverySuggestion","type":"codeVoice"},{"type":"text","text":"."}],"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/dpoperror\/recoverysuggestion"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"roleHeading":"Instance Property","extendedModule":"Foundation","title":"recoverySuggestion","role":"symbol","symbolKind":"property","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"recoverySuggestion"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"externalID":"s:10Foundation14LocalizedErrorPAAE18recoverySuggestionSSSgvp::SYNTHESIZED::s:5Auth09DPoPErrorV","platforms":[{"deprecated":false,"unavailable":false,"beta":false,"name":"iOS","introducedAt":"8.0"},{"deprecated":false,"unavailable":false,"beta":false,"name":"iPadOS","introducedAt":"8.0"},{"deprecated":false,"unavailable":false,"beta":false,"name":"Mac Catalyst","introducedAt":"8.0"},{"deprecated":false,"unavailable":false,"beta":false,"name":"macOS","introducedAt":"10.10"},{"deprecated":false,"introducedAt":"9.0","unavailable":false,"name":"tvOS","beta":false},{"introducedAt":"2.0","deprecated":false,"unavailable":false,"beta":false,"name":"watchOS"}],"modules":[{"relatedModules":["Foundation"],"name":"Auth0"}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/recoverySuggestion"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/DPoPError":{"role":"symbol","title":"DPoPError","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"DPoPError","kind":"identifier"}],"navigatorTitle":[{"text":"DPoPError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a DPoP operation."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError","url":"\/documentation\/auth0\/dpoperror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError/recoverySuggestion":{"type":"topic","abstract":[],"title":"recoverySuggestion","kind":"symbol","url":"\/documentation\/auth0\/dpoperror\/recoverysuggestion","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"recoverySuggestion"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/recoverySuggestion"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/dpoperror/seckeyoperationfailed.json b/docs/data/documentation/auth0/dpoperror/seckeyoperationfailed.json index 6f8ae7a2f..019e9eff7 100644 --- a/docs/data/documentation/auth0/dpoperror/seckeyoperationfailed.json +++ b/docs/data/documentation/auth0/dpoperror/seckeyoperationfailed.json @@ -1 +1 @@ -{"metadata":{"modules":[{"name":"Auth0"}],"roleHeading":"Type Property","title":"secKeyOperationFailed","role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"secKeyOperationFailed","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth09DPoPErrorV","text":"DPoPError","kind":"typeIdentifier"}],"externalID":"s:5Auth09DPoPErrorV21secKeyOperationFailedACvpZ","symbolKind":"property"},"schemaVersion":{"minor":3,"patch":0,"major":0},"sections":[],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"secKeyOperationFailed"},{"kind":"text","text":": "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError","preciseIdentifier":"s:5Auth09DPoPErrorV","kind":"typeIdentifier","text":"DPoPError"}]}],"kind":"declarations"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/secKeyOperationFailed","interfaceLanguage":"swift"},"variants":[{"paths":["\/documentation\/auth0\/dpoperror\/seckeyoperationfailed"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError"]]},"abstract":[{"type":"text","text":"A SecKey operation failed."},{"type":"text","text":" "},{"type":"text","text":"When available, 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."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"title":"cause","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","kind":"symbol","abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":"?"}],"role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError":{"kind":"symbol","abstract":[{"type":"text","text":"Represents an error during a DPoP operation."}],"navigatorTitle":[{"text":"DPoPError","kind":"identifier"}],"title":"DPoPError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"DPoPError","kind":"identifier"}],"url":"\/documentation\/auth0\/dpoperror","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError/secKeyOperationFailed":{"role":"symbol","abstract":[{"type":"text","text":"A SecKey operation failed."},{"type":"text","text":" "},{"type":"text","text":"When available, the underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value can be accessed via the "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true,"type":"reference"},{"type":"text","text":" property."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/secKeyOperationFailed","type":"topic","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"secKeyOperationFailed","kind":"identifier"},{"text":": ","kind":"text"},{"text":"DPoPError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth09DPoPErrorV"}],"kind":"symbol","url":"\/documentation\/auth0\/dpoperror\/seckeyoperationfailed","title":"secKeyOperationFailed"}}} \ No newline at end of file +{"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"secKeyOperationFailed","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth09DPoPErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError","kind":"typeIdentifier","text":"DPoPError"}],"languages":["swift"],"platforms":["iOS"]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/dpoperror\/seckeyoperationfailed"]}],"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/secKeyOperationFailed"},"abstract":[{"type":"text","text":"A SecKey operation failed."},{"type":"text","text":" "},{"type":"text","text":"When available, 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."}],"metadata":{"roleHeading":"Type Property","symbolKind":"property","role":"symbol","title":"secKeyOperationFailed","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"secKeyOperationFailed","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth09DPoPErrorV","text":"DPoPError","kind":"typeIdentifier"}],"externalID":"s:5Auth09DPoPErrorV21secKeyOperationFailedACvpZ","modules":[{"name":"Auth0"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError/secKeyOperationFailed":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/secKeyOperationFailed","type":"topic","title":"secKeyOperationFailed","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"secKeyOperationFailed"},{"text":": ","kind":"text"},{"text":"DPoPError","preciseIdentifier":"s:5Auth09DPoPErrorV","kind":"typeIdentifier"}],"abstract":[{"type":"text","text":"A SecKey operation failed."},{"type":"text","text":" "},{"type":"text","text":"When available, the underlying "},{"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."}],"url":"\/documentation\/auth0\/dpoperror\/seckeyoperationfailed"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError":{"role":"symbol","title":"DPoPError","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"DPoPError","kind":"identifier"}],"navigatorTitle":[{"text":"DPoPError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a DPoP operation."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError","url":"\/documentation\/auth0\/dpoperror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"kind":"symbol","title":"cause","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier","text":"Error"},{"kind":"text","text":"?"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","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":"."}],"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/dpoperror/secureenclaveoperationfailed.json b/docs/data/documentation/auth0/dpoperror/secureenclaveoperationfailed.json index 9fa8ecefc..0486b778b 100644 --- a/docs/data/documentation/auth0/dpoperror/secureenclaveoperationfailed.json +++ b/docs/data/documentation/auth0/dpoperror/secureenclaveoperationfailed.json @@ -1 +1 @@ -{"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/dpoperror\/secureenclaveoperationfailed"]}],"metadata":{"title":"secureEnclaveOperationFailed","role":"symbol","roleHeading":"Type Property","modules":[{"name":"Auth0"}],"symbolKind":"property","externalID":"s:5Auth09DPoPErrorV28secureEnclaveOperationFailedACvpZ","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"secureEnclaveOperationFailed"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth09DPoPErrorV","kind":"typeIdentifier","text":"DPoPError"}]},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"secureEnclaveOperationFailed"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError","preciseIdentifier":"s:5Auth09DPoPErrorV","text":"DPoPError"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"abstract":[{"text":"A Secure Enclave operation failed.","type":"text"},{"text":" ","type":"text"},{"text":"The underlying ","type":"text"},{"code":"Error","type":"codeVoice"},{"text":" value can be accessed via the ","type":"text"},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},{"text":" property.","type":"text"}],"schemaVersion":{"patch":0,"major":0,"minor":3},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/secureEnclaveOperationFailed","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError":{"kind":"symbol","abstract":[{"type":"text","text":"Represents an error during a DPoP operation."}],"navigatorTitle":[{"text":"DPoPError","kind":"identifier"}],"title":"DPoPError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"DPoPError","kind":"identifier"}],"url":"\/documentation\/auth0\/dpoperror","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"title":"cause","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","kind":"symbol","abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":"?"}],"role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError/secureEnclaveOperationFailed":{"kind":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"secureEnclaveOperationFailed"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"DPoPError","preciseIdentifier":"s:5Auth09DPoPErrorV"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/secureEnclaveOperationFailed","url":"\/documentation\/auth0\/dpoperror\/secureenclaveoperationfailed","title":"secureEnclaveOperationFailed","abstract":[{"text":"A Secure Enclave operation failed.","type":"text"},{"text":" ","type":"text"},{"text":"The underlying ","type":"text"},{"code":"Error","type":"codeVoice"},{"text":" value 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"}],"type":"topic","role":"symbol"}}} \ No newline at end of file +{"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/secureEnclaveOperationFailed"},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"secureEnclaveOperationFailed","kind":"identifier"},{"text":": ","kind":"text"},{"text":"DPoPError","preciseIdentifier":"s:5Auth09DPoPErrorV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError"}],"languages":["swift"],"platforms":["iOS"]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/dpoperror\/secureenclaveoperationfailed"]}],"kind":"symbol","metadata":{"modules":[{"name":"Auth0"}],"externalID":"s:5Auth09DPoPErrorV28secureEnclaveOperationFailedACvpZ","title":"secureEnclaveOperationFailed","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"secureEnclaveOperationFailed","kind":"identifier"},{"text":": ","kind":"text"},{"text":"DPoPError","preciseIdentifier":"s:5Auth09DPoPErrorV","kind":"typeIdentifier"}],"roleHeading":"Type Property","role":"symbol","symbolKind":"property"},"schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"type":"text","text":"A Secure Enclave operation failed."},{"type":"text","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."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"kind":"symbol","title":"cause","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier","text":"Error"},{"kind":"text","text":"?"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","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":"."}],"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError/secureEnclaveOperationFailed":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/secureEnclaveOperationFailed","type":"topic","title":"secureEnclaveOperationFailed","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"secureEnclaveOperationFailed"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth09DPoPErrorV","text":"DPoPError"}],"abstract":[{"type":"text","text":"A Secure Enclave operation failed."},{"type":"text","text":" "},{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value 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\/dpoperror\/secureenclaveoperationfailed"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError":{"role":"symbol","title":"DPoPError","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"DPoPError","kind":"identifier"}],"navigatorTitle":[{"text":"DPoPError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a DPoP operation."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError","url":"\/documentation\/auth0\/dpoperror","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/dpoperror/unknown.json b/docs/data/documentation/auth0/dpoperror/unknown.json index 60679743b..1ee945ba7 100644 --- a/docs/data/documentation/auth0/dpoperror/unknown.json +++ b/docs/data/documentation/auth0/dpoperror/unknown.json @@ -1 +1 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/unknown","interfaceLanguage":"swift"},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError"]]},"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"unknown"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"DPoPError","preciseIdentifier":"s:5Auth09DPoPErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError"}],"platforms":["iOS"],"languages":["swift"]}]}],"schemaVersion":{"patch":0,"minor":3,"major":0},"variants":[{"paths":["\/documentation\/auth0\/dpoperror\/unknown"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"title":"unknown","externalID":"s:5Auth09DPoPErrorV7unknownACvpZ","symbolKind":"property","role":"symbol","modules":[{"name":"Auth0"}],"roleHeading":"Type Property","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"unknown"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth09DPoPErrorV","kind":"typeIdentifier","text":"DPoPError"}]},"abstract":[{"text":"An unexpected error occurred, but an ","type":"text"},{"code":"Error","type":"codeVoice"},{"text":" value is not available.","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"},{"text":".","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError":{"kind":"symbol","abstract":[{"type":"text","text":"Represents an error during a DPoP operation."}],"navigatorTitle":[{"text":"DPoPError","kind":"identifier"}],"title":"DPoPError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"DPoPError","kind":"identifier"}],"url":"\/documentation\/auth0\/dpoperror","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError/unknown":{"abstract":[{"type":"text","text":"An unexpected error occurred, but an "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value is not available."},{"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":"."}],"fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"unknown"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"DPoPError","preciseIdentifier":"s:5Auth09DPoPErrorV"}],"kind":"symbol","url":"\/documentation\/auth0\/dpoperror\/unknown","title":"unknown","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/unknown","type":"topic","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"title":"cause","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","kind":"symbol","abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":"?"}],"role":"symbol","type":"topic"}}} \ No newline at end of file +{"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/unknown","interfaceLanguage":"swift"},"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"unknown","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth09DPoPErrorV","text":"DPoPError","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError"}],"platforms":["iOS"]}],"kind":"declarations"}],"variants":[{"paths":["\/documentation\/auth0\/dpoperror\/unknown"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","metadata":{"modules":[{"name":"Auth0"}],"title":"unknown","externalID":"s:5Auth09DPoPErrorV7unknownACvpZ","role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"unknown","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth09DPoPErrorV","text":"DPoPError","kind":"typeIdentifier"}],"symbolKind":"property","roleHeading":"Type Property"},"schemaVersion":{"minor":3,"patch":0,"major":0},"abstract":[{"text":"An unexpected error occurred, but an ","type":"text"},{"code":"Error","type":"codeVoice"},{"text":" value is not available.","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"},{"text":".","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"kind":"symbol","title":"cause","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier","text":"Error"},{"kind":"text","text":"?"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","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":"."}],"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError":{"role":"symbol","title":"DPoPError","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"DPoPError","kind":"identifier"}],"navigatorTitle":[{"text":"DPoPError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a DPoP operation."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError","url":"\/documentation\/auth0\/dpoperror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError/unknown":{"role":"symbol","title":"unknown","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"unknown"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth09DPoPErrorV","text":"DPoPError","kind":"typeIdentifier"}],"abstract":[{"type":"text","text":"An unexpected error occurred, but an "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value is not available."},{"type":"text","text":" "},{"type":"text","text":"This error does not include a "},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},{"type":"text","text":"."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/unknown","url":"\/documentation\/auth0\/dpoperror\/unknown","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/dpoperror/~=(_:_:)-2g6ss.json b/docs/data/documentation/auth0/dpoperror/~=(_:_:)-2g6ss.json index 2cd0932ec..d8eedf3cd 100644 --- a/docs/data/documentation/auth0/dpoperror/~=(_:_:)-2g6ss.json +++ b/docs/data/documentation/auth0/dpoperror/~=(_:_:)-2g6ss.json @@ -1 +1 @@ -{"sections":[],"metadata":{"role":"symbol","externalID":"s:5Auth09DPoPErrorV2teoiySbAC_s5Error_ptFZ","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"~=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"DPoPError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth09DPoPErrorV"},{"text":", ","kind":"text"},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"roleHeading":"Operator","extendedModule":"Auth0","symbolKind":"op","title":"~=(_:_:)","modules":[{"name":"Auth0"}]},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"~="},{"kind":"text","text":" "},{"kind":"text","text":"("},{"kind":"internalParam","text":"lhs"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth09DPoPErrorV","text":"DPoPError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError"},{"kind":"text","text":", "},{"kind":"internalParam","text":"rhs"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP","text":"Error"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}]}],"kind":"declarations"}],"variants":[{"paths":["\/documentation\/auth0\/dpoperror\/~=(_:_:)-2g6ss"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/~=(_:_:)-2g6ss"},"abstract":[{"text":"Matches ","type":"text"},{"code":"Error","type":"codeVoice"},{"text":" values in a switch statement.","type":"text"}],"schemaVersion":{"major":0,"patch":0,"minor":3},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError"]]},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/DPoPError":{"kind":"symbol","abstract":[{"type":"text","text":"Represents an error during a DPoP operation."}],"navigatorTitle":[{"text":"DPoPError","kind":"identifier"}],"title":"DPoPError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"DPoPError","kind":"identifier"}],"url":"\/documentation\/auth0\/dpoperror","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError/~=(_:_:)-2g6ss":{"url":"\/documentation\/auth0\/dpoperror\/~=(_:_:)-2g6ss","kind":"symbol","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","text":"DPoPError","preciseIdentifier":"s:5Auth09DPoPErrorV"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"abstract":[{"type":"text","text":"Matches "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" values in a switch statement."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/~=(_:_:)-2g6ss","type":"topic","title":"~=(_:_:)","role":"symbol"}}} \ No newline at end of file +{"sections":[],"kind":"symbol","metadata":{"modules":[{"name":"Auth0"}],"externalID":"s:5Auth09DPoPErrorV2teoiySbAC_s5Error_ptFZ","title":"~=(_:_:)","extendedModule":"Auth0","roleHeading":"Operator","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"~=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:5Auth09DPoPErrorV","text":"DPoPError","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:s5ErrorP","text":"Error","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"role":"symbol","symbolKind":"op"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/~=(_:_:)-2g6ss"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/dpoperror\/~=(_:_:)-2g6ss"]}],"schemaVersion":{"major":0,"patch":0,"minor":3},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError"]]},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"~="},{"kind":"text","text":" "},{"kind":"text","text":"("},{"kind":"internalParam","text":"lhs"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"DPoPError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError","preciseIdentifier":"s:5Auth09DPoPErrorV"},{"kind":"text","text":", "},{"kind":"internalParam","text":"rhs"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"abstract":[{"type":"text","text":"Matches "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" values in a switch statement."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError/~=(_:_:)-2g6ss":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/~=(_:_:)-2g6ss","type":"topic","title":"~=(_:_:)","role":"symbol","kind":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"~=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"DPoPError","preciseIdentifier":"s:5Auth09DPoPErrorV","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP","text":"Error"},{"text":") -> ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"abstract":[{"type":"text","text":"Matches "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" values in a switch statement."}],"url":"\/documentation\/auth0\/dpoperror\/~=(_:_:)-2g6ss"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError":{"role":"symbol","title":"DPoPError","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"DPoPError","kind":"identifier"}],"navigatorTitle":[{"text":"DPoPError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a DPoP operation."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError","url":"\/documentation\/auth0\/dpoperror","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/dpoperror/~=(_:_:)-8r7xi.json b/docs/data/documentation/auth0/dpoperror/~=(_:_:)-8r7xi.json index 59768d25f..bc2be7a7d 100644 --- a/docs/data/documentation/auth0/dpoperror/~=(_:_:)-8r7xi.json +++ b/docs/data/documentation/auth0/dpoperror/~=(_:_:)-8r7xi.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError"]]},"variants":[{"paths":["\/documentation\/auth0\/dpoperror\/~=(_:_:)-8r7xi"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"externalID":"s:5Auth09DPoPErrorV2teoiySbAC_ACtFZ","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"~=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"DPoPError","preciseIdentifier":"s:5Auth09DPoPErrorV","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"DPoPError","preciseIdentifier":"s:5Auth09DPoPErrorV","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"title":"~=(_:_:)","extendedModule":"Auth0","roleHeading":"Operator","role":"symbol","symbolKind":"op","modules":[{"name":"Auth0"}]},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"~="},{"kind":"text","text":" "},{"kind":"text","text":"("},{"kind":"internalParam","text":"lhs"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth09DPoPErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError","text":"DPoPError"},{"kind":"text","text":", "},{"kind":"internalParam","text":"rhs"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth09DPoPErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError","text":"DPoPError"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}]}],"kind":"declarations"}],"kind":"symbol","schemaVersion":{"minor":3,"patch":0,"major":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/~=(_:_:)-8r7xi"},"sections":[],"abstract":[{"text":"Matches ","type":"text"},{"code":"DPoPError","type":"codeVoice"},{"text":" values in a switch statement.","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/DPoPError/~=(_:_:)-8r7xi":{"abstract":[{"type":"text","text":"Matches "},{"type":"codeVoice","code":"DPoPError"},{"type":"text","text":" values in a switch statement."}],"url":"\/documentation\/auth0\/dpoperror\/~=(_:_:)-8r7xi","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:5Auth09DPoPErrorV","text":"DPoPError"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth09DPoPErrorV","text":"DPoPError"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"title":"~=(_:_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/~=(_:_:)-8r7xi","kind":"symbol","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError":{"kind":"symbol","abstract":[{"type":"text","text":"Represents an error during a DPoP operation."}],"navigatorTitle":[{"text":"DPoPError","kind":"identifier"}],"title":"DPoPError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"DPoPError","kind":"identifier"}],"url":"\/documentation\/auth0\/dpoperror","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"metadata":{"symbolKind":"op","roleHeading":"Operator","externalID":"s:5Auth09DPoPErrorV2teoiySbAC_ACtFZ","extendedModule":"Auth0","title":"~=(_:_:)","modules":[{"name":"Auth0"}],"fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"~=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:5Auth09DPoPErrorV","text":"DPoPError","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth09DPoPErrorV","text":"DPoPError","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"role":"symbol"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/dpoperror\/~=(_:_:)-8r7xi"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/~=(_:_:)-8r7xi"},"kind":"symbol","abstract":[{"type":"text","text":"Matches "},{"type":"codeVoice","code":"DPoPError"},{"type":"text","text":" values in a switch statement."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"~=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"lhs","kind":"internalParam"},{"text":": ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError","preciseIdentifier":"s:5Auth09DPoPErrorV","text":"DPoPError","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"rhs","kind":"internalParam"},{"text":": ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError","preciseIdentifier":"s:5Auth09DPoPErrorV","text":"DPoPError","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"languages":["swift"],"platforms":["iOS"]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError":{"role":"symbol","title":"DPoPError","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"DPoPError","kind":"identifier"}],"navigatorTitle":[{"text":"DPoPError","kind":"identifier"}],"abstract":[{"type":"text","text":"Represents an error during a DPoP operation."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError","url":"\/documentation\/auth0\/dpoperror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/DPoPError/~=(_:_:)-8r7xi":{"url":"\/documentation\/auth0\/dpoperror\/~=(_:_:)-8r7xi","abstract":[{"text":"Matches ","type":"text"},{"code":"DPoPError","type":"codeVoice"},{"text":" values in a switch statement.","type":"text"}],"title":"~=(_:_:)","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","preciseIdentifier":"s:5Auth09DPoPErrorV","text":"DPoPError"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth09DPoPErrorV","text":"DPoPError"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoPError\/~=(_:_:)-8r7xi","role":"symbol","kind":"symbol","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/emailenrollmentchallenge.json b/docs/data/documentation/auth0/emailenrollmentchallenge.json index b566fa71f..b34db698b 100644 --- a/docs/data/documentation/auth0/emailenrollmentchallenge.json +++ b/docs/data/documentation/auth0/emailenrollmentchallenge.json @@ -1 +1 @@ -{"abstract":[{"text":"A Email enrollment challenge.","type":"text"}],"schemaVersion":{"patch":0,"major":0,"minor":3},"variants":[{"paths":["\/documentation\/auth0\/emailenrollmentchallenge"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"metadata":{"role":"symbol","externalID":"s:5Auth024EmailEnrollmentChallengeV","title":"EmailEnrollmentChallenge","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"EmailEnrollmentChallenge"}],"navigatorTitle":[{"kind":"identifier","text":"EmailEnrollmentChallenge"}],"roleHeading":"Structure","modules":[{"name":"Auth0"}],"symbolKind":"struct"},"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/EmailEnrollmentChallenge\/authenticationId","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/EmailEnrollmentChallenge\/authenticationSession"],"title":"Instance Properties","generated":true,"anchor":"Instance-Properties"},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/EmailEnrollmentChallenge\/Decodable-Implementations"],"title":"Default Implementations","generated":true,"anchor":"Default-Implementations"}],"relationshipsSections":[{"kind":"relationships","identifiers":["doc:\/\/com.auth0.Auth0\/s8CopyableP","doc:\/\/com.auth0.Auth0\/Se"],"title":"Conforms To","type":"conformsTo"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/EmailEnrollmentChallenge","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"EmailEnrollmentChallenge","kind":"identifier"}]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/EmailEnrollmentChallenge/authenticationSession":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/EmailEnrollmentChallenge\/authenticationSession","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticationSession"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"title":"authenticationSession","role":"symbol","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/emailenrollmentchallenge\/authenticationsession","abstract":[{"text":"The unique session identifier for the enrollment.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/EmailEnrollmentChallenge":{"title":"EmailEnrollmentChallenge","navigatorTitle":[{"text":"EmailEnrollmentChallenge","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/EmailEnrollmentChallenge","role":"symbol","abstract":[{"text":"A Email enrollment challenge.","type":"text"}],"type":"topic","url":"\/documentation\/auth0\/emailenrollmentchallenge","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"EmailEnrollmentChallenge","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/EmailEnrollmentChallenge/Decodable-Implementations":{"abstract":[],"title":"Decodable Implementations","kind":"article","role":"collectionGroup","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/EmailEnrollmentChallenge\/Decodable-Implementations","url":"\/documentation\/auth0\/emailenrollmentchallenge\/decodable-implementations","type":"topic"},"doc://com.auth0.Auth0/s8CopyableP":{"title":"Swift.Copyable","identifier":"doc:\/\/com.auth0.Auth0\/s8CopyableP","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/EmailEnrollmentChallenge/authenticationId":{"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authenticationId","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"title":"authenticationId","role":"symbol","type":"topic","abstract":[{"type":"text","text":"The unique identifier for the authentication method."}],"kind":"symbol","url":"\/documentation\/auth0\/emailenrollmentchallenge\/authenticationid","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/EmailEnrollmentChallenge\/authenticationId"},"doc://com.auth0.Auth0/Se":{"title":"Swift.Decodable","identifier":"doc:\/\/com.auth0.Auth0\/Se","type":"unresolvable"}}} \ No newline at end of file +{"metadata":{"symbolKind":"struct","roleHeading":"Structure","title":"EmailEnrollmentChallenge","externalID":"s:5Auth024EmailEnrollmentChallengeV","modules":[{"name":"Auth0"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"EmailEnrollmentChallenge","kind":"identifier"}],"role":"symbol","navigatorTitle":[{"text":"EmailEnrollmentChallenge","kind":"identifier"}]},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/emailenrollmentchallenge"]}],"relationshipsSections":[{"title":"Conforms To","identifiers":["doc:\/\/com.auth0.Auth0\/s8CopyableP","doc:\/\/com.auth0.Auth0\/Se"],"type":"conformsTo","kind":"relationships"}],"topicSections":[{"title":"Instance Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/EmailEnrollmentChallenge\/authenticationId","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/EmailEnrollmentChallenge\/authenticationSession"],"anchor":"Instance-Properties","generated":true},{"title":"Default Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/EmailEnrollmentChallenge\/Decodable-Implementations"],"anchor":"Default-Implementations","generated":true}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/EmailEnrollmentChallenge"},"kind":"symbol","abstract":[{"type":"text","text":"A Email enrollment challenge."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"EmailEnrollmentChallenge","kind":"identifier"}],"languages":["swift"],"platforms":["iOS"]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/Se":{"title":"Swift.Decodable","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/Se"},"doc://com.auth0.Auth0/s8CopyableP":{"title":"Swift.Copyable","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s8CopyableP"},"doc://com.auth0.Auth0/documentation/Auth0/EmailEnrollmentChallenge/authenticationId":{"type":"topic","title":"authenticationId","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/EmailEnrollmentChallenge\/authenticationId","url":"\/documentation\/auth0\/emailenrollmentchallenge\/authenticationid","abstract":[{"type":"text","text":"The unique identifier for the authentication method."}],"kind":"symbol","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authenticationId","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}]},"doc://com.auth0.Auth0/documentation/Auth0/EmailEnrollmentChallenge/authenticationSession":{"url":"\/documentation\/auth0\/emailenrollmentchallenge\/authenticationsession","abstract":[{"type":"text","text":"The unique session identifier for the enrollment."}],"title":"authenticationSession","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authenticationSession","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/EmailEnrollmentChallenge\/authenticationSession","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/EmailEnrollmentChallenge/Decodable-Implementations":{"role":"collectionGroup","title":"Decodable Implementations","abstract":[],"kind":"article","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/EmailEnrollmentChallenge\/Decodable-Implementations","url":"\/documentation\/auth0\/emailenrollmentchallenge\/decodable-implementations","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/EmailEnrollmentChallenge":{"title":"EmailEnrollmentChallenge","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/EmailEnrollmentChallenge","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"EmailEnrollmentChallenge"}],"abstract":[{"text":"A Email enrollment challenge.","type":"text"}],"url":"\/documentation\/auth0\/emailenrollmentchallenge","navigatorTitle":[{"kind":"identifier","text":"EmailEnrollmentChallenge"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/emailenrollmentchallenge/authenticationid.json b/docs/data/documentation/auth0/emailenrollmentchallenge/authenticationid.json index c6591cd76..6ed9dcb49 100644 --- a/docs/data/documentation/auth0/emailenrollmentchallenge/authenticationid.json +++ b/docs/data/documentation/auth0/emailenrollmentchallenge/authenticationid.json @@ -1 +1 @@ -{"metadata":{"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authenticationId","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"symbolKind":"property","roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"title":"authenticationId","role":"symbol","externalID":"s:5Auth024EmailEnrollmentChallengeV16authenticationIdSSvp"},"variants":[{"paths":["\/documentation\/auth0\/emailenrollmentchallenge\/authenticationid"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticationId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"platforms":["iOS"]}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/EmailEnrollmentChallenge\/authenticationId"},"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","abstract":[{"type":"text","text":"The unique identifier for the authentication method."}],"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/EmailEnrollmentChallenge"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/EmailEnrollmentChallenge":{"title":"EmailEnrollmentChallenge","navigatorTitle":[{"text":"EmailEnrollmentChallenge","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/EmailEnrollmentChallenge","role":"symbol","abstract":[{"text":"A Email enrollment challenge.","type":"text"}],"type":"topic","url":"\/documentation\/auth0\/emailenrollmentchallenge","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"EmailEnrollmentChallenge","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/EmailEnrollmentChallenge/authenticationId":{"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authenticationId","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"title":"authenticationId","role":"symbol","type":"topic","abstract":[{"type":"text","text":"The unique identifier for the authentication method."}],"kind":"symbol","url":"\/documentation\/auth0\/emailenrollmentchallenge\/authenticationid","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/EmailEnrollmentChallenge\/authenticationId"}}} \ No newline at end of file +{"metadata":{"symbolKind":"property","modules":[{"name":"Auth0"}],"title":"authenticationId","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authenticationId","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"externalID":"s:5Auth024EmailEnrollmentChallengeV16authenticationIdSSvp","role":"symbol","roleHeading":"Instance Property"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/emailenrollmentchallenge\/authenticationid"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/EmailEnrollmentChallenge\/authenticationId","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"type":"text","text":"The unique identifier for the authentication method."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/EmailEnrollmentChallenge"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticationId"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"languages":["swift"],"platforms":["iOS"]}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/EmailEnrollmentChallenge/authenticationId":{"type":"topic","title":"authenticationId","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/EmailEnrollmentChallenge\/authenticationId","url":"\/documentation\/auth0\/emailenrollmentchallenge\/authenticationid","abstract":[{"type":"text","text":"The unique identifier for the authentication method."}],"kind":"symbol","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authenticationId","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}]},"doc://com.auth0.Auth0/documentation/Auth0/EmailEnrollmentChallenge":{"title":"EmailEnrollmentChallenge","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/EmailEnrollmentChallenge","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"EmailEnrollmentChallenge"}],"abstract":[{"text":"A Email enrollment challenge.","type":"text"}],"url":"\/documentation\/auth0\/emailenrollmentchallenge","navigatorTitle":[{"kind":"identifier","text":"EmailEnrollmentChallenge"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/emailenrollmentchallenge/authenticationsession.json b/docs/data/documentation/auth0/emailenrollmentchallenge/authenticationsession.json index 5c17288d3..3bc252c51 100644 --- a/docs/data/documentation/auth0/emailenrollmentchallenge/authenticationsession.json +++ b/docs/data/documentation/auth0/emailenrollmentchallenge/authenticationsession.json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticationSession"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"platforms":["iOS"],"languages":["swift"]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/EmailEnrollmentChallenge"]]},"abstract":[{"type":"text","text":"The unique session identifier for the enrollment."}],"variants":[{"paths":["\/documentation\/auth0\/emailenrollmentchallenge\/authenticationsession"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authenticationSession","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"roleHeading":"Instance Property","role":"symbol","externalID":"s:5Auth024EmailEnrollmentChallengeV21authenticationSessionSSvp","symbolKind":"property","modules":[{"name":"Auth0"}],"title":"authenticationSession"},"kind":"symbol","sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/EmailEnrollmentChallenge\/authenticationSession","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/EmailEnrollmentChallenge/authenticationSession":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/EmailEnrollmentChallenge\/authenticationSession","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticationSession"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"title":"authenticationSession","role":"symbol","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/emailenrollmentchallenge\/authenticationsession","abstract":[{"text":"The unique session identifier for the enrollment.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/EmailEnrollmentChallenge":{"title":"EmailEnrollmentChallenge","navigatorTitle":[{"text":"EmailEnrollmentChallenge","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/EmailEnrollmentChallenge","role":"symbol","abstract":[{"text":"A Email enrollment challenge.","type":"text"}],"type":"topic","url":"\/documentation\/auth0\/emailenrollmentchallenge","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"EmailEnrollmentChallenge","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/EmailEnrollmentChallenge"]]},"metadata":{"symbolKind":"property","modules":[{"name":"Auth0"}],"title":"authenticationSession","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authenticationSession","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"externalID":"s:5Auth024EmailEnrollmentChallengeV21authenticationSessionSSvp","role":"symbol","roleHeading":"Instance Property"},"sections":[],"abstract":[{"text":"The unique session identifier for the enrollment.","type":"text"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/emailenrollmentchallenge\/authenticationsession"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/EmailEnrollmentChallenge\/authenticationSession","interfaceLanguage":"swift"},"kind":"symbol","schemaVersion":{"major":0,"patch":0,"minor":3},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authenticationSession","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/EmailEnrollmentChallenge":{"title":"EmailEnrollmentChallenge","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/EmailEnrollmentChallenge","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"EmailEnrollmentChallenge"}],"abstract":[{"text":"A Email enrollment challenge.","type":"text"}],"url":"\/documentation\/auth0\/emailenrollmentchallenge","navigatorTitle":[{"kind":"identifier","text":"EmailEnrollmentChallenge"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/EmailEnrollmentChallenge/authenticationSession":{"url":"\/documentation\/auth0\/emailenrollmentchallenge\/authenticationsession","abstract":[{"type":"text","text":"The unique session identifier for the enrollment."}],"title":"authenticationSession","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authenticationSession","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/EmailEnrollmentChallenge\/authenticationSession","role":"symbol","kind":"symbol","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/emailenrollmentchallenge/decodable-implementations.json b/docs/data/documentation/auth0/emailenrollmentchallenge/decodable-implementations.json index 6b7f652b6..054ffcb30 100644 --- a/docs/data/documentation/auth0/emailenrollmentchallenge/decodable-implementations.json +++ b/docs/data/documentation/auth0/emailenrollmentchallenge/decodable-implementations.json @@ -1 +1 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/EmailEnrollmentChallenge\/Decodable-Implementations","interfaceLanguage":"swift"},"sections":[],"variants":[{"paths":["\/documentation\/auth0\/emailenrollmentchallenge\/decodable-implementations"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"roleHeading":"API Collection","title":"Decodable Implementations","modules":[{"name":"Auth0"}],"role":"collectionGroup"},"schemaVersion":{"major":0,"patch":0,"minor":3},"kind":"article","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/EmailEnrollmentChallenge"]]},"topicSections":[{"title":"Initializers","generated":true,"anchor":"Initializers","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/EmailEnrollmentChallenge\/init(from:)"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/EmailEnrollmentChallenge":{"title":"EmailEnrollmentChallenge","navigatorTitle":[{"text":"EmailEnrollmentChallenge","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/EmailEnrollmentChallenge","role":"symbol","abstract":[{"text":"A Email enrollment challenge.","type":"text"}],"type":"topic","url":"\/documentation\/auth0\/emailenrollmentchallenge","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"EmailEnrollmentChallenge","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/EmailEnrollmentChallenge/init(from:)":{"type":"topic","role":"symbol","url":"\/documentation\/auth0\/emailenrollmentchallenge\/init(from:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/EmailEnrollmentChallenge\/init(from:)","title":"init(from:)","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Decoder","kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"kind":"symbol","abstract":[{"code":"Decodable","type":"codeVoice"},{"text":" initializer.","type":"text"}]}}} \ No newline at end of file +{"kind":"article","topicSections":[{"title":"Initializers","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/EmailEnrollmentChallenge\/init(from:)"],"anchor":"Initializers","generated":true}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/emailenrollmentchallenge\/decodable-implementations"]}],"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/EmailEnrollmentChallenge"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/EmailEnrollmentChallenge\/Decodable-Implementations","interfaceLanguage":"swift"},"metadata":{"modules":[{"name":"Auth0"}],"role":"collectionGroup","title":"Decodable Implementations","roleHeading":"API Collection"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/EmailEnrollmentChallenge":{"title":"EmailEnrollmentChallenge","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/EmailEnrollmentChallenge","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"EmailEnrollmentChallenge"}],"abstract":[{"text":"A Email enrollment challenge.","type":"text"}],"url":"\/documentation\/auth0\/emailenrollmentchallenge","navigatorTitle":[{"kind":"identifier","text":"EmailEnrollmentChallenge"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/EmailEnrollmentChallenge/init(from:)":{"role":"symbol","title":"init(from:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier","text":"Decoder"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"abstract":[{"code":"Decodable","type":"codeVoice"},{"type":"text","text":" initializer."}],"kind":"symbol","url":"\/documentation\/auth0\/emailenrollmentchallenge\/init(from:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/EmailEnrollmentChallenge\/init(from:)","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/emailenrollmentchallenge/init(from:).json b/docs/data/documentation/auth0/emailenrollmentchallenge/init(from:).json index 8d4ff0de3..87cdd5f2a 100644 --- a/docs/data/documentation/auth0/emailenrollmentchallenge/init(from:).json +++ b/docs/data/documentation/auth0/emailenrollmentchallenge/init(from:).json @@ -1 +1 @@ -{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/emailenrollmentchallenge\/init(from:)"]}],"sections":[],"abstract":[{"type":"codeVoice","code":"Decodable"},{"type":"text","text":" initializer."}],"metadata":{"role":"symbol","title":"init(from:)","extendedModule":"Auth0","roleHeading":"Initializer","externalID":"s:5Auth024EmailEnrollmentChallengeV4fromACs7Decoder_p_tKcfc","modules":[{"name":"Auth0"}],"symbolKind":"init","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP","text":"Decoder"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}]},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":" "},{"kind":"internalParam","text":"decoder"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier","text":"Decoder"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}]}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/EmailEnrollmentChallenge\/init(from:)","interfaceLanguage":"swift"},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/EmailEnrollmentChallenge"]]},"schemaVersion":{"major":0,"patch":0,"minor":3},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/EmailEnrollmentChallenge":{"title":"EmailEnrollmentChallenge","navigatorTitle":[{"text":"EmailEnrollmentChallenge","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/EmailEnrollmentChallenge","role":"symbol","abstract":[{"text":"A Email enrollment challenge.","type":"text"}],"type":"topic","url":"\/documentation\/auth0\/emailenrollmentchallenge","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"EmailEnrollmentChallenge","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/EmailEnrollmentChallenge/init(from:)":{"type":"topic","role":"symbol","url":"\/documentation\/auth0\/emailenrollmentchallenge\/init(from:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/EmailEnrollmentChallenge\/init(from:)","title":"init(from:)","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Decoder","kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"kind":"symbol","abstract":[{"code":"Decodable","type":"codeVoice"},{"text":" initializer.","type":"text"}]}}} \ No newline at end of file +{"metadata":{"symbolKind":"init","title":"init(from:)","roleHeading":"Initializer","extendedModule":"Auth0","externalID":"s:5Auth024EmailEnrollmentChallengeV4fromACs7Decoder_p_tKcfc","modules":[{"name":"Auth0"}],"fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Decoder","preciseIdentifier":"s:s7DecoderP"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"role":"symbol"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/emailenrollmentchallenge\/init(from:)"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/EmailEnrollmentChallenge\/init(from:)","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"code":"Decodable","type":"codeVoice"},{"type":"text","text":" initializer."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/EmailEnrollmentChallenge"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"init","kind":"keyword"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"decoder","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"Decoder","preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/EmailEnrollmentChallenge":{"title":"EmailEnrollmentChallenge","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/EmailEnrollmentChallenge","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"EmailEnrollmentChallenge"}],"abstract":[{"text":"A Email enrollment challenge.","type":"text"}],"url":"\/documentation\/auth0\/emailenrollmentchallenge","navigatorTitle":[{"kind":"identifier","text":"EmailEnrollmentChallenge"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/EmailEnrollmentChallenge/init(from:)":{"role":"symbol","title":"init(from:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier","text":"Decoder"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"abstract":[{"code":"Decodable","type":"codeVoice"},{"type":"text","text":" initializer."}],"kind":"symbol","url":"\/documentation\/auth0\/emailenrollmentchallenge\/init(from:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/EmailEnrollmentChallenge\/init(from:)","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/factor.json b/docs/data/documentation/auth0/factor.json index cdc29f90d..d9fb24005 100644 --- a/docs/data/documentation/auth0/factor.json +++ b/docs/data/documentation/auth0/factor.json @@ -1 +1 @@ -{"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factor","interfaceLanguage":"swift"},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factor\/init(from:)"],"title":"Initializers","generated":true,"anchor":"Initializers"},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factor\/type","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factor\/usage"],"title":"Instance Properties","generated":true,"anchor":"Instance-Properties"}],"relationshipsSections":[{"kind":"relationships","title":"Conforms To","identifiers":["doc:\/\/com.auth0.Auth0\/Se"],"type":"conformsTo"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Factor","kind":"identifier"}],"platforms":["iOS"],"languages":["swift"]}]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"metadata":{"title":"Factor","roleHeading":"Structure","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Factor","kind":"identifier"}],"symbolKind":"struct","externalID":"s:5Auth06FactorV","navigatorTitle":[{"text":"Factor","kind":"identifier"}],"modules":[{"name":"Auth0"}],"role":"symbol"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/factor"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Factor/usage":{"type":"topic","title":"usage","url":"\/documentation\/auth0\/factor\/usage","abstract":[{"type":"text","text":"Primary and\/or secondary factor"}],"role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"usage"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"]?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factor\/usage","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Factor":{"url":"\/documentation\/auth0\/factor","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factor","kind":"symbol","abstract":[],"type":"topic","title":"Factor","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Factor"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Factor"}]},"doc://com.auth0.Auth0/documentation/Auth0/Factor/init(from:)":{"url":"\/documentation\/auth0\/factor\/init(from:)","title":"init(from:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": any "},{"kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP","text":"Decoder"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"kind":"symbol","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factor\/init(from:)","type":"topic","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Factor/type":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factor\/type","abstract":[{"type":"text","text":"Authentication method type (factor)"}],"kind":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"type"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"url":"\/documentation\/auth0\/factor\/type","title":"type"},"doc://com.auth0.Auth0/Se":{"title":"Swift.Decodable","identifier":"doc:\/\/com.auth0.Auth0\/Se","type":"unresolvable"}}} \ No newline at end of file +{"metadata":{"role":"symbol","modules":[{"name":"Auth0"}],"title":"Factor","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Factor"}],"externalID":"s:5Auth06FactorV","navigatorTitle":[{"kind":"identifier","text":"Factor"}],"roleHeading":"Structure","symbolKind":"struct"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/factor"]}],"relationshipsSections":[{"type":"conformsTo","title":"Conforms To","identifiers":["doc:\/\/com.auth0.Auth0\/Se"],"kind":"relationships"}],"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factor\/init(from:)"],"generated":true,"anchor":"Initializers","title":"Initializers"},{"anchor":"Instance-Properties","generated":true,"title":"Instance Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factor\/type","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factor\/usage"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factor"},"kind":"symbol","primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Factor"}],"platforms":["iOS"]}],"kind":"declarations"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"schemaVersion":{"patch":0,"minor":3,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Factor":{"title":"Factor","role":"symbol","navigatorTitle":[{"text":"Factor","kind":"identifier"}],"kind":"symbol","abstract":[],"url":"\/documentation\/auth0\/factor","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factor","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Factor"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Factor/type":{"type":"topic","title":"type","url":"\/documentation\/auth0\/factor\/type","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factor\/type","abstract":[{"text":"Authentication method type (factor)","type":"text"}],"kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"type"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}]},"doc://com.auth0.Auth0/documentation/Auth0/Factor/init(from:)":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factor\/init(from:)","title":"init(from:)","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"kind":"text","text":": any "},{"kind":"typeIdentifier","text":"Decoder","preciseIdentifier":"s:s7DecoderP"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"role":"symbol","url":"\/documentation\/auth0\/factor\/init(from:)","abstract":[],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Factor/usage":{"type":"topic","title":"usage","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factor\/usage","kind":"symbol","abstract":[{"text":"Primary and\/or secondary factor","type":"text"}],"url":"\/documentation\/auth0\/factor\/usage","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"usage"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"]?"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","type":"topic"},"doc://com.auth0.Auth0/Se":{"title":"Swift.Decodable","identifier":"doc:\/\/com.auth0.Auth0\/Se","type":"unresolvable"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/factor/init(from:).json b/docs/data/documentation/auth0/factor/init(from:).json index b91e4dc37..e15300d49 100644 --- a/docs/data/documentation/auth0/factor/init(from:).json +++ b/docs/data/documentation/auth0/factor/init(from:).json @@ -1 +1 @@ -{"schemaVersion":{"patch":0,"minor":3,"major":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"init","kind":"keyword"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"decoder","kind":"internalParam"},{"text":": any ","kind":"text"},{"text":"Decoder","kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"languages":["swift"],"platforms":["iOS"]}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factor\/init(from:)","interfaceLanguage":"swift"},"sections":[],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factor"]]},"metadata":{"symbolKind":"init","modules":[{"name":"Auth0"}],"roleHeading":"Initializer","role":"symbol","title":"init(from:)","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":": any ","kind":"text"},{"preciseIdentifier":"s:s7DecoderP","text":"Decoder","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"externalID":"s:5Auth06FactorV4fromACs7Decoder_p_tKcfc"},"abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"Decodable.init(from:)"},{"type":"text","text":"."}],"variants":[{"paths":["\/documentation\/auth0\/factor\/init(from:)"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Factor":{"url":"\/documentation\/auth0\/factor","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factor","kind":"symbol","abstract":[],"type":"topic","title":"Factor","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Factor"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Factor"}]},"doc://com.auth0.Auth0/documentation/Auth0/Factor/init(from:)":{"url":"\/documentation\/auth0\/factor\/init(from:)","title":"init(from:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": any "},{"kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP","text":"Decoder"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"kind":"symbol","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factor\/init(from:)","type":"topic","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"init","kind":"keyword"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"from"},{"kind":"text","text":" "},{"kind":"internalParam","text":"decoder"},{"kind":"text","text":": any "},{"kind":"typeIdentifier","text":"Decoder","preciseIdentifier":"s:s7DecoderP"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"languages":["swift"],"platforms":["iOS"]}]}],"variants":[{"paths":["\/documentation\/auth0\/factor\/init(from:)"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factor"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factor\/init(from:)","interfaceLanguage":"swift"},"abstract":[{"text":"Inherited from ","type":"text"},{"type":"codeVoice","code":"Decodable.init(from:)"},{"type":"text","text":"."}],"metadata":{"modules":[{"name":"Auth0"}],"title":"init(from:)","externalID":"s:5Auth06FactorV4fromACs7Decoder_p_tKcfc","role":"symbol","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"text":"from","kind":"externalParam"},{"kind":"text","text":": any "},{"kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP","text":"Decoder"},{"kind":"text","text":") "},{"text":"throws","kind":"keyword"}],"roleHeading":"Initializer","symbolKind":"init"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Factor/init(from:)":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factor\/init(from:)","title":"init(from:)","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"kind":"text","text":": any "},{"kind":"typeIdentifier","text":"Decoder","preciseIdentifier":"s:s7DecoderP"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"role":"symbol","url":"\/documentation\/auth0\/factor\/init(from:)","abstract":[],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Factor":{"title":"Factor","role":"symbol","navigatorTitle":[{"text":"Factor","kind":"identifier"}],"kind":"symbol","abstract":[],"url":"\/documentation\/auth0\/factor","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factor","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Factor"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/factor/type.json b/docs/data/documentation/auth0/factor/type.json index 6799c94f9..490f17b6e 100644 --- a/docs/data/documentation/auth0/factor/type.json +++ b/docs/data/documentation/auth0/factor/type.json @@ -1 +1 @@ -{"abstract":[{"text":"Authentication method type (factor)","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"type"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"platforms":["iOS"],"languages":["swift"]}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"metadata":{"roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"title":"type","role":"symbol","externalID":"s:5Auth06FactorV4typeSSvp","symbolKind":"property","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"type"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}]},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factor"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factor\/type","interfaceLanguage":"swift"},"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/factor\/type"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Factor":{"url":"\/documentation\/auth0\/factor","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factor","kind":"symbol","abstract":[],"type":"topic","title":"Factor","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Factor"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Factor"}]},"doc://com.auth0.Auth0/documentation/Auth0/Factor/type":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factor\/type","abstract":[{"type":"text","text":"Authentication method type (factor)"}],"kind":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"type"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"url":"\/documentation\/auth0\/factor\/type","title":"type"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/factor\/type"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factor"]]},"abstract":[{"type":"text","text":"Authentication method type (factor)"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"type","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"languages":["swift"],"platforms":["iOS"]}]}],"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"metadata":{"externalID":"s:5Auth06FactorV4typeSSvp","symbolKind":"property","title":"type","roleHeading":"Instance Property","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"type","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"modules":[{"name":"Auth0"}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factor\/type"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Factor/type":{"type":"topic","title":"type","url":"\/documentation\/auth0\/factor\/type","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factor\/type","abstract":[{"text":"Authentication method type (factor)","type":"text"}],"kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"type"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Factor":{"title":"Factor","role":"symbol","navigatorTitle":[{"text":"Factor","kind":"identifier"}],"kind":"symbol","abstract":[],"url":"\/documentation\/auth0\/factor","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factor","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Factor"}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/factor/usage.json b/docs/data/documentation/auth0/factor/usage.json index 157af4b17..e7c551eb0 100644 --- a/docs/data/documentation/auth0/factor/usage.json +++ b/docs/data/documentation/auth0/factor/usage.json @@ -1 +1 @@ -{"metadata":{"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"usage","kind":"identifier"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"]?","kind":"text"}],"roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"role":"symbol","title":"usage","externalID":"s:5Auth06FactorV5usageSaySSGSgvp","symbolKind":"property"},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"usage","kind":"identifier"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"]?","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"variants":[{"paths":["\/documentation\/auth0\/factor\/usage"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","abstract":[{"type":"text","text":"Primary and\/or secondary factor"}],"schemaVersion":{"minor":3,"major":0,"patch":0},"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factor\/usage","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factor"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Factor/usage":{"type":"topic","title":"usage","url":"\/documentation\/auth0\/factor\/usage","abstract":[{"type":"text","text":"Primary and\/or secondary factor"}],"role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"usage"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"]?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factor\/usage","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Factor":{"url":"\/documentation\/auth0\/factor","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factor","kind":"symbol","abstract":[],"type":"topic","title":"Factor","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Factor"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Factor"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"schemaVersion":{"minor":3,"patch":0,"major":0},"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"usage","kind":"identifier"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"]?","kind":"text"}],"platforms":["iOS"]}],"kind":"declarations"}],"sections":[],"abstract":[{"text":"Primary and\/or secondary factor","type":"text"}],"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/factor\/usage"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factor\/usage","interfaceLanguage":"swift"},"metadata":{"role":"symbol","modules":[{"name":"Auth0"}],"title":"usage","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"usage"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"]?"}],"externalID":"s:5Auth06FactorV5usageSaySSGSgvp","roleHeading":"Instance Property","symbolKind":"property"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factor"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Factor/usage":{"type":"topic","title":"usage","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factor\/usage","kind":"symbol","abstract":[{"text":"Primary and\/or secondary factor","type":"text"}],"url":"\/documentation\/auth0\/factor\/usage","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"usage"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"]?"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Factor":{"title":"Factor","role":"symbol","navigatorTitle":[{"text":"Factor","kind":"identifier"}],"kind":"symbol","abstract":[],"url":"\/documentation\/auth0\/factor","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factor","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Factor"}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/factors.json b/docs/data/documentation/auth0/factors.json index 97be8e0b6..a88e7bc8a 100644 --- a/docs/data/documentation/auth0/factors.json +++ b/docs/data/documentation/auth0/factors.json @@ -1 +1 @@ -{"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factors"},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Factors","kind":"identifier"}],"platforms":["iOS"],"languages":["swift"]}]}],"metadata":{"symbolKind":"struct","modules":[{"name":"Auth0"}],"roleHeading":"Structure","externalID":"s:5Auth07FactorsV","title":"Factors","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Factors","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"Factors"}]},"schemaVersion":{"major":0,"minor":3,"patch":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/factors"]}],"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"abstract":[{"text":"List of factors enabled for the Auth0 tenant and available for enrollment by this user.","type":"text"}],"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factors\/init(from:)"],"title":"Initializers","generated":true,"anchor":"Initializers"},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factors\/factors"],"title":"Instance Properties","generated":true,"anchor":"Instance-Properties"}],"relationshipsSections":[{"kind":"relationships","title":"Conforms To","identifiers":["doc:\/\/com.auth0.Auth0\/Se"],"type":"conformsTo"}],"references":{"doc://com.auth0.Auth0/Se":{"identifier":"doc:\/\/com.auth0.Auth0\/Se","title":"Swift.Decodable","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/Factors/factors":{"url":"\/documentation\/auth0\/factors\/factors","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factors\/factors","abstract":[],"kind":"symbol","type":"topic","title":"factors","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"factors"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth06FactorV","text":"Factor"},{"kind":"text","text":"]"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Factors":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factors","abstract":[{"type":"text","text":"List of factors enabled for the Auth0 tenant and available for enrollment by this user."}],"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Factors"}],"title":"Factors","type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Factors","kind":"identifier"}],"url":"\/documentation\/auth0\/factors","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Factors/init(from:)":{"kind":"symbol","abstract":[],"title":"init(from:)","role":"symbol","type":"topic","url":"\/documentation\/auth0\/factors\/init(from:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factors\/init(from:)","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":": any ","kind":"text"},{"text":"Decoder","preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}]}}} \ No newline at end of file +{"metadata":{"symbolKind":"struct","roleHeading":"Structure","externalID":"s:5Auth07FactorsV","title":"Factors","modules":[{"name":"Auth0"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Factors","kind":"identifier"}],"role":"symbol","navigatorTitle":[{"text":"Factors","kind":"identifier"}]},"sections":[],"variants":[{"paths":["\/documentation\/auth0\/factors"],"traits":[{"interfaceLanguage":"swift"}]}],"relationshipsSections":[{"title":"Conforms To","identifiers":["doc:\/\/com.auth0.Auth0\/Se"],"kind":"relationships","type":"conformsTo"}],"topicSections":[{"title":"Initializers","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factors\/init(from:)"],"anchor":"Initializers","generated":true},{"title":"Instance Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factors\/factors"],"anchor":"Instance-Properties","generated":true}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factors","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"text":"List of factors enabled for the Auth0 tenant and available for enrollment by this user.","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Factors","kind":"identifier"}],"platforms":["iOS"]}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/Se":{"title":"Swift.Decodable","identifier":"doc:\/\/com.auth0.Auth0\/Se","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/Factors/factors":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factors\/factors","kind":"symbol","title":"factors","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"factors"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:5Auth06FactorV","kind":"typeIdentifier","text":"Factor"},{"kind":"text","text":"]"}],"role":"symbol","url":"\/documentation\/auth0\/factors\/factors","abstract":[],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Factors":{"title":"Factors","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factors","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Factors"}],"abstract":[{"type":"text","text":"List of factors enabled for the Auth0 tenant and available for enrollment by this user."}],"url":"\/documentation\/auth0\/factors","navigatorTitle":[{"kind":"identifier","text":"Factors"}]},"doc://com.auth0.Auth0/documentation/Auth0/Factors/init(from:)":{"type":"topic","title":"init(from:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factors\/init(from:)","kind":"symbol","url":"\/documentation\/auth0\/factors\/init(from:)","abstract":[],"role":"symbol","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": any "},{"kind":"typeIdentifier","text":"Decoder","preciseIdentifier":"s:s7DecoderP"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/factors/factors.json b/docs/data/documentation/auth0/factors/factors.json index b9a856208..ae87ae67a 100644 --- a/docs/data/documentation/auth0/factors/factors.json +++ b/docs/data/documentation/auth0/factors/factors.json @@ -1 +1 @@ -{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factors\/factors"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/factors\/factors"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factors"]]},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"factors"},{"kind":"text","text":": ["},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factor","kind":"typeIdentifier","text":"Factor","preciseIdentifier":"s:5Auth06FactorV"},{"kind":"text","text":"]"}]}],"kind":"declarations"}],"kind":"symbol","metadata":{"symbolKind":"property","title":"factors","externalID":"s:5Auth07FactorsV7factorsSayAA6FactorVGvp","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"factors","kind":"identifier"},{"text":": [","kind":"text"},{"text":"Factor","preciseIdentifier":"s:5Auth06FactorV","kind":"typeIdentifier"},{"text":"]","kind":"text"}],"modules":[{"name":"Auth0"}],"role":"symbol","roleHeading":"Instance Property"},"schemaVersion":{"minor":3,"major":0,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Factors":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factors","abstract":[{"type":"text","text":"List of factors enabled for the Auth0 tenant and available for enrollment by this user."}],"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Factors"}],"title":"Factors","type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Factors","kind":"identifier"}],"url":"\/documentation\/auth0\/factors","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Factor":{"url":"\/documentation\/auth0\/factor","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factor","kind":"symbol","abstract":[],"type":"topic","title":"Factor","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Factor"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Factor"}]},"doc://com.auth0.Auth0/documentation/Auth0/Factors/factors":{"url":"\/documentation\/auth0\/factors\/factors","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factors\/factors","abstract":[],"kind":"symbol","type":"topic","title":"factors","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"factors"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth06FactorV","text":"Factor"},{"kind":"text","text":"]"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"factors","kind":"identifier"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","text":"Factor","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factor","preciseIdentifier":"s:5Auth06FactorV"},{"kind":"text","text":"]"}]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/factors\/factors"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factors"]]},"metadata":{"modules":[{"name":"Auth0"}],"symbolKind":"property","roleHeading":"Instance Property","title":"factors","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"factors","kind":"identifier"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:5Auth06FactorV","text":"Factor","kind":"typeIdentifier"},{"text":"]","kind":"text"}],"externalID":"s:5Auth07FactorsV7factorsSayAA6FactorVGvp"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factors\/factors"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Factors/factors":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factors\/factors","kind":"symbol","title":"factors","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"factors"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:5Auth06FactorV","kind":"typeIdentifier","text":"Factor"},{"kind":"text","text":"]"}],"role":"symbol","url":"\/documentation\/auth0\/factors\/factors","abstract":[],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Factor":{"title":"Factor","role":"symbol","navigatorTitle":[{"text":"Factor","kind":"identifier"}],"kind":"symbol","abstract":[],"url":"\/documentation\/auth0\/factor","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factor","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Factor"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Factors":{"title":"Factors","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factors","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Factors"}],"abstract":[{"type":"text","text":"List of factors enabled for the Auth0 tenant and available for enrollment by this user."}],"url":"\/documentation\/auth0\/factors","navigatorTitle":[{"kind":"identifier","text":"Factors"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/factors/init(from:).json b/docs/data/documentation/auth0/factors/init(from:).json index 38cce642a..c41db807f 100644 --- a/docs/data/documentation/auth0/factors/init(from:).json +++ b/docs/data/documentation/auth0/factors/init(from:).json @@ -1 +1 @@ -{"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"init","kind":"keyword"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"decoder","kind":"internalParam"},{"text":": any ","kind":"text"},{"preciseIdentifier":"s:s7DecoderP","text":"Decoder","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"languages":["swift"],"platforms":["iOS"]}]}],"variants":[{"paths":["\/documentation\/auth0\/factors\/init(from:)"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"role":"symbol","roleHeading":"Initializer","symbolKind":"init","title":"init(from:)","externalID":"s:5Auth07FactorsV4fromACs7Decoder_p_tKcfc","modules":[{"name":"Auth0"}],"fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": any "},{"preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier","text":"Decoder"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}]},"abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"Decodable.init(from:)"},{"type":"text","text":"."}],"schemaVersion":{"patch":0,"major":0,"minor":3},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factors"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factors\/init(from:)","interfaceLanguage":"swift"},"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Factors/init(from:)":{"kind":"symbol","abstract":[],"title":"init(from:)","role":"symbol","type":"topic","url":"\/documentation\/auth0\/factors\/init(from:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factors\/init(from:)","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":": any ","kind":"text"},{"text":"Decoder","preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Factors":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factors","abstract":[{"type":"text","text":"List of factors enabled for the Auth0 tenant and available for enrollment by this user."}],"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Factors"}],"title":"Factors","type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Factors","kind":"identifier"}],"url":"\/documentation\/auth0\/factors","role":"symbol"}}} \ No newline at end of file +{"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factors\/init(from:)","interfaceLanguage":"swift"},"kind":"symbol","metadata":{"externalID":"s:5Auth07FactorsV4fromACs7Decoder_p_tKcfc","modules":[{"name":"Auth0"}],"title":"init(from:)","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":": any ","kind":"text"},{"preciseIdentifier":"s:s7DecoderP","text":"Decoder","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"roleHeading":"Initializer","role":"symbol","symbolKind":"init"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/factors\/init(from:)"]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factors"]]},"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"init","kind":"keyword"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"decoder","kind":"internalParam"},{"text":": any ","kind":"text"},{"preciseIdentifier":"s:s7DecoderP","text":"Decoder","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"platforms":["iOS"]}],"kind":"declarations"}],"abstract":[{"text":"Inherited from ","type":"text"},{"code":"Decodable.init(from:)","type":"codeVoice"},{"text":".","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Factors":{"title":"Factors","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factors","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Factors"}],"abstract":[{"type":"text","text":"List of factors enabled for the Auth0 tenant and available for enrollment by this user."}],"url":"\/documentation\/auth0\/factors","navigatorTitle":[{"kind":"identifier","text":"Factors"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Factors/init(from:)":{"type":"topic","title":"init(from:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factors\/init(from:)","kind":"symbol","url":"\/documentation\/auth0\/factors\/init(from:)","abstract":[],"role":"symbol","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": any "},{"kind":"typeIdentifier","text":"Decoder","preciseIdentifier":"s:s7DecoderP"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/foundation.json b/docs/data/documentation/auth0/foundation.json index ef94fb7b1..394ea7200 100644 --- a/docs/data/documentation/auth0/foundation.json +++ b/docs/data/documentation/auth0/foundation.json @@ -1 +1 @@ -{"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation","interfaceLanguage":"swift"},"metadata":{"modules":[{"name":"Auth0"}],"title":"Foundation","symbolKind":"extension","roleHeading":"Extended Module","role":"collection","externalID":"s:m:s:e:s:10Foundation4DataV5Auth0E22a0_encodeBase64URLSafeSSSgyF"},"topicSections":[{"title":"Extended Structures","generated":true,"anchor":"Extended-Structures","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation\/Data"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"sections":[],"schemaVersion":{"patch":0,"minor":3,"major":0},"variants":[{"paths":["\/documentation\/auth0\/foundation"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Foundation/Data":{"type":"topic","abstract":[{"text":"Adds a utility method for encoding data to base64url.","type":"text"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation\/Data","title":"Data","fragments":[{"text":"extension","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Data","kind":"identifier","preciseIdentifier":"s:10Foundation4DataV"}],"url":"\/documentation\/auth0\/foundation\/data","navigatorTitle":[{"text":"Data","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Foundation":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation","kind":"symbol","url":"\/documentation\/auth0\/foundation","role":"collection","abstract":[],"title":"Foundation"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/foundation"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation\/Data"],"title":"Extended Structures","generated":true,"anchor":"Extended-Structures"}],"sections":[],"kind":"symbol","schemaVersion":{"patch":0,"major":0,"minor":3},"metadata":{"modules":[{"name":"Auth0"}],"roleHeading":"Extended Module","role":"collection","title":"Foundation","externalID":"s:m:s:e:s:10Foundation4DataV5Auth0E22a0_encodeBase64URLSafeSSSgyF","symbolKind":"extension"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Foundation/Data":{"title":"Data","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation\/Data","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"extension"},{"kind":"text","text":" "},{"kind":"identifier","preciseIdentifier":"s:10Foundation4DataV","text":"Data"}],"abstract":[{"type":"text","text":"Adds a utility method for encoding data to base64url."}],"url":"\/documentation\/auth0\/foundation\/data","navigatorTitle":[{"kind":"identifier","text":"Data"}]},"doc://com.auth0.Auth0/documentation/Auth0/Foundation":{"title":"Foundation","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation","role":"collection","kind":"symbol","abstract":[],"url":"\/documentation\/auth0\/foundation"}}} \ 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 f667545fa..c7c6740ec 100644 --- a/docs/data/documentation/auth0/foundation/data.json +++ b/docs/data/documentation/auth0/foundation/data.json @@ -1 +1 @@ -{"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation\/Data","interfaceLanguage":"swift"},"schemaVersion":{"minor":3,"major":0,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation"]]},"metadata":{"roleHeading":"Extended Structure","extendedModule":"Foundation","navigatorTitle":[{"kind":"identifier","text":"Data"}],"title":"Data","symbolKind":"extension","externalID":"s:e:s:10Foundation4DataV5Auth0E22a0_encodeBase64URLSafeSSSgyF","role":"symbol","modules":[{"name":"Auth0","relatedModules":["Foundation"]}],"fragments":[{"kind":"keyword","text":"extension"},{"kind":"text","text":" "},{"kind":"identifier","preciseIdentifier":"s:10Foundation4DataV","text":"Data"}]},"abstract":[{"type":"text","text":"Adds a utility method for encoding data to base64url."}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/foundation\/data"]}],"topicSections":[{"generated":true,"anchor":"Instance-Methods","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation\/Data\/a0_encodeBase64URLSafe()"],"title":"Instance Methods"}],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"extension"},{"kind":"text","text":" "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV","text":"Data"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Foundation/Data/a0_encodeBase64URLSafe()":{"type":"topic","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"a0_encodeBase64URLSafe"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"abstract":[{"text":"Encodes data to base64url.","type":"text"}],"title":"a0_encodeBase64URLSafe()","url":"\/documentation\/auth0\/foundation\/data\/a0_encodebase64urlsafe()","kind":"symbol","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation\/Data\/a0_encodeBase64URLSafe()"},"doc://com.auth0.Auth0/documentation/Auth0/Foundation":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation","kind":"symbol","url":"\/documentation\/auth0\/foundation","role":"collection","abstract":[],"title":"Foundation"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Foundation/Data":{"type":"topic","abstract":[{"text":"Adds a utility method for encoding data to base64url.","type":"text"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation\/Data","title":"Data","fragments":[{"text":"extension","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Data","kind":"identifier","preciseIdentifier":"s:10Foundation4DataV"}],"url":"\/documentation\/auth0\/foundation\/data","navigatorTitle":[{"text":"Data","kind":"identifier"}],"kind":"symbol"}}} \ No newline at end of file +{"abstract":[{"type":"text","text":"Adds a utility method for encoding data to base64url."}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"extension"},{"kind":"text","text":" "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"}]}],"kind":"declarations"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/foundation\/data"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation"]]},"topicSections":[{"title":"Instance Methods","generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation\/Data\/a0_encodeBase64URLSafe()"],"anchor":"Instance-Methods"}],"metadata":{"navigatorTitle":[{"kind":"identifier","text":"Data"}],"modules":[{"name":"Auth0","relatedModules":["Foundation"]}],"title":"Data","roleHeading":"Extended Structure","symbolKind":"extension","role":"symbol","extendedModule":"Foundation","fragments":[{"kind":"keyword","text":"extension"},{"kind":"text","text":" "},{"kind":"identifier","preciseIdentifier":"s:10Foundation4DataV","text":"Data"}],"externalID":"s:e:s:10Foundation4DataV5Auth0E22a0_encodeBase64URLSafeSSSgyF"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation\/Data","interfaceLanguage":"swift"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/Foundation":{"title":"Foundation","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation","role":"collection","kind":"symbol","abstract":[],"url":"\/documentation\/auth0\/foundation"},"doc://com.auth0.Auth0/documentation/Auth0/Foundation/Data":{"title":"Data","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation\/Data","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"extension"},{"kind":"text","text":" "},{"kind":"identifier","preciseIdentifier":"s:10Foundation4DataV","text":"Data"}],"abstract":[{"type":"text","text":"Adds a utility method for encoding data to base64url."}],"url":"\/documentation\/auth0\/foundation\/data","navigatorTitle":[{"kind":"identifier","text":"Data"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Foundation/Data/a0_encodeBase64URLSafe()":{"url":"\/documentation\/auth0\/foundation\/data\/a0_encodebase64urlsafe()","title":"a0_encodeBase64URLSafe()","abstract":[{"type":"text","text":"Encodes data to base64url."}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"a0_encodeBase64URLSafe"},{"kind":"text","text":"() -> "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation\/Data\/a0_encodeBase64URLSafe()","role":"symbol","kind":"symbol","type":"topic"}}} \ 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 d62c39ee4..4fc3d031b 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","schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation\/Data\/a0_encodeBase64URLSafe()","interfaceLanguage":"swift"},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"a0_encodeBase64URLSafe"},{"kind":"text","text":"() -> "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"metadata":{"title":"a0_encodeBase64URLSafe()","symbolKind":"method","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"a0_encodeBase64URLSafe","kind":"identifier"},{"text":"() -> ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"modules":[{"name":"Auth0","relatedModules":["Foundation"]}],"extendedModule":"Foundation","roleHeading":"Instance Method","externalID":"s:10Foundation4DataV5Auth0E22a0_encodeBase64URLSafeSSSgyF"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation\/Data"]]},"abstract":[{"type":"text","text":"Encodes data to base64url."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/foundation\/data\/a0_encodebase64urlsafe()"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Foundation/Data/a0_encodeBase64URLSafe()":{"type":"topic","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"a0_encodeBase64URLSafe"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"abstract":[{"text":"Encodes data to base64url.","type":"text"}],"title":"a0_encodeBase64URLSafe()","url":"\/documentation\/auth0\/foundation\/data\/a0_encodebase64urlsafe()","kind":"symbol","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation\/Data\/a0_encodeBase64URLSafe()"},"doc://com.auth0.Auth0/documentation/Auth0/Foundation":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation","kind":"symbol","url":"\/documentation\/auth0\/foundation","role":"collection","abstract":[],"title":"Foundation"},"doc://com.auth0.Auth0/documentation/Auth0/Foundation/Data":{"type":"topic","abstract":[{"text":"Adds a utility method for encoding data to base64url.","type":"text"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation\/Data","title":"Data","fragments":[{"text":"extension","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Data","kind":"identifier","preciseIdentifier":"s:10Foundation4DataV"}],"url":"\/documentation\/auth0\/foundation\/data","navigatorTitle":[{"text":"Data","kind":"identifier"}],"kind":"symbol"}}} \ No newline at end of file +{"sections":[],"metadata":{"modules":[{"name":"Auth0","relatedModules":["Foundation"]}],"title":"a0_encodeBase64URLSafe()","externalID":"s:10Foundation4DataV5Auth0E22a0_encodeBase64URLSafeSSSgyF","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"a0_encodeBase64URLSafe"},{"kind":"text","text":"() -> "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"extendedModule":"Foundation","roleHeading":"Instance Method","symbolKind":"method"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation\/Data\/a0_encodeBase64URLSafe()","interfaceLanguage":"swift"},"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/foundation\/data\/a0_encodebase64urlsafe()"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation\/Data"]]},"schemaVersion":{"minor":3,"patch":0,"major":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"a0_encodeBase64URLSafe"},{"text":"() -> ","kind":"text"},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"?","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}]}],"abstract":[{"text":"Encodes data to base64url.","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Foundation/Data/a0_encodeBase64URLSafe()":{"url":"\/documentation\/auth0\/foundation\/data\/a0_encodebase64urlsafe()","title":"a0_encodeBase64URLSafe()","abstract":[{"type":"text","text":"Encodes data to base64url."}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"a0_encodeBase64URLSafe"},{"kind":"text","text":"() -> "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation\/Data\/a0_encodeBase64URLSafe()","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Foundation/Data":{"title":"Data","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation\/Data","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"extension"},{"kind":"text","text":" "},{"kind":"identifier","preciseIdentifier":"s:10Foundation4DataV","text":"Data"}],"abstract":[{"type":"text","text":"Adds a utility method for encoding data to base64url."}],"url":"\/documentation\/auth0\/foundation\/data","navigatorTitle":[{"kind":"identifier","text":"Data"}]},"doc://com.auth0.Auth0/documentation/Auth0/Foundation":{"title":"Foundation","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Foundation","role":"collection","kind":"symbol","abstract":[],"url":"\/documentation\/auth0\/foundation"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/jwk.json b/docs/data/documentation/auth0/jwk.json index 17a21b5bb..9c13aa3bf 100644 --- a/docs/data/documentation/auth0/jwk.json +++ b/docs/data/documentation/auth0/jwk.json @@ -1 +1 @@ -{"seeAlsoSections":[{"anchor":"Related-Documentation","title":"Related Documentation","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS"]}],"variants":[{"paths":["\/documentation\/auth0\/jwk"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"JWK","kind":"identifier"}],"languages":["swift"]}]}],"abstract":[{"text":"Cryptographic public key of your Auth0 tenant.","type":"text"}],"sections":[],"topicSections":[{"anchor":"Initializers","title":"Initializers","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/init(from:)"],"generated":true},{"anchor":"Instance-Properties","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"],"generated":true}],"schemaVersion":{"major":0,"patch":0,"minor":3},"metadata":{"symbolKind":"struct","role":"symbol","roleHeading":"Structure","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"JWK","kind":"identifier"}],"modules":[{"name":"Auth0"}],"title":"JWK","navigatorTitle":[{"text":"JWK","kind":"identifier"}],"externalID":"s:5Auth03JWKV"},"relationshipsSections":[{"kind":"relationships","type":"conformsTo","title":"Conforms To","identifiers":["doc:\/\/com.auth0.Auth0\/Se","doc:\/\/com.auth0.Auth0\/SE","doc:\/\/com.auth0.Auth0\/s8SendableP","doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP"]}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/JWK/certChain":{"url":"\/documentation\/auth0\/jwk\/certchain","kind":"symbol","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"certChain"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"]?"}],"type":"topic","title":"certChain","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/certChain","role":"symbol","abstract":[{"type":"text","text":"The x.509 certificate chain."}]},"doc://com.auth0.Auth0/documentation/Auth0/JWKS":{"navigatorTitle":[{"text":"JWKS","kind":"identifier"}],"title":"JWKS","role":"symbol","url":"\/documentation\/auth0\/jwks","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS","abstract":[{"text":"The JSON Web Key Set (JWKS) of your Auth0 tenant.","type":"text"}],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"JWKS","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/JWK/keyId":{"abstract":[{"type":"text","text":"The unique identifier of the key."}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/keyId","title":"keyId","kind":"symbol","url":"\/documentation\/auth0\/jwk\/keyid","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"role":"symbol"},"doc://com.auth0.Auth0/Se":{"identifier":"doc:\/\/com.auth0.Auth0\/Se","type":"unresolvable","title":"Swift.Decodable"},"doc://com.auth0.Auth0/documentation/Auth0/JWK/init(from:)":{"url":"\/documentation\/auth0\/jwk\/init(from:)","kind":"symbol","fragments":[{"kind":"identifier","text":"init"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":": any ","kind":"text"},{"text":"Decoder","kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP"},{"text":") ","kind":"text"},{"kind":"keyword","text":"throws"}],"type":"topic","title":"init(from:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/init(from:)","role":"symbol","abstract":[]},"doc://com.auth0.Auth0/documentation/Auth0/JWK/certUrl":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/certUrl","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"certUrl"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"kind":"symbol","type":"topic","abstract":[{"type":"text","text":"The URL of the x.509 certificate."}],"url":"\/documentation\/auth0\/jwk\/certurl","role":"symbol","title":"certUrl"},"doc://com.auth0.Auth0/documentation/Auth0/JWK/usage":{"url":"\/documentation\/auth0\/jwk\/usage","kind":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"usage","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"type":"topic","title":"usage","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/usage","role":"symbol","abstract":[{"type":"text","text":"How the key is meant to be used."}]},"doc://com.auth0.Auth0/documentation/Auth0/JWK/exponent":{"kind":"symbol","role":"symbol","url":"\/documentation\/auth0\/jwk\/exponent","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/exponent","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"exponent"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"abstract":[{"text":"The exponent of the key.","type":"text"}],"title":"exponent","type":"topic"},"doc://com.auth0.Auth0/SE":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/SE","title":"Swift.Encodable"},"doc://com.auth0.Auth0/documentation/Auth0/JWK/modulus":{"url":"\/documentation\/auth0\/jwk\/modulus","kind":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"modulus","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"type":"topic","title":"modulus","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/modulus","role":"symbol","abstract":[{"text":"The modulus of the key.","type":"text"}]},"doc://com.auth0.Auth0/s8SendableP":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s8SendableP","title":"Swift.Sendable"},"doc://com.auth0.Auth0/s16SendableMetatypeP":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP","title":"Swift.SendableMetatype"},"doc://com.auth0.Auth0/documentation/Auth0/JWK/certThumbprint":{"kind":"symbol","role":"symbol","url":"\/documentation\/auth0\/jwk\/certthumbprint","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/certThumbprint","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"certThumbprint"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"abstract":[{"text":"The thumbprint of the x.509 certificate (SHA-1 thumbprint).","type":"text"}],"title":"certThumbprint","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"abstract":[{"text":"Cryptographic public key of your Auth0 tenant.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"JWK"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"JWK"}],"url":"\/documentation\/auth0\/jwk","role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","title":"JWK","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/JWK/keyType":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/keyType","role":"symbol","url":"\/documentation\/auth0\/jwk\/keytype","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyType"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"abstract":[{"text":"The type of key.","type":"text"}],"title":"keyType","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/JWK/algorithm":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/algorithm","role":"symbol","url":"\/documentation\/auth0\/jwk\/algorithm","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"algorithm"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"abstract":[{"text":"The algorithm of the key.","type":"text"}],"title":"algorithm","kind":"symbol","type":"topic"}}} \ No newline at end of file +{"metadata":{"symbolKind":"struct","title":"JWK","externalID":"s:5Auth03JWKV","roleHeading":"Structure","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"JWK"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"JWK"}]},"sections":[],"variants":[{"paths":["\/documentation\/auth0\/jwk"],"traits":[{"interfaceLanguage":"swift"}]}],"relationshipsSections":[{"title":"Conforms To","type":"conformsTo","kind":"relationships","identifiers":["doc:\/\/com.auth0.Auth0\/Se","doc:\/\/com.auth0.Auth0\/SE","doc:\/\/com.auth0.Auth0\/s8SendableP","doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP"]}],"topicSections":[{"generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/init(from:)"],"title":"Initializers","anchor":"Initializers"},{"title":"Instance Properties","generated":true,"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"],"anchor":"Instance-Properties"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"type":"text","text":"Cryptographic public key of your Auth0 tenant."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"seeAlsoSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS"],"title":"Related Documentation","anchor":"Related-Documentation"}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"JWK"}],"platforms":["iOS"]}],"kind":"declarations"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/JWK/keyType":{"type":"topic","abstract":[{"type":"text","text":"The type of key."}],"title":"keyType","url":"\/documentation\/auth0\/jwk\/keytype","kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"keyType","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/keyType"},"doc://com.auth0.Auth0/documentation/Auth0/JWKS":{"role":"symbol","title":"JWKS","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"JWKS"}],"navigatorTitle":[{"kind":"identifier","text":"JWKS"}],"abstract":[{"type":"text","text":"The JSON Web Key Set (JWKS) of your Auth0 tenant."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS","url":"\/documentation\/auth0\/jwks","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"url":"\/documentation\/auth0\/jwk","title":"JWK","abstract":[{"type":"text","text":"Cryptographic public key of your Auth0 tenant."}],"navigatorTitle":[{"kind":"identifier","text":"JWK"}],"fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"JWK"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/JWK/exponent":{"type":"topic","title":"exponent","url":"\/documentation\/auth0\/jwk\/exponent","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/exponent","kind":"symbol","abstract":[{"type":"text","text":"The exponent of the key."}],"role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"exponent"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}]},"doc://com.auth0.Auth0/documentation/Auth0/JWK/certChain":{"url":"\/documentation\/auth0\/jwk\/certchain","title":"certChain","abstract":[{"text":"The x.509 certificate chain.","type":"text"}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"certChain"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"]?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/certChain","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/JWK/usage":{"url":"\/documentation\/auth0\/jwk\/usage","abstract":[{"type":"text","text":"How the key is meant to be used."}],"title":"usage","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"usage","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/usage","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/JWK/certThumbprint":{"type":"topic","title":"certThumbprint","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/certThumbprint","kind":"symbol","abstract":[{"type":"text","text":"The thumbprint of the x.509 certificate (SHA-1 thumbprint)."}],"url":"\/documentation\/auth0\/jwk\/certthumbprint","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"certThumbprint"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/s8SendableP":{"identifier":"doc:\/\/com.auth0.Auth0\/s8SendableP","type":"unresolvable","title":"Swift.Sendable"},"doc://com.auth0.Auth0/s16SendableMetatypeP":{"title":"Swift.SendableMetatype","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP"},"doc://com.auth0.Auth0/documentation/Auth0/JWK/modulus":{"type":"topic","title":"modulus","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/modulus","url":"\/documentation\/auth0\/jwk\/modulus","abstract":[{"type":"text","text":"The modulus of the key."}],"kind":"symbol","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"modulus","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/JWK/certUrl":{"type":"topic","title":"certUrl","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/certUrl","url":"\/documentation\/auth0\/jwk\/certurl","abstract":[{"type":"text","text":"The URL of the x.509 certificate."}],"kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"certUrl"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/JWK/algorithm":{"type":"topic","abstract":[{"type":"text","text":"The algorithm of the key."}],"title":"algorithm","kind":"symbol","url":"\/documentation\/auth0\/jwk\/algorithm","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"algorithm"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/algorithm"},"doc://com.auth0.Auth0/documentation/Auth0/JWK/init(from:)":{"type":"topic","abstract":[],"title":"init(from:)","url":"\/documentation\/auth0\/jwk\/init(from:)","kind":"symbol","role":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":": any ","kind":"text"},{"text":"Decoder","preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/init(from:)"},"doc://com.auth0.Auth0/SE":{"identifier":"doc:\/\/com.auth0.Auth0\/SE","type":"unresolvable","title":"Swift.Encodable"},"doc://com.auth0.Auth0/documentation/Auth0/JWK/keyId":{"url":"\/documentation\/auth0\/jwk\/keyid","abstract":[{"text":"The unique identifier of the key.","type":"text"}],"title":"keyId","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"keyId","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/keyId","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/Se":{"title":"Swift.Decodable","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/Se"}}} \ 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 28e6f4742..0bbb40b59 100644 --- a/docs/data/documentation/auth0/jwk/algorithm.json +++ b/docs/data/documentation/auth0/jwk/algorithm.json @@ -1 +1 @@ -{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/algorithm"},"variants":[{"paths":["\/documentation\/auth0\/jwk\/algorithm"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"schemaVersion":{"minor":3,"major":0,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK"]]},"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"algorithm"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"platforms":["iOS"],"languages":["swift"]}]}],"abstract":[{"type":"text","text":"The algorithm of the key."}],"metadata":{"externalID":"s:5Auth03JWKV9algorithmSSSgvp","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"algorithm"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"roleHeading":"Instance Property","symbolKind":"property","role":"symbol","title":"algorithm"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/JWK/algorithm":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/algorithm","role":"symbol","url":"\/documentation\/auth0\/jwk\/algorithm","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"algorithm"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"abstract":[{"text":"The algorithm of the key.","type":"text"}],"title":"algorithm","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"abstract":[{"text":"Cryptographic public key of your Auth0 tenant.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"JWK"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"JWK"}],"url":"\/documentation\/auth0\/jwk","role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","title":"JWK","kind":"symbol"}}} \ No newline at end of file +{"schemaVersion":{"minor":3,"patch":0,"major":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"algorithm","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"platforms":["iOS"]}]}],"sections":[],"abstract":[{"text":"The algorithm of the key.","type":"text"}],"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/jwk\/algorithm"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/algorithm","interfaceLanguage":"swift"},"metadata":{"role":"symbol","modules":[{"name":"Auth0"}],"title":"algorithm","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"algorithm","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"externalID":"s:5Auth03JWKV9algorithmSSSgvp","roleHeading":"Instance Property","symbolKind":"property"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"url":"\/documentation\/auth0\/jwk","title":"JWK","abstract":[{"type":"text","text":"Cryptographic public key of your Auth0 tenant."}],"navigatorTitle":[{"kind":"identifier","text":"JWK"}],"fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"JWK"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/JWK/algorithm":{"type":"topic","abstract":[{"type":"text","text":"The algorithm of the key."}],"title":"algorithm","kind":"symbol","url":"\/documentation\/auth0\/jwk\/algorithm","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"algorithm"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/algorithm"}}} \ 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 ca9fd2499..a88a76015 100644 --- a/docs/data/documentation/auth0/jwk/certchain.json +++ b/docs/data/documentation/auth0/jwk/certchain.json @@ -1 +1 @@ -{"metadata":{"title":"certChain","roleHeading":"Instance Property","symbolKind":"property","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"certChain","kind":"identifier"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"]?","kind":"text"}],"externalID":"s:5Auth03JWKV9certChainSaySSGSgvp","modules":[{"name":"Auth0"}],"role":"symbol"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/jwk\/certchain"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"certChain","kind":"identifier"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"]?","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}]}],"schemaVersion":{"minor":3,"major":0,"patch":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/certChain"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK"]]},"kind":"symbol","abstract":[{"text":"The x.509 certificate chain.","type":"text"}],"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"abstract":[{"text":"Cryptographic public key of your Auth0 tenant.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"JWK"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"JWK"}],"url":"\/documentation\/auth0\/jwk","role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","title":"JWK","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/JWK/certChain":{"url":"\/documentation\/auth0\/jwk\/certchain","kind":"symbol","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"certChain"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"]?"}],"type":"topic","title":"certChain","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/certChain","role":"symbol","abstract":[{"type":"text","text":"The x.509 certificate chain."}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK"]]},"metadata":{"symbolKind":"property","modules":[{"name":"Auth0"}],"title":"certChain","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"certChain","kind":"identifier"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"]?","kind":"text"}],"externalID":"s:5Auth03JWKV9certChainSaySSGSgvp","role":"symbol","roleHeading":"Instance Property"},"sections":[],"abstract":[{"text":"The x.509 certificate chain.","type":"text"}],"variants":[{"paths":["\/documentation\/auth0\/jwk\/certchain"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/certChain","interfaceLanguage":"swift"},"kind":"symbol","schemaVersion":{"minor":3,"major":0,"patch":0},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"certChain","kind":"identifier"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"]?","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"url":"\/documentation\/auth0\/jwk","title":"JWK","abstract":[{"type":"text","text":"Cryptographic public key of your Auth0 tenant."}],"navigatorTitle":[{"kind":"identifier","text":"JWK"}],"fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"JWK"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/JWK/certChain":{"url":"\/documentation\/auth0\/jwk\/certchain","title":"certChain","abstract":[{"text":"The x.509 certificate chain.","type":"text"}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"certChain"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"]?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/certChain","role":"symbol","kind":"symbol","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/jwk/certthumbprint.json b/docs/data/documentation/auth0/jwk/certthumbprint.json index f77d17d49..ba7bdcb5c 100644 --- a/docs/data/documentation/auth0/jwk/certthumbprint.json +++ b/docs/data/documentation/auth0/jwk/certthumbprint.json @@ -1 +1 @@ -{"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK"]]},"metadata":{"title":"certThumbprint","role":"symbol","symbolKind":"property","roleHeading":"Instance Property","externalID":"s:5Auth03JWKV14certThumbprintSSSgvp","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"certThumbprint","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"modules":[{"name":"Auth0"}]},"kind":"symbol","schemaVersion":{"minor":3,"patch":0,"major":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/certThumbprint"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/jwk\/certthumbprint"]}],"abstract":[{"type":"text","text":"The thumbprint of the x.509 certificate (SHA-1 thumbprint)."}],"primaryContentSections":[{"declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"certThumbprint","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/JWK/certThumbprint":{"kind":"symbol","role":"symbol","url":"\/documentation\/auth0\/jwk\/certthumbprint","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/certThumbprint","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"certThumbprint"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"abstract":[{"text":"The thumbprint of the x.509 certificate (SHA-1 thumbprint).","type":"text"}],"title":"certThumbprint","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"abstract":[{"text":"Cryptographic public key of your Auth0 tenant.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"JWK"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"JWK"}],"url":"\/documentation\/auth0\/jwk","role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","title":"JWK","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"metadata":{"symbolKind":"property","modules":[{"name":"Auth0"}],"title":"certThumbprint","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"certThumbprint","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"externalID":"s:5Auth03JWKV14certThumbprintSSSgvp","role":"symbol","roleHeading":"Instance Property"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/jwk\/certthumbprint"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/certThumbprint","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"text":"The thumbprint of the x.509 certificate (SHA-1 thumbprint).","type":"text"}],"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":" "},{"kind":"identifier","text":"certThumbprint"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"platforms":["iOS"]}],"kind":"declarations"}],"schemaVersion":{"major":0,"patch":0,"minor":3},"references":{"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"url":"\/documentation\/auth0\/jwk","title":"JWK","abstract":[{"type":"text","text":"Cryptographic public key of your Auth0 tenant."}],"navigatorTitle":[{"kind":"identifier","text":"JWK"}],"fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"JWK"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/JWK/certThumbprint":{"type":"topic","title":"certThumbprint","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/certThumbprint","kind":"symbol","abstract":[{"type":"text","text":"The thumbprint of the x.509 certificate (SHA-1 thumbprint)."}],"url":"\/documentation\/auth0\/jwk\/certthumbprint","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"certThumbprint"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ 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 fe6aec0dd..1f2cb842b 100644 --- a/docs/data/documentation/auth0/jwk/certurl.json +++ b/docs/data/documentation/auth0/jwk/certurl.json @@ -1 +1 @@ -{"metadata":{"symbolKind":"property","title":"certUrl","role":"symbol","roleHeading":"Instance Property","externalID":"s:5Auth03JWKV7certUrlSSSgvp","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"certUrl"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}],"modules":[{"name":"Auth0"}]},"schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/certUrl","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK"]]},"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/jwk\/certurl"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"abstract":[{"type":"text","text":"The URL of the x.509 certificate."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"certUrl"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}],"platforms":["iOS"]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"abstract":[{"text":"Cryptographic public key of your Auth0 tenant.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"JWK"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"JWK"}],"url":"\/documentation\/auth0\/jwk","role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","title":"JWK","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/JWK/certUrl":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/certUrl","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"certUrl"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"kind":"symbol","type":"topic","abstract":[{"type":"text","text":"The URL of the x.509 certificate."}],"url":"\/documentation\/auth0\/jwk\/certurl","role":"symbol","title":"certUrl"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"metadata":{"symbolKind":"property","title":"certUrl","externalID":"s:5Auth03JWKV7certUrlSSSgvp","roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"certUrl","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"role":"symbol"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/jwk\/certurl"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/certUrl"},"kind":"symbol","abstract":[{"type":"text","text":"The URL of the x.509 certificate."}],"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"},{"text":" ","kind":"text"},{"text":"certUrl","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/JWK/certUrl":{"type":"topic","title":"certUrl","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/certUrl","url":"\/documentation\/auth0\/jwk\/certurl","abstract":[{"type":"text","text":"The URL of the x.509 certificate."}],"kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"certUrl"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"url":"\/documentation\/auth0\/jwk","title":"JWK","abstract":[{"type":"text","text":"Cryptographic public key of your Auth0 tenant."}],"navigatorTitle":[{"kind":"identifier","text":"JWK"}],"fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"JWK"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","role":"symbol","kind":"symbol","type":"topic"}}} \ 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 b16293619..28d17bb4a 100644 --- a/docs/data/documentation/auth0/jwk/exponent.json +++ b/docs/data/documentation/auth0/jwk/exponent.json @@ -1 +1 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/exponent","interfaceLanguage":"swift"},"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"exponent"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"languages":["swift"],"platforms":["iOS"]}]}],"abstract":[{"type":"text","text":"The exponent of the key."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/jwk\/exponent"]}],"sections":[],"metadata":{"externalID":"s:5Auth03JWKV8exponentSSSgvp","roleHeading":"Instance Property","title":"exponent","role":"symbol","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"exponent"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"symbolKind":"property"},"schemaVersion":{"minor":3,"patch":0,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/JWK/exponent":{"kind":"symbol","role":"symbol","url":"\/documentation\/auth0\/jwk\/exponent","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/exponent","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"exponent"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"abstract":[{"text":"The exponent of the key.","type":"text"}],"title":"exponent","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"abstract":[{"text":"Cryptographic public key of your Auth0 tenant.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"JWK"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"JWK"}],"url":"\/documentation\/auth0\/jwk","role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","title":"JWK","kind":"symbol"}}} \ No newline at end of file +{"metadata":{"symbolKind":"property","roleHeading":"Instance Property","externalID":"s:5Auth03JWKV8exponentSSSgvp","title":"exponent","modules":[{"name":"Auth0"}],"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"exponent","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"role":"symbol"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/jwk\/exponent"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/exponent"},"kind":"symbol","abstract":[{"type":"text","text":"The exponent of the key."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK"]]},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"exponent","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}]}],"kind":"declarations"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"url":"\/documentation\/auth0\/jwk","title":"JWK","abstract":[{"type":"text","text":"Cryptographic public key of your Auth0 tenant."}],"navigatorTitle":[{"kind":"identifier","text":"JWK"}],"fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"JWK"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/JWK/exponent":{"type":"topic","title":"exponent","url":"\/documentation\/auth0\/jwk\/exponent","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/exponent","kind":"symbol","abstract":[{"type":"text","text":"The exponent of the key."}],"role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"exponent"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ 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 4907844f7..3e51a8e81 100644 --- a/docs/data/documentation/auth0/jwk/init(from:).json +++ b/docs/data/documentation/auth0/jwk/init(from:).json @@ -1 +1 @@ -{"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/jwk\/init(from:)"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/init(from:)"},"sections":[],"schemaVersion":{"patch":0,"major":0,"minor":3},"abstract":[{"type":"text","text":"Inherited from "},{"code":"Decodable.init(from:)","type":"codeVoice"},{"type":"text","text":"."}],"metadata":{"symbolKind":"init","roleHeading":"Initializer","modules":[{"name":"Auth0"}],"fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"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:)","role":"symbol","externalID":"s:5Auth03JWKV4fromACs7Decoder_p_tKcfc"},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":" "},{"kind":"internalParam","text":"decoder"},{"kind":"text","text":": any "},{"kind":"typeIdentifier","text":"Decoder","preciseIdentifier":"s:s7DecoderP"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"languages":["swift"]}],"kind":"declarations"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/JWK/init(from:)":{"url":"\/documentation\/auth0\/jwk\/init(from:)","kind":"symbol","fragments":[{"kind":"identifier","text":"init"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":": any ","kind":"text"},{"text":"Decoder","kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP"},{"text":") ","kind":"text"},{"kind":"keyword","text":"throws"}],"type":"topic","title":"init(from:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/init(from:)","role":"symbol","abstract":[]},"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"abstract":[{"text":"Cryptographic public key of your Auth0 tenant.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"JWK"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"JWK"}],"url":"\/documentation\/auth0\/jwk","role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","title":"JWK","kind":"symbol"}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/jwk\/init(from:)"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK"]]},"abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"Decodable.init(from:)"},{"type":"text","text":"."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"init","kind":"keyword"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"decoder","kind":"internalParam"},{"text":": any ","kind":"text"},{"preciseIdentifier":"s:s7DecoderP","text":"Decoder","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}]}]}],"kind":"symbol","schemaVersion":{"patch":0,"minor":3,"major":0},"sections":[],"metadata":{"externalID":"s:5Auth03JWKV4fromACs7Decoder_p_tKcfc","symbolKind":"init","title":"init(from:)","role":"symbol","roleHeading":"Initializer","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":": any ","kind":"text"},{"preciseIdentifier":"s:s7DecoderP","text":"Decoder","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"modules":[{"name":"Auth0"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/init(from:)","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/JWK/init(from:)":{"type":"topic","abstract":[],"title":"init(from:)","url":"\/documentation\/auth0\/jwk\/init(from:)","kind":"symbol","role":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":": any ","kind":"text"},{"text":"Decoder","preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/init(from:)"},"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"url":"\/documentation\/auth0\/jwk","title":"JWK","abstract":[{"type":"text","text":"Cryptographic public key of your Auth0 tenant."}],"navigatorTitle":[{"kind":"identifier","text":"JWK"}],"fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"JWK"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ 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 85a24b650..c0f913559 100644 --- a/docs/data/documentation/auth0/jwk/keyid.json +++ b/docs/data/documentation/auth0/jwk/keyid.json @@ -1 +1 @@ -{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/keyId"},"schemaVersion":{"major":0,"patch":0,"minor":3},"abstract":[{"text":"The unique identifier of the key.","type":"text"}],"metadata":{"roleHeading":"Instance Property","externalID":"s:5Auth03JWKV5keyIdSSSgvp","role":"symbol","title":"keyId","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"modules":[{"name":"Auth0"}],"symbolKind":"property"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"keyId","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"platforms":["iOS"]}]}],"sections":[],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/jwk\/keyid"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/JWK/keyId":{"abstract":[{"type":"text","text":"The unique identifier of the key."}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/keyId","title":"keyId","kind":"symbol","url":"\/documentation\/auth0\/jwk\/keyid","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"abstract":[{"text":"Cryptographic public key of your Auth0 tenant.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"JWK"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"JWK"}],"url":"\/documentation\/auth0\/jwk","role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","title":"JWK","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"abstract":[{"text":"The unique identifier of the key.","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"platforms":["iOS"],"languages":["swift"]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/jwk\/keyid"]}],"schemaVersion":{"major":0,"patch":0,"minor":3},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK"]]},"metadata":{"symbolKind":"property","modules":[{"name":"Auth0"}],"title":"keyId","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"externalID":"s:5Auth03JWKV5keyIdSSSgvp","role":"symbol","roleHeading":"Instance Property"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/keyId","interfaceLanguage":"swift"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/JWK/keyId":{"url":"\/documentation\/auth0\/jwk\/keyid","abstract":[{"text":"The unique identifier of the key.","type":"text"}],"title":"keyId","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"keyId","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/keyId","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"url":"\/documentation\/auth0\/jwk","title":"JWK","abstract":[{"type":"text","text":"Cryptographic public key of your Auth0 tenant."}],"navigatorTitle":[{"kind":"identifier","text":"JWK"}],"fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"JWK"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","role":"symbol","kind":"symbol","type":"topic"}}} \ 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 4aef7921f..c3249fc41 100644 --- a/docs/data/documentation/auth0/jwk/keytype.json +++ b/docs/data/documentation/auth0/jwk/keytype.json @@ -1 +1 @@ -{"sections":[],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"keyType","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}]}],"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\/keytype"]}],"metadata":{"role":"symbol","modules":[{"name":"Auth0"}],"externalID":"s:5Auth03JWKV7keyTypeSSvp","title":"keyType","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"keyType","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"symbolKind":"property","roleHeading":"Instance Property"},"schemaVersion":{"major":0,"patch":0,"minor":3},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/keyType"},"abstract":[{"type":"text","text":"The type of key."}],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"abstract":[{"text":"Cryptographic public key of your Auth0 tenant.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"JWK"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"JWK"}],"url":"\/documentation\/auth0\/jwk","role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","title":"JWK","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/JWK/keyType":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/keyType","role":"symbol","url":"\/documentation\/auth0\/jwk\/keytype","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyType"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"abstract":[{"text":"The type of key.","type":"text"}],"title":"keyType","kind":"symbol","type":"topic"}}} \ No newline at end of file +{"variants":[{"paths":["\/documentation\/auth0\/jwk\/keytype"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK"]]},"abstract":[{"type":"text","text":"The type of key."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyType"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}]}]}],"kind":"symbol","schemaVersion":{"minor":3,"patch":0,"major":0},"sections":[],"metadata":{"modules":[{"name":"Auth0"}],"title":"keyType","symbolKind":"property","roleHeading":"Instance Property","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"keyType"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"externalID":"s:5Auth03JWKV7keyTypeSSvp"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/keyType","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"url":"\/documentation\/auth0\/jwk","title":"JWK","abstract":[{"type":"text","text":"Cryptographic public key of your Auth0 tenant."}],"navigatorTitle":[{"kind":"identifier","text":"JWK"}],"fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"JWK"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/JWK/keyType":{"type":"topic","abstract":[{"type":"text","text":"The type of key."}],"title":"keyType","url":"\/documentation\/auth0\/jwk\/keytype","kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"keyType","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/keyType"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ 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 ff00ba1da..3044d566e 100644 --- a/docs/data/documentation/auth0/jwk/modulus.json +++ b/docs/data/documentation/auth0/jwk/modulus.json @@ -1 +1 @@ -{"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"modulus","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"languages":["swift"]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"modules":[{"name":"Auth0"}],"externalID":"s:5Auth03JWKV7modulusSSSgvp","role":"symbol","title":"modulus","roleHeading":"Instance Property","symbolKind":"property","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"modulus"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/modulus","interfaceLanguage":"swift"},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/jwk\/modulus"]}],"abstract":[{"type":"text","text":"The modulus of the key."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"abstract":[{"text":"Cryptographic public key of your Auth0 tenant.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"JWK"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"JWK"}],"url":"\/documentation\/auth0\/jwk","role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","title":"JWK","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/JWK/modulus":{"url":"\/documentation\/auth0\/jwk\/modulus","kind":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"modulus","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"type":"topic","title":"modulus","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/modulus","role":"symbol","abstract":[{"text":"The modulus of the key.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK"]]},"metadata":{"symbolKind":"property","modules":[{"name":"Auth0"}],"title":"modulus","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"modulus"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"externalID":"s:5Auth03JWKV7modulusSSSgvp","role":"symbol","roleHeading":"Instance Property"},"sections":[],"abstract":[{"text":"The modulus of the key.","type":"text"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/jwk\/modulus"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/modulus","interfaceLanguage":"swift"},"kind":"symbol","schemaVersion":{"minor":3,"patch":0,"major":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"modulus"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"languages":["swift"],"platforms":["iOS"]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"url":"\/documentation\/auth0\/jwk","title":"JWK","abstract":[{"type":"text","text":"Cryptographic public key of your Auth0 tenant."}],"navigatorTitle":[{"kind":"identifier","text":"JWK"}],"fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"JWK"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/JWK/modulus":{"type":"topic","title":"modulus","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/modulus","url":"\/documentation\/auth0\/jwk\/modulus","abstract":[{"type":"text","text":"The modulus of the key."}],"kind":"symbol","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"modulus","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ 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 df2a9fbb7..22908c1cf 100644 --- a/docs/data/documentation/auth0/jwk/usage.json +++ b/docs/data/documentation/auth0/jwk/usage.json @@ -1 +1 @@ -{"metadata":{"modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"usage"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"symbolKind":"property","title":"usage","role":"symbol","roleHeading":"Instance Property","externalID":"s:5Auth03JWKV5usageSSSgvp"},"abstract":[{"type":"text","text":"How the key is meant to be used."}],"kind":"symbol","schemaVersion":{"patch":0,"major":0,"minor":3},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"usage"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"platforms":["iOS"],"languages":["swift"]}]}],"variants":[{"paths":["\/documentation\/auth0\/jwk\/usage"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/usage","interfaceLanguage":"swift"},"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/JWK/usage":{"url":"\/documentation\/auth0\/jwk\/usage","kind":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"usage","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"type":"topic","title":"usage","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/usage","role":"symbol","abstract":[{"type":"text","text":"How the key is meant to be used."}]},"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"abstract":[{"text":"Cryptographic public key of your Auth0 tenant.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"JWK"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"JWK"}],"url":"\/documentation\/auth0\/jwk","role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","title":"JWK","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"abstract":[{"type":"text","text":"How the key is meant to be used."}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"usage"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}]}],"kind":"declarations"}],"variants":[{"paths":["\/documentation\/auth0\/jwk\/usage"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK"]]},"metadata":{"modules":[{"name":"Auth0"}],"symbolKind":"property","roleHeading":"Instance Property","title":"usage","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"usage"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"externalID":"s:5Auth03JWKV5usageSSSgvp"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/usage"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"url":"\/documentation\/auth0\/jwk","title":"JWK","abstract":[{"type":"text","text":"Cryptographic public key of your Auth0 tenant."}],"navigatorTitle":[{"kind":"identifier","text":"JWK"}],"fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"JWK"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/JWK/usage":{"url":"\/documentation\/auth0\/jwk\/usage","abstract":[{"type":"text","text":"How the key is meant to be used."}],"title":"usage","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"usage","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK\/usage","role":"symbol","kind":"symbol","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/jwks.json b/docs/data/documentation/auth0/jwks.json index 84a54a951..e095a3141 100644 --- a/docs/data/documentation/auth0/jwks.json +++ b/docs/data/documentation/auth0/jwks.json @@ -1 +1 @@ -{"kind":"symbol","topicSections":[{"generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS\/init(from:)"],"anchor":"Initializers","title":"Initializers"},{"generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS\/keys"],"anchor":"Instance-Properties","title":"Instance Properties"},{"generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS\/key(id:)"],"anchor":"Instance-Methods","title":"Instance Methods"}],"relationshipsSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/Se","doc:\/\/com.auth0.Auth0\/SE","doc:\/\/com.auth0.Auth0\/s8SendableP","doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP"],"title":"Conforms To","kind":"relationships","type":"conformsTo"}],"sections":[],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"JWKS"}]}],"kind":"declarations"}],"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/json-web-tokens\/json-web-key-sets"],"anchor":"Related-Documentation","title":"Related Documentation"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"metadata":{"externalID":"s:5Auth04JWKSV","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"JWKS","kind":"identifier"}],"title":"JWKS","roleHeading":"Structure","symbolKind":"struct","navigatorTitle":[{"kind":"identifier","text":"JWKS"}],"modules":[{"name":"Auth0"}],"role":"symbol"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"The JSON Web Key Set (JWKS) of your Auth0 tenant."}],"schemaVersion":{"major":0,"minor":3,"patch":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/jwks"]}],"references":{"doc://com.auth0.Auth0/s16SendableMetatypeP":{"type":"unresolvable","title":"Swift.SendableMetatype","identifier":"doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP"},"doc://com.auth0.Auth0/s8SendableP":{"title":"Swift.Sendable","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s8SendableP"},"doc://com.auth0.Auth0/SE":{"type":"unresolvable","title":"Swift.Encodable","identifier":"doc:\/\/com.auth0.Auth0\/SE"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/Se":{"title":"Swift.Decodable","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/Se"},"doc://com.auth0.Auth0/documentation/Auth0/JWKS":{"navigatorTitle":[{"text":"JWKS","kind":"identifier"}],"title":"JWKS","role":"symbol","url":"\/documentation\/auth0\/jwks","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS","abstract":[{"text":"The JSON Web Key Set (JWKS) of your Auth0 tenant.","type":"text"}],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"JWKS","kind":"identifier"}]},"https://auth0.com/docs/secure/tokens/json-web-tokens/json-web-key-sets":{"type":"link","title":"JSON Web Key Sets","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/json-web-tokens\/json-web-key-sets","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/key(id:)":{"url":"\/documentation\/auth0\/jwks\/key(id:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"key","kind":"identifier"},{"text":"(","kind":"text"},{"text":"id","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"JWK","kind":"typeIdentifier","preciseIdentifier":"s:5Auth03JWKV"},{"text":"?","kind":"text"}],"type":"topic","title":"key(id:)","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:)","kind":"symbol","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/JWKS/init(from:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS\/init(from:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": any "},{"preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier","text":"Decoder"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"title":"init(from:)","kind":"symbol","abstract":[],"type":"topic","role":"symbol","url":"\/documentation\/auth0\/jwks\/init(from:)"},"doc://com.auth0.Auth0/documentation/Auth0/JWKS/keys":{"role":"symbol","abstract":[{"type":"text","text":"The keys in the key set."}],"kind":"symbol","url":"\/documentation\/auth0\/jwks\/keys","type":"topic","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"JWK","preciseIdentifier":"s:5Auth03JWKV"},{"kind":"text","text":"]"}],"title":"keys","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS\/keys"}}} \ No newline at end of file +{"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS\/init(from:)"],"title":"Initializers","generated":true,"anchor":"Initializers"},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS\/keys"],"title":"Instance Properties","generated":true,"anchor":"Instance-Properties"},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS\/key(id:)"],"title":"Instance Methods","generated":true,"anchor":"Instance-Methods"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"metadata":{"symbolKind":"struct","modules":[{"name":"Auth0"}],"title":"JWKS","navigatorTitle":[{"kind":"identifier","text":"JWKS"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"JWKS","kind":"identifier"}],"externalID":"s:5Auth04JWKSV","role":"symbol","roleHeading":"Structure"},"sections":[],"abstract":[{"text":"The JSON Web Key Set (JWKS) of your Auth0 tenant.","type":"text"}],"relationshipsSections":[{"kind":"relationships","identifiers":["doc:\/\/com.auth0.Auth0\/Se","doc:\/\/com.auth0.Auth0\/SE","doc:\/\/com.auth0.Auth0\/s8SendableP","doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP"],"type":"conformsTo","title":"Conforms To"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/jwks"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS"},"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/json-web-tokens\/json-web-key-sets"],"title":"Related Documentation","anchor":"Related-Documentation"}],"kind":"symbol","schemaVersion":{"minor":3,"patch":0,"major":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"JWKS","kind":"identifier"}],"languages":["swift"],"platforms":["iOS"]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/JWKS/key(id:)":{"url":"\/documentation\/auth0\/jwks\/key(id:)","abstract":[{"text":"Gets a key from the key set by its identifier (","type":"text"},{"code":"kid","type":"codeVoice"},{"text":").","type":"text"}],"title":"key(id:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"key"},{"kind":"text","text":"("},{"kind":"externalParam","text":"id"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth03JWKV","text":"JWK"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS\/key(id:)","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/JWKS/keys":{"url":"\/documentation\/auth0\/jwks\/keys","abstract":[{"text":"The keys in the key set.","type":"text"}],"title":"keys","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth03JWKV","text":"JWK"},{"kind":"text","text":"]"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS\/keys","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/SE":{"type":"unresolvable","title":"Swift.Encodable","identifier":"doc:\/\/com.auth0.Auth0\/SE"},"doc://com.auth0.Auth0/Se":{"type":"unresolvable","title":"Swift.Decodable","identifier":"doc:\/\/com.auth0.Auth0\/Se"},"doc://com.auth0.Auth0/s8SendableP":{"type":"unresolvable","title":"Swift.Sendable","identifier":"doc:\/\/com.auth0.Auth0\/s8SendableP"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/JWKS/init(from:)":{"url":"\/documentation\/auth0\/jwks\/init(from:)","abstract":[],"title":"init(from:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": any "},{"kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP","text":"Decoder"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS\/init(from:)","role":"symbol","kind":"symbol","type":"topic"},"https://auth0.com/docs/secure/tokens/json-web-tokens/json-web-key-sets":{"titleInlineContent":[{"text":"JSON Web Key Sets","type":"text"}],"url":"https:\/\/auth0.com\/docs\/secure\/tokens\/json-web-tokens\/json-web-key-sets","type":"link","title":"JSON Web Key Sets","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/json-web-tokens\/json-web-key-sets"},"doc://com.auth0.Auth0/s16SendableMetatypeP":{"type":"unresolvable","title":"Swift.SendableMetatype","identifier":"doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP"},"doc://com.auth0.Auth0/documentation/Auth0/JWKS":{"role":"symbol","title":"JWKS","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"JWKS"}],"navigatorTitle":[{"kind":"identifier","text":"JWKS"}],"abstract":[{"type":"text","text":"The JSON Web Key Set (JWKS) of your Auth0 tenant."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS","url":"\/documentation\/auth0\/jwks","type":"topic"}}} \ 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 6e18b802d..3ac3b6f8b 100644 --- a/docs/data/documentation/auth0/jwks/init(from:).json +++ b/docs/data/documentation/auth0/jwks/init(from:).json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"init","kind":"keyword"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"decoder","kind":"internalParam"},{"text":": any ","kind":"text"},{"text":"Decoder","preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}]}]}],"abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"Decodable.init(from:)"},{"type":"text","text":"."}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS"]]},"metadata":{"modules":[{"name":"Auth0"}],"role":"symbol","title":"init(from:)","symbolKind":"init","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":": any ","kind":"text"},{"preciseIdentifier":"s:s7DecoderP","text":"Decoder","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"roleHeading":"Initializer","externalID":"s:5Auth04JWKSV4fromACs7Decoder_p_tKcfc"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS\/init(from:)","interfaceLanguage":"swift"},"schemaVersion":{"minor":3,"patch":0,"major":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/jwks\/init(from:)"]}],"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/JWKS/init(from:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS\/init(from:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": any "},{"preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier","text":"Decoder"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"title":"init(from:)","kind":"symbol","abstract":[],"type":"topic","role":"symbol","url":"\/documentation\/auth0\/jwks\/init(from:)"},"doc://com.auth0.Auth0/documentation/Auth0/JWKS":{"navigatorTitle":[{"text":"JWKS","kind":"identifier"}],"title":"JWKS","role":"symbol","url":"\/documentation\/auth0\/jwks","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS","abstract":[{"text":"The JSON Web Key Set (JWKS) of your Auth0 tenant.","type":"text"}],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"JWKS","kind":"identifier"}]}}} \ No newline at end of file +{"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS\/init(from:)","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"init","kind":"keyword"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"kind":"text","text":" "},{"text":"decoder","kind":"internalParam"},{"kind":"text","text":": any "},{"kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP","text":"Decoder"},{"text":") ","kind":"text"},{"kind":"keyword","text":"throws"}],"platforms":["iOS"]}]}],"variants":[{"paths":["\/documentation\/auth0\/jwks\/init(from:)"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","metadata":{"modules":[{"name":"Auth0"}],"title":"init(from:)","externalID":"s:5Auth04JWKSV4fromACs7Decoder_p_tKcfc","role":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":": any ","kind":"text"},{"text":"Decoder","preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"symbolKind":"init","roleHeading":"Initializer"},"schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"text":"Inherited from ","type":"text"},{"code":"Decodable.init(from:)","type":"codeVoice"},{"text":".","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/JWKS":{"role":"symbol","title":"JWKS","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"JWKS"}],"navigatorTitle":[{"kind":"identifier","text":"JWKS"}],"abstract":[{"type":"text","text":"The JSON Web Key Set (JWKS) of your Auth0 tenant."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS","url":"\/documentation\/auth0\/jwks","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/JWKS/init(from:)":{"url":"\/documentation\/auth0\/jwks\/init(from:)","abstract":[],"title":"init(from:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": any "},{"kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP","text":"Decoder"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS\/init(from:)","role":"symbol","kind":"symbol","type":"topic"}}} \ 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 73030a76a..284b770b2 100644 --- a/docs/data/documentation/auth0/jwks/key(id:).json +++ b/docs/data/documentation/auth0/jwks/key(id:).json @@ -1 +1 @@ -{"sections":[],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS"]]},"schemaVersion":{"minor":3,"patch":0,"major":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS\/key(id:)"},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"key"},{"kind":"text","text":"("},{"kind":"externalParam","text":"id"},{"kind":"text","text":" "},{"kind":"internalParam","text":"kid"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth03JWKV","kind":"typeIdentifier","text":"JWK","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK"},{"kind":"text","text":"?"}],"languages":["swift"],"platforms":["iOS"]}]}],"variants":[{"paths":["\/documentation\/auth0\/jwks\/key(id:)"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"type":"text","text":"Gets a key from the key set by its identifier ("},{"type":"codeVoice","code":"kid"},{"type":"text","text":")."}],"metadata":{"externalID":"s:5Auth04JWKSV3key2idAA3JWKVSgSS_tF","symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"key","kind":"identifier"},{"text":"(","kind":"text"},{"text":"id","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth03JWKV","text":"JWK","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"extendedModule":"Auth0","title":"key(id:)","role":"symbol","modules":[{"name":"Auth0"}],"roleHeading":"Instance Method"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/JWKS/key(id:)":{"url":"\/documentation\/auth0\/jwks\/key(id:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"key","kind":"identifier"},{"text":"(","kind":"text"},{"text":"id","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"JWK","kind":"typeIdentifier","preciseIdentifier":"s:5Auth03JWKV"},{"text":"?","kind":"text"}],"type":"topic","title":"key(id:)","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:)","kind":"symbol","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"abstract":[{"text":"Cryptographic public key of your Auth0 tenant.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"JWK"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"JWK"}],"url":"\/documentation\/auth0\/jwk","role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","title":"JWK","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/JWKS":{"navigatorTitle":[{"text":"JWKS","kind":"identifier"}],"title":"JWKS","role":"symbol","url":"\/documentation\/auth0\/jwks","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS","abstract":[{"text":"The JSON Web Key Set (JWKS) of your Auth0 tenant.","type":"text"}],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"JWKS","kind":"identifier"}]}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/jwks\/key(id:)"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS"]]},"abstract":[{"type":"text","text":"Gets a key from the key set by its identifier ("},{"type":"codeVoice","code":"kid"},{"type":"text","text":")."}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"key"},{"kind":"text","text":"("},{"kind":"externalParam","text":"id"},{"kind":"text","text":" "},{"kind":"internalParam","text":"kid"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","kind":"typeIdentifier","text":"JWK","preciseIdentifier":"s:5Auth03JWKV"},{"kind":"text","text":"?"}]}],"kind":"declarations"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","sections":[],"metadata":{"externalID":"s:5Auth04JWKSV3key2idAA3JWKVSgSS_tF","extendedModule":"Auth0","symbolKind":"method","title":"key(id:)","roleHeading":"Instance Method","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"key"},{"kind":"text","text":"("},{"kind":"externalParam","text":"id"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth03JWKV","text":"JWK"},{"kind":"text","text":"?"}],"modules":[{"name":"Auth0"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS\/key(id:)","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/JWKS":{"role":"symbol","title":"JWKS","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"JWKS"}],"navigatorTitle":[{"kind":"identifier","text":"JWKS"}],"abstract":[{"type":"text","text":"The JSON Web Key Set (JWKS) of your Auth0 tenant."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS","url":"\/documentation\/auth0\/jwks","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/JWKS/key(id:)":{"url":"\/documentation\/auth0\/jwks\/key(id:)","abstract":[{"text":"Gets a key from the key set by its identifier (","type":"text"},{"code":"kid","type":"codeVoice"},{"text":").","type":"text"}],"title":"key(id:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"key"},{"kind":"text","text":"("},{"kind":"externalParam","text":"id"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth03JWKV","text":"JWK"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS\/key(id:)","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"url":"\/documentation\/auth0\/jwk","title":"JWK","abstract":[{"type":"text","text":"Cryptographic public key of your Auth0 tenant."}],"navigatorTitle":[{"kind":"identifier","text":"JWK"}],"fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"JWK"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","role":"symbol","kind":"symbol","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/jwks/keys.json b/docs/data/documentation/auth0/jwks/keys.json index 3a461575d..e6ec3cb9f 100644 --- a/docs/data/documentation/auth0/jwks/keys.json +++ b/docs/data/documentation/auth0/jwks/keys.json @@ -1 +1 @@ -{"schemaVersion":{"minor":3,"major":0,"patch":0},"abstract":[{"type":"text","text":"The keys in the key set."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"JWK","preciseIdentifier":"s:5Auth03JWKV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK"},{"kind":"text","text":"]"}]}]}],"metadata":{"roleHeading":"Instance Property","externalID":"s:5Auth04JWKSV4keysSayAA3JWKVGvp","title":"keys","modules":[{"name":"Auth0"}],"role":"symbol","symbolKind":"property","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth03JWKV","text":"JWK"},{"kind":"text","text":"]"}]},"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"]]},"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/jwks\/keys"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"abstract":[{"text":"Cryptographic public key of your Auth0 tenant.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"JWK"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"JWK"}],"url":"\/documentation\/auth0\/jwk","role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","title":"JWK","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/JWKS":{"navigatorTitle":[{"text":"JWKS","kind":"identifier"}],"title":"JWKS","role":"symbol","url":"\/documentation\/auth0\/jwks","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS","abstract":[{"text":"The JSON Web Key Set (JWKS) of your Auth0 tenant.","type":"text"}],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"JWKS","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/JWKS/keys":{"role":"symbol","abstract":[{"type":"text","text":"The keys in the key set."}],"kind":"symbol","url":"\/documentation\/auth0\/jwks\/keys","type":"topic","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"JWK","preciseIdentifier":"s:5Auth03JWKV"},{"kind":"text","text":"]"}],"title":"keys","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS\/keys"}}} \ No newline at end of file +{"metadata":{"symbolKind":"property","title":"keys","externalID":"s:5Auth04JWKSV4keysSayAA3JWKVGvp","roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"keys","kind":"identifier"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:5Auth03JWKV","text":"JWK","kind":"typeIdentifier"},{"text":"]","kind":"text"}],"role":"symbol"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/jwks\/keys"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS\/keys"},"kind":"symbol","abstract":[{"type":"text","text":"The keys in the key set."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"keys","kind":"identifier"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:5Auth03JWKV","text":"JWK","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK"},{"text":"]","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]}],"schemaVersion":{"patch":0,"minor":3,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/JWKS/keys":{"url":"\/documentation\/auth0\/jwks\/keys","abstract":[{"text":"The keys in the key set.","type":"text"}],"title":"keys","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"keys"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth03JWKV","text":"JWK"},{"kind":"text","text":"]"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS\/keys","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/JWKS":{"role":"symbol","title":"JWKS","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"JWKS"}],"navigatorTitle":[{"kind":"identifier","text":"JWKS"}],"abstract":[{"type":"text","text":"The JSON Web Key Set (JWKS) of your Auth0 tenant."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWKS","url":"\/documentation\/auth0\/jwks","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/JWK":{"url":"\/documentation\/auth0\/jwk","title":"JWK","abstract":[{"type":"text","text":"Cryptographic public key of your Auth0 tenant."}],"navigatorTitle":[{"kind":"identifier","text":"JWK"}],"fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"JWK"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/JWK","role":"symbol","kind":"symbol","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/loggable.json b/docs/data/documentation/auth0/loggable.json index 0a8d67770..bf41b18e9 100644 --- a/docs/data/documentation/auth0/loggable.json +++ b/docs/data/documentation/auth0/loggable.json @@ -1 +1 @@ -{"abstract":[{"text":"A type that can log statements for debugging purposes.","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Loggable","kind":"identifier"}]}],"kind":"declarations"}],"topicSections":[{"generated":true,"title":"Instance Properties","anchor":"Instance-Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable\/logger"]},{"generated":true,"title":"Instance Methods","anchor":"Instance-Methods","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable\/logging(enabled:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable\/using(logger:)"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable"},"metadata":{"modules":[{"name":"Auth0"}],"title":"Loggable","roleHeading":"Protocol","navigatorTitle":[{"text":"Loggable","kind":"identifier"}],"symbolKind":"protocol","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Loggable"}],"externalID":"s:5Auth08LoggableP"},"variants":[{"paths":["\/documentation\/auth0\/loggable"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","relationshipsSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccount","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountClient","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"],"type":"inheritedBy","title":"Inherited By","kind":"relationships"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Loggable/using(logger:)":{"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"using","kind":"identifier"},{"text":"(","kind":"text"},{"text":"logger","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth06LoggerP","text":"Logger","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable\/using(logger:)","kind":"symbol","abstract":[{"type":"text","text":"Turn on Auth0.swift debug logging of HTTP requests and responses with a custom logger."}],"title":"using(logger:)","url":"\/documentation\/auth0\/loggable\/using(logger:)","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountClient":{"type":"topic","title":"MyAccountClient","kind":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountClient","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountClient","navigatorTitle":[{"text":"MyAccountClient","kind":"identifier"}],"role":"symbol","abstract":[{"type":"text","text":"A client for the My Account API."},{"type":"text","text":" "},{"type":"text","text":"Adopting types could be either the root client or a leaf sub-client."}],"url":"\/documentation\/auth0\/myaccountclient"},"doc://com.auth0.Auth0/documentation/Auth0/Loggable":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","abstract":[{"type":"text","text":"A type that can log statements for debugging purposes."}],"fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Loggable","kind":"identifier"}],"kind":"symbol","title":"Loggable","type":"topic","role":"symbol","navigatorTitle":[{"text":"Loggable","kind":"identifier"}],"url":"\/documentation\/auth0\/loggable"},"https://auth0.com/docs/api/authentication":{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","url":"https:\/\/auth0.com\/docs\/api\/authentication","type":"link","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"title":"Auth0 Authentication API"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccount":{"fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccount","kind":"identifier"}],"type":"topic","kind":"symbol","url":"\/documentation\/auth0\/myaccount","navigatorTitle":[{"text":"MyAccount","kind":"identifier"}],"abstract":[{"type":"text","text":"My Account API client for managing the current user’s account."}],"title":"MyAccount","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccount"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"title":"WebAuth","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"url":"\/documentation\/auth0\/webauth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods":{"url":"\/documentation\/auth0\/myaccountauthenticationmethods","kind":"symbol","type":"topic","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountAuthenticationMethods","kind":"identifier"}],"navigatorTitle":[{"text":"MyAccountAuthenticationMethods","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods","title":"MyAccountAuthenticationMethods","abstract":[{"type":"text","text":"My Account API sub-client for managing the current user’s authentication methods."}]},"doc://com.auth0.Auth0/documentation/Auth0/Loggable/logging(enabled:)":{"type":"topic","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."}],"title":"logging(enabled:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"logging","kind":"identifier"},{"text":"(","kind":"text"},{"text":"enabled","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"url":"\/documentation\/auth0\/loggable\/logging(enabled:)","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Loggable/logger":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable\/logger","abstract":[{"text":"Logger used to print log statements.","type":"text"}],"url":"\/documentation\/auth0\/loggable\/logger","role":"symbol","required":true,"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"logger","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth06LoggerP","text":"Logger","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"type":"topic","title":"logger","kind":"symbol"},"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","titleInlineContent":[{"type":"text","text":"Management API v2"}],"title":"Management API v2"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"type":"topic","role":"symbol","title":"Authentication","abstract":[{"text":"Client for the ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"text":".","type":"text"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"type":"topic","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Users","kind":"identifier"}],"title":"Users","navigatorTitle":[{"text":"Users","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","url":"\/documentation\/auth0\/users","kind":"symbol","abstract":[{"type":"text","text":"Client for the Users endpoints of the Auth0 "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"type":"text","text":"."}],"role":"symbol"}}} \ No newline at end of file +{"metadata":{"symbolKind":"protocol","title":"Loggable","roleHeading":"Protocol","externalID":"s:5Auth08LoggableP","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Loggable"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Loggable"}]},"sections":[],"variants":[{"paths":["\/documentation\/auth0\/loggable"],"traits":[{"interfaceLanguage":"swift"}]}],"relationshipsSections":[{"title":"Inherited By","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccount","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountClient","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"],"kind":"relationships","type":"inheritedBy"}],"topicSections":[{"title":"Instance Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable\/logger"],"anchor":"Instance-Properties","generated":true},{"title":"Instance Methods","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable\/logging(enabled:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable\/using(logger:)"],"anchor":"Instance-Methods","generated":true}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"type":"text","text":"A type that can log statements for debugging purposes."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Loggable"}],"languages":["swift"],"platforms":["iOS"]}]}],"schemaVersion":{"major":0,"patch":0,"minor":3},"references":{"https://auth0.com/docs/api/management/v2":{"title":"Management API v2","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","titleInlineContent":[{"type":"text","text":"Management API v2"}],"type":"link","url":"https:\/\/auth0.com\/docs\/api\/management\/v2"},"doc://com.auth0.Auth0/documentation/Auth0/Loggable":{"role":"symbol","title":"Loggable","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Loggable"}],"navigatorTitle":[{"text":"Loggable","kind":"identifier"}],"abstract":[{"text":"A type that can log statements for debugging purposes.","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/loggable","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Loggable/logging(enabled:)":{"type":"topic","title":"logging(enabled:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable\/logging(enabled:)","kind":"symbol","url":"\/documentation\/auth0\/loggable\/logging(enabled:)","abstract":[{"type":"text","text":"Turn on\/off Auth0.swift debug logging of HTTP requests and responses."}],"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"logging"},{"kind":"text","text":"("},{"kind":"externalParam","text":"enabled"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountClient":{"title":"MyAccountClient","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountClient","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccountClient"}],"abstract":[{"text":"A client for the My Account API.","type":"text"},{"text":" ","type":"text"},{"text":"Adopting types could be either the root client or a leaf sub-client.","type":"text"}],"url":"\/documentation\/auth0\/myaccountclient","navigatorTitle":[{"kind":"identifier","text":"MyAccountClient"}]},"https://auth0.com/docs/api/authentication":{"title":"Auth0 Authentication API","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","titleInlineContent":[{"type":"text","text":"Auth0 Authentication API"}],"type":"link","url":"https:\/\/auth0.com\/docs\/api\/authentication"},"doc://com.auth0.Auth0/documentation/Auth0/Loggable/logger":{"type":"topic","title":"logger","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable\/logger","kind":"symbol","url":"\/documentation\/auth0\/loggable\/logger","abstract":[{"type":"text","text":"Logger used to print log statements."}],"required":true,"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"logger"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Logger","preciseIdentifier":"s:5Auth06LoggerP"},{"kind":"text","text":"?"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","abstract":[{"type":"text","text":"Client for the "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","isActive":true},{"type":"text","text":"."}],"type":"topic","title":"Authentication","url":"\/documentation\/auth0\/authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Loggable/using(logger:)":{"type":"topic","title":"using(logger:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable\/using(logger:)","kind":"symbol","url":"\/documentation\/auth0\/loggable\/using(logger:)","abstract":[{"type":"text","text":"Turn on Auth0.swift debug logging of HTTP requests and responses with a custom logger."}],"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"using"},{"kind":"text","text":"("},{"kind":"externalParam","text":"logger"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Logger","preciseIdentifier":"s:5Auth06LoggerP"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}]},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"url":"\/documentation\/auth0\/users","title":"Users","abstract":[{"type":"text","text":"Client for the Users endpoints of the Auth0 "},{"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","type":"reference","isActive":true},{"text":".","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"Users"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Users"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods":{"role":"symbol","title":"MyAccountAuthenticationMethods","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"MyAccountAuthenticationMethods"}],"navigatorTitle":[{"text":"MyAccountAuthenticationMethods","kind":"identifier"}],"abstract":[{"type":"text","text":"My Account API sub-client for managing the current user’s authentication methods."}],"kind":"symbol","url":"\/documentation\/auth0\/myaccountauthenticationmethods","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccount":{"url":"\/documentation\/auth0\/myaccount","abstract":[{"type":"text","text":"My Account API client for managing the current user’s account."}],"title":"MyAccount","navigatorTitle":[{"text":"MyAccount","kind":"identifier"}],"fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccount"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccount","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"url":"\/documentation\/auth0\/webauth","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"title":"WebAuth","navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","role":"symbol","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 6731edd6c..7552c1b9f 100644 --- a/docs/data/documentation/auth0/loggable/logger.json +++ b/docs/data/documentation/auth0/loggable/logger.json @@ -1 +1 @@ -{"metadata":{"role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"logger","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Logger","kind":"typeIdentifier","preciseIdentifier":"s:5Auth06LoggerP"},{"text":"?","kind":"text"}],"symbolKind":"property","roleHeading":"Instance Property","externalID":"s:5Auth08LoggableP6loggerAA6Logger_pSgvp","modules":[{"name":"Auth0"}],"title":"logger","required":true},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable\/logger"},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"logger","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Logger","preciseIdentifier":"s:5Auth06LoggerP","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger","kind":"typeIdentifier"},{"text":"? { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" ","kind":"text"},{"text":"set","kind":"keyword"},{"text":" }","kind":"text"}],"languages":["swift"]}],"kind":"declarations"}],"variants":[{"paths":["\/documentation\/auth0\/loggable\/logger"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable"]]},"schemaVersion":{"minor":3,"major":0,"patch":0},"abstract":[{"type":"text","text":"Logger used to print log statements."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Loggable/logger":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable\/logger","abstract":[{"text":"Logger used to print log statements.","type":"text"}],"url":"\/documentation\/auth0\/loggable\/logger","role":"symbol","required":true,"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"logger","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth06LoggerP","text":"Logger","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"type":"topic","title":"logger","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Logger":{"navigatorTitle":[{"kind":"identifier","text":"Logger"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger","role":"symbol","abstract":[{"type":"text","text":"Logger for debugging purposes."}],"kind":"symbol","url":"\/documentation\/auth0\/logger","type":"topic","title":"Logger","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Logger"}]},"doc://com.auth0.Auth0/documentation/Auth0/Loggable":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","abstract":[{"type":"text","text":"A type that can log statements for debugging purposes."}],"fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Loggable","kind":"identifier"}],"kind":"symbol","title":"Loggable","type":"topic","role":"symbol","navigatorTitle":[{"text":"Loggable","kind":"identifier"}],"url":"\/documentation\/auth0\/loggable"}}} \ No newline at end of file +{"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"logger"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth06LoggerP","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger","text":"Logger"},{"kind":"text","text":"? { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" "},{"kind":"keyword","text":"set"},{"kind":"text","text":" }"}]}],"kind":"declarations"}],"sections":[],"abstract":[{"type":"text","text":"Logger used to print log statements."}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/loggable\/logger"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable\/logger","interfaceLanguage":"swift"},"metadata":{"role":"symbol","title":"logger","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"logger"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth06LoggerP","text":"Logger"},{"kind":"text","text":"?"}],"externalID":"s:5Auth08LoggableP6loggerAA6Logger_pSgvp","roleHeading":"Instance Property","required":true,"symbolKind":"property"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Loggable":{"role":"symbol","title":"Loggable","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Loggable"}],"navigatorTitle":[{"text":"Loggable","kind":"identifier"}],"abstract":[{"text":"A type that can log statements for debugging purposes.","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/loggable","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Loggable/logger":{"type":"topic","title":"logger","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable\/logger","kind":"symbol","url":"\/documentation\/auth0\/loggable\/logger","abstract":[{"type":"text","text":"Logger used to print log statements."}],"required":true,"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"logger"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Logger","preciseIdentifier":"s:5Auth06LoggerP"},{"kind":"text","text":"?"}]},"doc://com.auth0.Auth0/documentation/Auth0/Logger":{"title":"Logger","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Logger"}],"abstract":[{"text":"Logger for debugging purposes.","type":"text"}],"url":"\/documentation\/auth0\/logger","navigatorTitle":[{"kind":"identifier","text":"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 e4c4e0f91..ad4b0f4d9 100644 --- a/docs/data/documentation/auth0/loggable/logging(enabled:).json +++ b/docs/data/documentation/auth0/loggable/logging(enabled:).json @@ -1 +1 @@ -{"primaryContentSections":[{"declarations":[{"tokens":[{"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"},{"text":"Self","kind":"typeIdentifier"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"},{"parameters":[{"name":"enabled","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Flag to turn logging on\/off."}]}]}],"kind":"parameters"},{"content":[{"text":"Discussion","type":"heading","level":2,"anchor":"discussion"},{"name":"Note","type":"aside","content":[{"inlineContent":[{"type":"text","text":"By default all logging is "},{"inlineContent":[{"text":"disabled","type":"text"}],"type":"strong"},{"type":"text","text":"."}],"type":"paragraph"}],"style":"note"},{"name":"Important","type":"aside","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"For the flag to take effect, logging should be turned on\/off "},{"type":"strong","inlineContent":[{"text":"before","type":"text"}]},{"type":"text","text":" making requests to Auth0."}]}],"style":"important"}],"kind":"content"}],"abstract":[{"type":"text","text":"Turn on\/off Auth0.swift debug logging of HTTP requests and responses."}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable"]]},"metadata":{"role":"symbol","externalID":"s:5Auth08LoggablePAAE7logging7enabledxSb_tF","title":"logging(enabled:)","roleHeading":"Instance Method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"logging","kind":"identifier"},{"text":"(","kind":"text"},{"text":"enabled","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"modules":[{"name":"Auth0"}],"extendedModule":"Auth0","symbolKind":"method"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable\/logging(enabled:)"},"schemaVersion":{"minor":3,"major":0,"patch":0},"variants":[{"paths":["\/documentation\/auth0\/loggable\/logging(enabled:)"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Loggable":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","abstract":[{"type":"text","text":"A type that can log statements for debugging purposes."}],"fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Loggable","kind":"identifier"}],"kind":"symbol","title":"Loggable","type":"topic","role":"symbol","navigatorTitle":[{"text":"Loggable","kind":"identifier"}],"url":"\/documentation\/auth0\/loggable"},"doc://com.auth0.Auth0/documentation/Auth0/Loggable/logging(enabled:)":{"type":"topic","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."}],"title":"logging(enabled:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"logging","kind":"identifier"},{"text":"(","kind":"text"},{"text":"enabled","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"url":"\/documentation\/auth0\/loggable\/logging(enabled:)","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/loggable\/logging(enabled:)"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable"]]},"abstract":[{"text":"Turn on\/off Auth0.swift debug logging of HTTP requests and responses.","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"logging"},{"kind":"text","text":"("},{"kind":"externalParam","text":"enabled"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"languages":["swift"],"platforms":["iOS"]}]},{"parameters":[{"name":"enabled","content":[{"type":"paragraph","inlineContent":[{"text":"Flag to turn logging on\/off.","type":"text"}]}]}],"kind":"parameters"},{"kind":"content","content":[{"anchor":"discussion","text":"Discussion","type":"heading","level":2},{"name":"Note","type":"aside","style":"note","content":[{"type":"paragraph","inlineContent":[{"text":"By default all logging is ","type":"text"},{"inlineContent":[{"type":"text","text":"disabled"}],"type":"strong"},{"text":".","type":"text"}]}]},{"name":"Important","type":"aside","style":"important","content":[{"type":"paragraph","inlineContent":[{"text":"For the flag to take effect, logging should be turned on\/off ","type":"text"},{"inlineContent":[{"type":"text","text":"before"}],"type":"strong"},{"text":" making requests to Auth0.","type":"text"}]}]}]}],"kind":"symbol","sections":[],"schemaVersion":{"minor":3,"patch":0,"major":0},"metadata":{"externalID":"s:5Auth08LoggablePAAE7logging7enabledxSb_tF","extendedModule":"Auth0","symbolKind":"method","title":"logging(enabled:)","role":"symbol","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"logging"},{"kind":"text","text":"("},{"kind":"externalParam","text":"enabled"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"modules":[{"name":"Auth0"}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable\/logging(enabled:)"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Loggable/logging(enabled:)":{"type":"topic","title":"logging(enabled:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable\/logging(enabled:)","kind":"symbol","url":"\/documentation\/auth0\/loggable\/logging(enabled:)","abstract":[{"type":"text","text":"Turn on\/off Auth0.swift debug logging of HTTP requests and responses."}],"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"logging"},{"kind":"text","text":"("},{"kind":"externalParam","text":"enabled"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}]},"doc://com.auth0.Auth0/documentation/Auth0/Loggable":{"role":"symbol","title":"Loggable","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Loggable"}],"navigatorTitle":[{"text":"Loggable","kind":"identifier"}],"abstract":[{"text":"A type that can log statements for debugging purposes.","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/loggable","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ 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 318fd9f79..ac294a3b6 100644 --- a/docs/data/documentation/auth0/loggable/using(logger:).json +++ b/docs/data/documentation/auth0/loggable/using(logger:).json @@ -1 +1 @@ -{"schemaVersion":{"major":0,"patch":0,"minor":3},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"using","kind":"identifier"},{"text":"(","kind":"text"},{"text":"logger","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Logger","kind":"typeIdentifier","preciseIdentifier":"s:5Auth06LoggerP","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger"},{"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":[{"anchor":"discussion","type":"heading","text":"Discussion","level":2},{"style":"note","type":"aside","content":[{"inlineContent":[{"text":"By default all logging is ","type":"text"},{"inlineContent":[{"text":"disabled","type":"text"}],"type":"strong"},{"text":".","type":"text"}],"type":"paragraph"}],"name":"Note"},{"style":"important","type":"aside","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Logging should be turned on\/off "},{"inlineContent":[{"type":"text","text":"before"}],"type":"strong"},{"type":"text","text":" making request to Auth0 for the flag to take effect."}]}],"name":"Important"}],"kind":"content"}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/loggable\/using(logger:)"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable"]]},"sections":[],"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:)"},"metadata":{"symbolKind":"method","modules":[{"name":"Auth0"}],"title":"using(logger:)","extendedModule":"Auth0","externalID":"s:5Auth08LoggablePAAE5using6loggerxAA6Logger_p_tF","roleHeading":"Instance Method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"using","kind":"identifier"},{"text":"(","kind":"text"},{"text":"logger","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Logger","kind":"typeIdentifier","preciseIdentifier":"s:5Auth06LoggerP"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"role":"symbol"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Loggable":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","abstract":[{"type":"text","text":"A type that can log statements for debugging purposes."}],"fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Loggable","kind":"identifier"}],"kind":"symbol","title":"Loggable","type":"topic","role":"symbol","navigatorTitle":[{"text":"Loggable","kind":"identifier"}],"url":"\/documentation\/auth0\/loggable"},"doc://com.auth0.Auth0/documentation/Auth0/Logger":{"navigatorTitle":[{"kind":"identifier","text":"Logger"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger","role":"symbol","abstract":[{"type":"text","text":"Logger for debugging purposes."}],"kind":"symbol","url":"\/documentation\/auth0\/logger","type":"topic","title":"Logger","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Logger"}]},"doc://com.auth0.Auth0/documentation/Auth0/Loggable/using(logger:)":{"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"using","kind":"identifier"},{"text":"(","kind":"text"},{"text":"logger","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth06LoggerP","text":"Logger","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable\/using(logger:)","kind":"symbol","abstract":[{"type":"text","text":"Turn on Auth0.swift debug logging of HTTP requests and responses with a custom logger."}],"title":"using(logger:)","url":"\/documentation\/auth0\/loggable\/using(logger:)","type":"topic"}}} \ No newline at end of file +{"metadata":{"symbolKind":"method","roleHeading":"Instance Method","externalID":"s:5Auth08LoggablePAAE5using6loggerxAA6Logger_p_tF","extendedModule":"Auth0","title":"using(logger:)","modules":[{"name":"Auth0"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"using","kind":"identifier"},{"text":"(","kind":"text"},{"text":"logger","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Logger","preciseIdentifier":"s:5Auth06LoggerP","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"role":"symbol"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/loggable\/using(logger:)"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable\/using(logger:)","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"text":"Turn on Auth0.swift debug logging of HTTP requests and responses with a custom logger.","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"using"},{"kind":"text","text":"("},{"kind":"externalParam","text":"logger"},{"kind":"text","text":": "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger","kind":"typeIdentifier","text":"Logger","preciseIdentifier":"s:5Auth06LoggerP"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"platforms":["iOS"]}]},{"parameters":[{"name":"logger","content":[{"inlineContent":[{"type":"text","text":"Logger used to print log statements."}],"type":"paragraph"}]}],"kind":"parameters"},{"kind":"content","content":[{"level":2,"text":"Discussion","type":"heading","anchor":"discussion"},{"name":"Note","type":"aside","content":[{"inlineContent":[{"type":"text","text":"By default all logging is "},{"type":"strong","inlineContent":[{"type":"text","text":"disabled"}]},{"type":"text","text":"."}],"type":"paragraph"}],"style":"note"},{"name":"Important","type":"aside","content":[{"inlineContent":[{"type":"text","text":"Logging should be turned on\/off "},{"type":"strong","inlineContent":[{"type":"text","text":"before"}]},{"type":"text","text":" making request to Auth0 for the flag to take effect."}],"type":"paragraph"}],"style":"important"}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Loggable":{"role":"symbol","title":"Loggable","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Loggable"}],"navigatorTitle":[{"text":"Loggable","kind":"identifier"}],"abstract":[{"text":"A type that can log statements for debugging purposes.","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/loggable","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Logger":{"title":"Logger","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Logger"}],"abstract":[{"text":"Logger for debugging purposes.","type":"text"}],"url":"\/documentation\/auth0\/logger","navigatorTitle":[{"kind":"identifier","text":"Logger"}]},"doc://com.auth0.Auth0/documentation/Auth0/Loggable/using(logger:)":{"type":"topic","title":"using(logger:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable\/using(logger:)","kind":"symbol","url":"\/documentation\/auth0\/loggable\/using(logger:)","abstract":[{"type":"text","text":"Turn on Auth0.swift debug logging of HTTP requests and responses with a custom logger."}],"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"using"},{"kind":"text","text":"("},{"kind":"externalParam","text":"logger"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Logger","preciseIdentifier":"s:5Auth06LoggerP"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/logger.json b/docs/data/documentation/auth0/logger.json index 7d74aefcb..577a46c28 100644 --- a/docs/data/documentation/auth0/logger.json +++ b/docs/data/documentation/auth0/logger.json @@ -1 +1 @@ -{"metadata":{"symbolKind":"protocol","title":"Logger","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Logger"}],"externalID":"s:5Auth06LoggerP","navigatorTitle":[{"kind":"identifier","text":"Logger"}],"role":"symbol","modules":[{"name":"Auth0"}],"roleHeading":"Protocol"},"kind":"symbol","sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger","interfaceLanguage":"swift"},"schemaVersion":{"minor":3,"major":0,"patch":0},"topicSections":[{"title":"Instance Methods","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger\/trace(request:session:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger\/trace(response:data:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger\/trace(url:source:)"],"anchor":"Instance-Methods","generated":true}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Logger"}],"languages":["swift"],"platforms":["iOS"]}]}],"abstract":[{"type":"text","text":"Logger for debugging purposes."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/logger"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Logger/trace(response:data:)":{"role":"symbol","abstract":[{"type":"text","text":"Log an HTTP response."}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"trace"},{"kind":"text","text":"("},{"kind":"externalParam","text":"response"},{"kind":"text","text":": "},{"preciseIdentifier":"c:objc(cs)NSURLResponse","kind":"typeIdentifier","text":"URLResponse"},{"kind":"text","text":", "},{"kind":"externalParam","text":"data"},{"kind":"text","text":": "},{"preciseIdentifier":"s:10Foundation4DataV","kind":"typeIdentifier","text":"Data"},{"kind":"text","text":"?)"}],"required":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger\/trace(response:data:)","url":"\/documentation\/auth0\/logger\/trace(response:data:)","kind":"symbol","title":"trace(response:data:)","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Logger/trace(url:source:)":{"url":"\/documentation\/auth0\/logger\/trace(url:source:)","abstract":[{"type":"text","text":"Log a URL."}],"type":"topic","role":"symbol","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"trace","kind":"identifier"},{"text":"(","kind":"text"},{"text":"url","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"URL","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV"},{"text":", ","kind":"text"},{"text":"source","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?)","kind":"text"}],"title":"trace(url:source:)","required":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger\/trace(url:source:)"},"doc://com.auth0.Auth0/documentation/Auth0/Logger/trace(request:session:)":{"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"trace"},{"kind":"text","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":": "},{"kind":"typeIdentifier","text":"URLSession","preciseIdentifier":"c:objc(cs)NSURLSession"},{"kind":"text","text":")"}],"required":true,"url":"\/documentation\/auth0\/logger\/trace(request:session:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger\/trace(request:session:)","abstract":[{"text":"Log an HTTP request.","type":"text"}],"type":"topic","title":"trace(request:session:)"},"doc://com.auth0.Auth0/documentation/Auth0/Logger":{"navigatorTitle":[{"kind":"identifier","text":"Logger"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger","role":"symbol","abstract":[{"type":"text","text":"Logger for debugging purposes."}],"kind":"symbol","url":"\/documentation\/auth0\/logger","type":"topic","title":"Logger","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Logger"}]}}} \ No newline at end of file +{"abstract":[{"text":"Logger for debugging purposes.","type":"text"}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Logger"}],"platforms":["iOS"]}],"kind":"declarations"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/logger"]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"topicSections":[{"title":"Instance Methods","generated":true,"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:)"],"anchor":"Instance-Methods"}],"metadata":{"externalID":"s:5Auth06LoggerP","modules":[{"name":"Auth0"}],"title":"Logger","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Logger"}],"roleHeading":"Protocol","role":"symbol","navigatorTitle":[{"text":"Logger","kind":"identifier"}],"symbolKind":"protocol"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger","interfaceLanguage":"swift"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/Logger/trace(url:source:)":{"kind":"symbol","required":true,"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"trace"},{"kind":"text","text":"("},{"kind":"externalParam","text":"url"},{"kind":"text","text":": "},{"preciseIdentifier":"s:10Foundation3URLV","kind":"typeIdentifier","text":"URL"},{"kind":"text","text":", "},{"kind":"externalParam","text":"source"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?)"}],"title":"trace(url:source:)","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Log a URL."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger\/trace(url:source:)","url":"\/documentation\/auth0\/logger\/trace(url:source:)"},"doc://com.auth0.Auth0/documentation/Auth0/Logger/trace(request:session:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger\/trace(request:session:)","kind":"symbol","title":"trace(request:session:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"trace"},{"kind":"text","text":"("},{"kind":"externalParam","text":"request"},{"kind":"text","text":": "},{"preciseIdentifier":"s:10Foundation10URLRequestV","kind":"typeIdentifier","text":"URLRequest"},{"kind":"text","text":", "},{"kind":"externalParam","text":"session"},{"kind":"text","text":": "},{"preciseIdentifier":"c:objc(cs)NSURLSession","text":"URLSession","kind":"typeIdentifier"},{"text":")","kind":"text"}],"role":"symbol","required":true,"url":"\/documentation\/auth0\/logger\/trace(request:session:)","abstract":[{"text":"Log an HTTP request.","type":"text"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Logger":{"title":"Logger","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Logger"}],"abstract":[{"text":"Logger for debugging purposes.","type":"text"}],"url":"\/documentation\/auth0\/logger","navigatorTitle":[{"kind":"identifier","text":"Logger"}]},"doc://com.auth0.Auth0/documentation/Auth0/Logger/trace(response:data:)":{"url":"\/documentation\/auth0\/logger\/trace(response:data:)","required":true,"fragments":[{"text":"func","kind":"keyword"},{"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"},{"text":", ","kind":"text"},{"text":"data","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation4DataV","text":"Data","kind":"typeIdentifier"},{"text":"?)","kind":"text"}],"title":"trace(response:data:)","type":"topic","role":"symbol","abstract":[{"text":"Log an HTTP response.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger\/trace(response:data:)","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ 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 4945da86f..e30943a6d 100644 --- a/docs/data/documentation/auth0/logger/trace(request:session:).json +++ b/docs/data/documentation/auth0/logger/trace(request:session:).json @@ -1 +1 @@ -{"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger"]]},"schemaVersion":{"patch":0,"minor":3,"major":0},"abstract":[{"type":"text","text":"Log an HTTP request."}],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"trace"},{"kind":"text","text":"("},{"kind":"externalParam","text":"request"},{"kind":"text","text":": "},{"preciseIdentifier":"s:10Foundation10URLRequestV","kind":"typeIdentifier","text":"URLRequest"},{"kind":"text","text":", "},{"kind":"externalParam","text":"session"},{"kind":"text","text":": "},{"preciseIdentifier":"c:objc(cs)NSURLSession","kind":"typeIdentifier","text":"URLSession"},{"kind":"text","text":")"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"metadata":{"roleHeading":"Instance Method","modules":[{"name":"Auth0"}],"required":true,"symbolKind":"method","externalID":"s:5Auth06LoggerP5trace7request7sessiony10Foundation10URLRequestV_So12NSURLSessionCtF","title":"trace(request:session:)","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"trace"},{"kind":"text","text":"("},{"kind":"externalParam","text":"request"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation10URLRequestV","text":"URLRequest"},{"kind":"text","text":", "},{"kind":"externalParam","text":"session"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSURLSession","text":"URLSession"},{"text":")","kind":"text"}]},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/logger\/trace(request:session:)"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger\/trace(request:session:)"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Logger/trace(request:session:)":{"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"trace"},{"kind":"text","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":": "},{"kind":"typeIdentifier","text":"URLSession","preciseIdentifier":"c:objc(cs)NSURLSession"},{"kind":"text","text":")"}],"required":true,"url":"\/documentation\/auth0\/logger\/trace(request:session:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger\/trace(request:session:)","abstract":[{"text":"Log an HTTP request.","type":"text"}],"type":"topic","title":"trace(request:session:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Logger":{"navigatorTitle":[{"kind":"identifier","text":"Logger"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger","role":"symbol","abstract":[{"type":"text","text":"Logger for debugging purposes."}],"kind":"symbol","url":"\/documentation\/auth0\/logger","type":"topic","title":"Logger","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Logger"}]}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/logger\/trace(request:session:)"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger"]]},"abstract":[{"text":"Log an HTTP request.","type":"text"}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"trace"},{"kind":"text","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":": "},{"kind":"typeIdentifier","text":"URLSession","preciseIdentifier":"c:objc(cs)NSURLSession"},{"kind":"text","text":")"}],"platforms":["iOS"]}],"kind":"declarations"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","sections":[],"metadata":{"externalID":"s:5Auth06LoggerP5trace7request7sessiony10Foundation10URLRequestV_So12NSURLSessionCtF","symbolKind":"method","title":"trace(request:session:)","role":"symbol","roleHeading":"Instance Method","required":true,"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"trace"},{"kind":"text","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":": "},{"kind":"typeIdentifier","text":"URLSession","preciseIdentifier":"c:objc(cs)NSURLSession"},{"kind":"text","text":")"}],"modules":[{"name":"Auth0"}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger\/trace(request:session:)"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Logger":{"title":"Logger","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Logger"}],"abstract":[{"text":"Logger for debugging purposes.","type":"text"}],"url":"\/documentation\/auth0\/logger","navigatorTitle":[{"kind":"identifier","text":"Logger"}]},"doc://com.auth0.Auth0/documentation/Auth0/Logger/trace(request:session:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger\/trace(request:session:)","kind":"symbol","title":"trace(request:session:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"trace"},{"kind":"text","text":"("},{"kind":"externalParam","text":"request"},{"kind":"text","text":": "},{"preciseIdentifier":"s:10Foundation10URLRequestV","kind":"typeIdentifier","text":"URLRequest"},{"kind":"text","text":", "},{"kind":"externalParam","text":"session"},{"kind":"text","text":": "},{"preciseIdentifier":"c:objc(cs)NSURLSession","text":"URLSession","kind":"typeIdentifier"},{"text":")","kind":"text"}],"role":"symbol","required":true,"url":"\/documentation\/auth0\/logger\/trace(request:session:)","abstract":[{"text":"Log an HTTP request.","type":"text"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ 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 1bd0e842f..ec98f110f 100644 --- a/docs/data/documentation/auth0/logger/trace(response:data:).json +++ b/docs/data/documentation/auth0/logger/trace(response:data:).json @@ -1 +1 @@ -{"kind":"symbol","schemaVersion":{"major":0,"patch":0,"minor":3},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger\/trace(response:data:)"},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"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"},{"text":", ","kind":"text"},{"text":"data","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation4DataV","text":"Data","kind":"typeIdentifier"},{"text":"?)","kind":"text"}]}]}],"metadata":{"roleHeading":"Instance Method","title":"trace(response:data:)","modules":[{"name":"Auth0"}],"symbolKind":"method","required":true,"externalID":"s:5Auth06LoggerP5trace8response4dataySo13NSURLResponseC_10Foundation4DataVSgtF","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"trace"},{"kind":"text","text":"("},{"kind":"externalParam","text":"response"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSURLResponse","text":"URLResponse"},{"kind":"text","text":", "},{"kind":"externalParam","text":"data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV","text":"Data"},{"kind":"text","text":"?)"}],"role":"symbol"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/logger\/trace(response:data:)"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger"]]},"abstract":[{"type":"text","text":"Log an HTTP response."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Logger":{"navigatorTitle":[{"kind":"identifier","text":"Logger"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger","role":"symbol","abstract":[{"type":"text","text":"Logger for debugging purposes."}],"kind":"symbol","url":"\/documentation\/auth0\/logger","type":"topic","title":"Logger","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Logger"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Logger/trace(response:data:)":{"role":"symbol","abstract":[{"type":"text","text":"Log an HTTP response."}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"trace"},{"kind":"text","text":"("},{"kind":"externalParam","text":"response"},{"kind":"text","text":": "},{"preciseIdentifier":"c:objc(cs)NSURLResponse","kind":"typeIdentifier","text":"URLResponse"},{"kind":"text","text":", "},{"kind":"externalParam","text":"data"},{"kind":"text","text":": "},{"preciseIdentifier":"s:10Foundation4DataV","kind":"typeIdentifier","text":"Data"},{"kind":"text","text":"?)"}],"required":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger\/trace(response:data:)","url":"\/documentation\/auth0\/logger\/trace(response:data:)","kind":"symbol","title":"trace(response:data:)","type":"topic"}}} \ No newline at end of file +{"abstract":[{"type":"text","text":"Log an HTTP response."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"trace","kind":"identifier"},{"text":"(","kind":"text"},{"text":"response","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:objc(cs)NSURLResponse","text":"URLResponse","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"data","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation4DataV","text":"Data","kind":"typeIdentifier"},{"text":"?)","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/logger\/trace(response:data:)"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger"]]},"metadata":{"symbolKind":"method","modules":[{"name":"Auth0"}],"title":"trace(response:data:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"trace","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"response"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:objc(cs)NSURLResponse","text":"URLResponse","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"data","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation4DataV","text":"Data","kind":"typeIdentifier"},{"text":"?)","kind":"text"}],"externalID":"s:5Auth06LoggerP5trace8response4dataySo13NSURLResponseC_10Foundation4DataVSgtF","role":"symbol","required":true,"roleHeading":"Instance Method"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger\/trace(response:data:)"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/Logger":{"title":"Logger","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Logger"}],"abstract":[{"text":"Logger for debugging purposes.","type":"text"}],"url":"\/documentation\/auth0\/logger","navigatorTitle":[{"kind":"identifier","text":"Logger"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Logger/trace(response:data:)":{"url":"\/documentation\/auth0\/logger\/trace(response:data:)","required":true,"fragments":[{"text":"func","kind":"keyword"},{"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"},{"text":", ","kind":"text"},{"text":"data","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation4DataV","text":"Data","kind":"typeIdentifier"},{"text":"?)","kind":"text"}],"title":"trace(response:data:)","type":"topic","role":"symbol","abstract":[{"text":"Log an HTTP response.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger\/trace(response:data:)","kind":"symbol"}}} \ 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 3d4463331..9e9e69abd 100644 --- a/docs/data/documentation/auth0/logger/trace(url:source:).json +++ b/docs/data/documentation/auth0/logger/trace(url:source:).json @@ -1 +1 @@ -{"sections":[],"abstract":[{"text":"Log a URL.","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"trace"},{"kind":"text","text":"("},{"kind":"externalParam","text":"url"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"URL","preciseIdentifier":"s:10Foundation3URLV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"source"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?)"}],"platforms":["iOS"]}]}],"kind":"symbol","metadata":{"symbolKind":"method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"trace"},{"kind":"text","text":"("},{"kind":"externalParam","text":"url"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV","text":"URL"},{"kind":"text","text":", "},{"kind":"externalParam","text":"source"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?)"}],"externalID":"s:5Auth06LoggerP5trace3url6sourcey10Foundation3URLV_SSSgtF","title":"trace(url:source:)","modules":[{"name":"Auth0"}],"roleHeading":"Instance Method","required":true,"role":"symbol"},"schemaVersion":{"major":0,"patch":0,"minor":3},"variants":[{"paths":["\/documentation\/auth0\/logger\/trace(url:source:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger\/trace(url:source:)"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Logger/trace(url:source:)":{"url":"\/documentation\/auth0\/logger\/trace(url:source:)","abstract":[{"type":"text","text":"Log a URL."}],"type":"topic","role":"symbol","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"trace","kind":"identifier"},{"text":"(","kind":"text"},{"text":"url","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"URL","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV"},{"text":", ","kind":"text"},{"text":"source","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?)","kind":"text"}],"title":"trace(url:source:)","required":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger\/trace(url:source:)"},"doc://com.auth0.Auth0/documentation/Auth0/Logger":{"navigatorTitle":[{"kind":"identifier","text":"Logger"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger","role":"symbol","abstract":[{"type":"text","text":"Logger for debugging purposes."}],"kind":"symbol","url":"\/documentation\/auth0\/logger","type":"topic","title":"Logger","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Logger"}]}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/logger\/trace(url:source:)"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger"]]},"abstract":[{"text":"Log a URL.","type":"text"}],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"trace"},{"kind":"text","text":"("},{"kind":"externalParam","text":"url"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV","text":"URL"},{"kind":"text","text":", "},{"kind":"externalParam","text":"source"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?)"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"schemaVersion":{"minor":3,"patch":0,"major":0},"kind":"symbol","sections":[],"metadata":{"externalID":"s:5Auth06LoggerP5trace3url6sourcey10Foundation3URLV_SSSgtF","symbolKind":"method","title":"trace(url:source:)","required":true,"role":"symbol","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"trace"},{"kind":"text","text":"("},{"kind":"externalParam","text":"url"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"URL","preciseIdentifier":"s:10Foundation3URLV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"source"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?)"}],"modules":[{"name":"Auth0"}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger\/trace(url:source:)"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Logger":{"title":"Logger","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Logger"}],"abstract":[{"text":"Logger for debugging purposes.","type":"text"}],"url":"\/documentation\/auth0\/logger","navigatorTitle":[{"kind":"identifier","text":"Logger"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Logger/trace(url:source:)":{"kind":"symbol","required":true,"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"trace"},{"kind":"text","text":"("},{"kind":"externalParam","text":"url"},{"kind":"text","text":": "},{"preciseIdentifier":"s:10Foundation3URLV","kind":"typeIdentifier","text":"URL"},{"kind":"text","text":", "},{"kind":"externalParam","text":"source"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?)"}],"title":"trace(url:source:)","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Log a URL."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Logger\/trace(url:source:)","url":"\/documentation\/auth0\/logger\/trace(url:source:)"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/loginpasskey.json b/docs/data/documentation/auth0/loginpasskey.json index 692e98cc4..856e485bd 100644 --- a/docs/data/documentation/auth0/loginpasskey.json +++ b/docs/data/documentation/auth0/loginpasskey.json @@ -1 +1 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey","interfaceLanguage":"swift"},"schemaVersion":{"minor":3,"major":0,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"LoginPasskey","kind":"identifier"}],"platforms":["iOS"]}]}],"relationshipsSections":[{"title":"Conforming Types","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationServices\/ASAuthorizationPlatformPublicKeyCredentialAssertion"],"kind":"relationships","type":"conformingTypes"}],"kind":"symbol","abstract":[{"type":"text","text":"The login passkey credential obtained from the "},{"isActive":true,"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate"},{"type":"text","text":" delegate."},{"type":"text","text":" "},{"type":"text","text":"Contains the subset of relevant properties from "},{"isActive":true,"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialassertion"},{"type":"text","text":"."}],"variants":[{"paths":["\/documentation\/auth0\/loginpasskey"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"role":"symbol","symbolKind":"protocol","title":"LoginPasskey","roleHeading":"Protocol","navigatorTitle":[{"text":"LoginPasskey","kind":"identifier"}],"fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"LoginPasskey","kind":"identifier"}],"modules":[{"name":"Auth0"}],"externalID":"s:5Auth012LoginPasskeyP","platforms":[{"unavailable":false,"name":"iOS","beta":false,"deprecated":false,"introducedAt":"16.6"},{"unavailable":false,"name":"iPadOS","beta":false,"deprecated":false,"introducedAt":"16.6"},{"unavailable":false,"name":"Mac Catalyst","beta":false,"deprecated":false,"introducedAt":"16.6"},{"unavailable":false,"name":"macOS","beta":false,"deprecated":false,"introducedAt":"13.5"},{"unavailable":false,"name":"visionOS","beta":false,"deprecated":false,"introducedAt":"1.0"}]},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"topicSections":[{"generated":true,"anchor":"Instance-Properties","title":"Instance Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey\/attachment","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey\/credentialID","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey\/rawAuthenticatorData","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey\/rawClientDataJSON","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey\/signature","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey\/userID"]}],"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/LoginPasskey/rawAuthenticatorData":{"abstract":[],"role":"symbol","url":"\/documentation\/auth0\/loginpasskey\/rawauthenticatordata","required":true,"kind":"symbol","type":"topic","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"rawAuthenticatorData","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Data","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV"},{"text":"!","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey\/rawAuthenticatorData","title":"rawAuthenticatorData"},"doc://com.auth0.Auth0/documentation/Auth0/LoginPasskey/userID":{"required":true,"title":"userID","role":"symbol","type":"topic","url":"\/documentation\/auth0\/loginpasskey\/userid","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey\/userID","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"userID","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Data","preciseIdentifier":"s:10Foundation4DataV","kind":"typeIdentifier"},{"text":"!","kind":"text"}],"kind":"symbol","abstract":[]},"https://developer.apple.com/documentation/authenticationservices/asauthorizationplatformpublickeycredentialassertion":{"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialassertion","title":"ASAuthorizationPlatformPublicKeyCredentialAssertion","type":"link","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialassertion","titleInlineContent":[{"type":"codeVoice","code":"ASAuthorizationPlatformPublicKeyCredentialAssertion"}]},"doc://com.auth0.Auth0/documentation/Auth0/LoginPasskey/rawClientDataJSON":{"required":true,"title":"rawClientDataJSON","role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey\/rawClientDataJSON","abstract":[],"fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"rawClientDataJSON","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Data","preciseIdentifier":"s:10Foundation4DataV","kind":"typeIdentifier"}],"url":"\/documentation\/auth0\/loginpasskey\/rawclientdatajson"},"doc://com.auth0.Auth0/documentation/Auth0/LoginPasskey/attachment":{"kind":"symbol","role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey\/attachment","url":"\/documentation\/auth0\/loginpasskey\/attachment","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"attachment","kind":"identifier"},{"text":": ","kind":"text"},{"text":"ASAuthorizationPublicKeyCredentialAttachment","preciseIdentifier":"c:@E@ASAuthorizationPublicKeyCredentialAttachment","kind":"typeIdentifier"}],"required":true,"title":"attachment","abstract":[]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/LoginPasskey/credentialID":{"kind":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey\/credentialID","required":true,"title":"credentialID","url":"\/documentation\/auth0\/loginpasskey\/credentialid","abstract":[],"role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"credentialID","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Data","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV"}]},"doc://com.auth0.Auth0/documentation/Auth0/LoginPasskey":{"role":"symbol","url":"\/documentation\/auth0\/loginpasskey","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"LoginPasskey"}],"navigatorTitle":[{"kind":"identifier","text":"LoginPasskey"}],"title":"LoginPasskey","abstract":[{"type":"text","text":"The login passkey credential obtained from the "},{"isActive":true,"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate"},{"type":"text","text":" delegate."},{"type":"text","text":" "},{"type":"text","text":"Contains the subset of relevant properties from "},{"isActive":true,"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialassertion"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey"},"doc://com.auth0.Auth0/documentation/Auth0/LoginPasskey/signature":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey\/signature","type":"topic","required":true,"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"signature"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"!"}],"url":"\/documentation\/auth0\/loginpasskey\/signature","role":"symbol","title":"signature","kind":"symbol","abstract":[]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationServices/ASAuthorizationPlatformPublicKeyCredentialAssertion":{"title":"ASAuthorizationPlatformPublicKeyCredentialAssertion","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationServices\/ASAuthorizationPlatformPublicKeyCredentialAssertion"},"https://developer.apple.com/documentation/authenticationservices/asauthorizationcontrollerdelegate":{"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","title":"ASAuthorizationControllerDelegate","type":"link","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","titleInlineContent":[{"type":"codeVoice","code":"ASAuthorizationControllerDelegate"}]}}} \ No newline at end of file +{"kind":"symbol","primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"LoginPasskey"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"relationshipsSections":[{"title":"Conforming Types","type":"conformingTypes","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationServices\/ASAuthorizationPlatformPublicKeyCredentialAssertion"],"kind":"relationships"}],"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey\/attachment","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey\/credentialID","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey\/rawAuthenticatorData","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey\/rawClientDataJSON","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey\/signature","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey\/userID"],"title":"Instance Properties","generated":true,"anchor":"Instance-Properties"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/loginpasskey"]}],"sections":[],"schemaVersion":{"patch":0,"minor":3,"major":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"abstract":[{"type":"text","text":"The login passkey credential obtained from the "},{"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","isActive":true},{"type":"text","text":" delegate."},{"type":"text","text":" "},{"type":"text","text":"Contains the subset of relevant properties from "},{"isActive":true,"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialassertion"},{"type":"text","text":"."}],"metadata":{"navigatorTitle":[{"kind":"identifier","text":"LoginPasskey"}],"modules":[{"name":"Auth0"}],"title":"LoginPasskey","roleHeading":"Protocol","symbolKind":"protocol","role":"symbol","platforms":[{"name":"iOS","deprecated":false,"beta":false,"unavailable":false,"introducedAt":"16.6"},{"name":"iPadOS","deprecated":false,"beta":false,"unavailable":false,"introducedAt":"16.6"},{"name":"Mac Catalyst","deprecated":false,"beta":false,"unavailable":false,"introducedAt":"16.6"},{"unavailable":false,"name":"macOS","beta":false,"introducedAt":"13.5","deprecated":false},{"unavailable":false,"name":"visionOS","beta":false,"introducedAt":"1.0","deprecated":false}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"LoginPasskey"}],"externalID":"s:5Auth012LoginPasskeyP"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/LoginPasskey/rawClientDataJSON":{"kind":"symbol","title":"rawClientDataJSON","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"rawClientDataJSON"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV","text":"Data"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey\/rawClientDataJSON","required":true,"abstract":[],"url":"\/documentation\/auth0\/loginpasskey\/rawclientdatajson"},"doc://com.auth0.Auth0/documentation/Auth0/LoginPasskey":{"title":"LoginPasskey","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"LoginPasskey"}],"abstract":[{"text":"The login passkey credential obtained from the ","type":"text"},{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","isActive":true,"type":"reference"},{"text":" delegate.","type":"text"},{"text":" ","type":"text"},{"text":"Contains the subset of relevant properties from ","type":"text"},{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialassertion","isActive":true,"type":"reference"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/loginpasskey","navigatorTitle":[{"kind":"identifier","text":"LoginPasskey"}]},"doc://com.auth0.Auth0/documentation/Auth0/LoginPasskey/userID":{"kind":"symbol","required":true,"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"userID","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Data","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV"},{"text":"!","kind":"text"}],"title":"userID","type":"topic","role":"symbol","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey\/userID","url":"\/documentation\/auth0\/loginpasskey\/userid"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationServices/ASAuthorizationPlatformPublicKeyCredentialAssertion":{"title":"ASAuthorizationPlatformPublicKeyCredentialAssertion","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationServices\/ASAuthorizationPlatformPublicKeyCredentialAssertion"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/LoginPasskey/credentialID":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey\/credentialID","kind":"symbol","title":"credentialID","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"credentialID","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Data","preciseIdentifier":"s:10Foundation4DataV","kind":"typeIdentifier"}],"role":"symbol","required":true,"url":"\/documentation\/auth0\/loginpasskey\/credentialid","abstract":[],"type":"topic"},"https://developer.apple.com/documentation/authenticationservices/asauthorizationcontrollerdelegate":{"title":"ASAuthorizationControllerDelegate","type":"link","titleInlineContent":[{"code":"ASAuthorizationControllerDelegate","type":"codeVoice"}],"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate"},"doc://com.auth0.Auth0/documentation/Auth0/LoginPasskey/attachment":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey\/attachment","kind":"symbol","title":"attachment","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"attachment","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:@E@ASAuthorizationPublicKeyCredentialAttachment","text":"ASAuthorizationPublicKeyCredentialAttachment","kind":"typeIdentifier"}],"role":"symbol","required":true,"url":"\/documentation\/auth0\/loginpasskey\/attachment","abstract":[],"type":"topic"},"https://developer.apple.com/documentation/authenticationservices/asauthorizationplatformpublickeycredentialassertion":{"title":"ASAuthorizationPlatformPublicKeyCredentialAssertion","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialassertion","titleInlineContent":[{"type":"codeVoice","code":"ASAuthorizationPlatformPublicKeyCredentialAssertion"}],"type":"link","url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialassertion"},"doc://com.auth0.Auth0/documentation/Auth0/LoginPasskey/rawAuthenticatorData":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey\/rawAuthenticatorData","title":"rawAuthenticatorData","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"rawAuthenticatorData"},{"text":": ","kind":"text"},{"text":"Data","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV"},{"text":"!","kind":"text"}],"role":"symbol","required":true,"url":"\/documentation\/auth0\/loginpasskey\/rawauthenticatordata","abstract":[],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/LoginPasskey/signature":{"url":"\/documentation\/auth0\/loginpasskey\/signature","title":"signature","abstract":[],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"signature"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"!"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey\/signature","required":true,"kind":"symbol","role":"symbol","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/loginpasskey/attachment.json b/docs/data/documentation/auth0/loginpasskey/attachment.json index d0abacd48..79aa693be 100644 --- a/docs/data/documentation/auth0/loginpasskey/attachment.json +++ b/docs/data/documentation/auth0/loginpasskey/attachment.json @@ -1 +1 @@ -{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey\/attachment"},"schemaVersion":{"minor":3,"patch":0,"major":0},"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"attachment"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"ASAuthorizationPublicKeyCredentialAttachment","preciseIdentifier":"c:@E@ASAuthorizationPublicKeyCredentialAttachment"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}]}]}],"metadata":{"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"attachment"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"ASAuthorizationPublicKeyCredentialAttachment","preciseIdentifier":"c:@E@ASAuthorizationPublicKeyCredentialAttachment"}],"title":"attachment","roleHeading":"Instance Property","symbolKind":"property","modules":[{"name":"Auth0"}],"role":"symbol","externalID":"s:5Auth012LoginPasskeyP10attachmentSo44ASAuthorizationPublicKeyCredentialAttachmentVvp","required":true,"platforms":[{"unavailable":false,"name":"iOS","introducedAt":"16.6","deprecated":false,"beta":false},{"unavailable":false,"name":"iPadOS","introducedAt":"16.6","deprecated":false,"beta":false},{"unavailable":false,"name":"Mac Catalyst","introducedAt":"16.6","deprecated":false,"beta":false},{"unavailable":false,"name":"macOS","introducedAt":"13.5","deprecated":false,"beta":false},{"unavailable":false,"name":"visionOS","introducedAt":"1.0","deprecated":false,"beta":false}]},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/loginpasskey\/attachment"]}],"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/LoginPasskey":{"role":"symbol","url":"\/documentation\/auth0\/loginpasskey","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"LoginPasskey"}],"navigatorTitle":[{"kind":"identifier","text":"LoginPasskey"}],"title":"LoginPasskey","abstract":[{"type":"text","text":"The login passkey credential obtained from the "},{"isActive":true,"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate"},{"type":"text","text":" delegate."},{"type":"text","text":" "},{"type":"text","text":"Contains the subset of relevant properties from "},{"isActive":true,"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialassertion"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey"},"doc://com.auth0.Auth0/documentation/Auth0/LoginPasskey/attachment":{"kind":"symbol","role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey\/attachment","url":"\/documentation\/auth0\/loginpasskey\/attachment","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"attachment","kind":"identifier"},{"text":": ","kind":"text"},{"text":"ASAuthorizationPublicKeyCredentialAttachment","preciseIdentifier":"c:@E@ASAuthorizationPublicKeyCredentialAttachment","kind":"typeIdentifier"}],"required":true,"title":"attachment","abstract":[]},"https://developer.apple.com/documentation/authenticationservices/asauthorizationplatformpublickeycredentialassertion":{"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialassertion","type":"link","titleInlineContent":[{"code":"ASAuthorizationPlatformPublicKeyCredentialAssertion","type":"codeVoice"}],"title":"ASAuthorizationPlatformPublicKeyCredentialAssertion","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialassertion"},"https://developer.apple.com/documentation/authenticationservices/asauthorizationcontrollerdelegate":{"type":"link","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","title":"ASAuthorizationControllerDelegate","titleInlineContent":[{"type":"codeVoice","code":"ASAuthorizationControllerDelegate"}],"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey"]]},"metadata":{"modules":[{"name":"Auth0"}],"externalID":"s:5Auth012LoginPasskeyP10attachmentSo44ASAuthorizationPublicKeyCredentialAttachmentVvp","title":"attachment","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"attachment"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:@E@ASAuthorizationPublicKeyCredentialAttachment","text":"ASAuthorizationPublicKeyCredentialAttachment"}],"roleHeading":"Instance Property","role":"symbol","required":true,"symbolKind":"property","platforms":[{"beta":false,"name":"iOS","unavailable":false,"introducedAt":"16.6","deprecated":false},{"beta":false,"name":"iPadOS","unavailable":false,"introducedAt":"16.6","deprecated":false},{"beta":false,"name":"Mac Catalyst","unavailable":false,"introducedAt":"16.6","deprecated":false},{"beta":false,"name":"macOS","unavailable":false,"introducedAt":"13.5","deprecated":false},{"beta":false,"name":"visionOS","unavailable":false,"introducedAt":"1.0","deprecated":false}]},"sections":[],"variants":[{"paths":["\/documentation\/auth0\/loginpasskey\/attachment"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey\/attachment"},"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"attachment"},{"text":": ","kind":"text"},{"text":"ASAuthorizationPublicKeyCredentialAttachment","kind":"typeIdentifier","preciseIdentifier":"c:@E@ASAuthorizationPublicKeyCredentialAttachment"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]}],"references":{"https://developer.apple.com/documentation/authenticationservices/asauthorizationcontrollerdelegate":{"title":"ASAuthorizationControllerDelegate","url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","type":"link","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","titleInlineContent":[{"code":"ASAuthorizationControllerDelegate","type":"codeVoice"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/LoginPasskey/attachment":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey\/attachment","kind":"symbol","title":"attachment","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"attachment","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:@E@ASAuthorizationPublicKeyCredentialAttachment","text":"ASAuthorizationPublicKeyCredentialAttachment","kind":"typeIdentifier"}],"role":"symbol","required":true,"url":"\/documentation\/auth0\/loginpasskey\/attachment","abstract":[],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/LoginPasskey":{"title":"LoginPasskey","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"LoginPasskey"}],"abstract":[{"text":"The login passkey credential obtained from the ","type":"text"},{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","isActive":true,"type":"reference"},{"text":" delegate.","type":"text"},{"text":" ","type":"text"},{"text":"Contains the subset of relevant properties from ","type":"text"},{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialassertion","isActive":true,"type":"reference"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/loginpasskey","navigatorTitle":[{"kind":"identifier","text":"LoginPasskey"}]},"https://developer.apple.com/documentation/authenticationservices/asauthorizationplatformpublickeycredentialassertion":{"title":"ASAuthorizationPlatformPublicKeyCredentialAssertion","titleInlineContent":[{"type":"codeVoice","code":"ASAuthorizationPlatformPublicKeyCredentialAssertion"}],"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialassertion","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialassertion","type":"link"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/loginpasskey/credentialid.json b/docs/data/documentation/auth0/loginpasskey/credentialid.json index 1c94ed65c..68f576119 100644 --- a/docs/data/documentation/auth0/loginpasskey/credentialid.json +++ b/docs/data/documentation/auth0/loginpasskey/credentialid.json @@ -1 +1 @@ -{"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey\/credentialID","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"credentialID"},{"kind":"text","text":": "},{"preciseIdentifier":"s:10Foundation4DataV","kind":"typeIdentifier","text":"Data"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"platforms":["iOS"]}]}],"schemaVersion":{"major":0,"patch":0,"minor":3},"metadata":{"platforms":[{"introducedAt":"16.6","unavailable":false,"beta":false,"name":"iOS","deprecated":false},{"introducedAt":"16.6","unavailable":false,"beta":false,"name":"iPadOS","deprecated":false},{"introducedAt":"16.6","unavailable":false,"beta":false,"name":"Mac Catalyst","deprecated":false},{"introducedAt":"13.5","unavailable":false,"beta":false,"name":"macOS","deprecated":false},{"introducedAt":"1.0","unavailable":false,"beta":false,"name":"visionOS","deprecated":false}],"required":true,"symbolKind":"property","title":"credentialID","role":"symbol","roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"externalID":"s:5Auth012LoginPasskeyP12credentialID10Foundation4DataVvp","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"credentialID"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV","text":"Data"}]},"variants":[{"paths":["\/documentation\/auth0\/loginpasskey\/credentialid"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey"]]},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/LoginPasskey":{"role":"symbol","url":"\/documentation\/auth0\/loginpasskey","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"LoginPasskey"}],"navigatorTitle":[{"kind":"identifier","text":"LoginPasskey"}],"title":"LoginPasskey","abstract":[{"type":"text","text":"The login passkey credential obtained from the "},{"isActive":true,"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate"},{"type":"text","text":" delegate."},{"type":"text","text":" "},{"type":"text","text":"Contains the subset of relevant properties from "},{"isActive":true,"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialassertion"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey"},"https://developer.apple.com/documentation/authenticationservices/asauthorizationplatformpublickeycredentialassertion":{"title":"ASAuthorizationPlatformPublicKeyCredentialAssertion","url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialassertion","type":"link","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialassertion","titleInlineContent":[{"type":"codeVoice","code":"ASAuthorizationPlatformPublicKeyCredentialAssertion"}]},"https://developer.apple.com/documentation/authenticationservices/asauthorizationcontrollerdelegate":{"type":"link","url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","title":"ASAuthorizationControllerDelegate","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","titleInlineContent":[{"type":"codeVoice","code":"ASAuthorizationControllerDelegate"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/LoginPasskey/credentialID":{"kind":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey\/credentialID","required":true,"title":"credentialID","url":"\/documentation\/auth0\/loginpasskey\/credentialid","abstract":[],"role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"credentialID","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Data","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV"}]}}} \ No newline at end of file +{"sections":[],"metadata":{"modules":[{"name":"Auth0"}],"externalID":"s:5Auth012LoginPasskeyP12credentialID10Foundation4DataVvp","title":"credentialID","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"credentialID"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV","text":"Data"}],"roleHeading":"Instance Property","role":"symbol","required":true,"symbolKind":"property","platforms":[{"name":"iOS","deprecated":false,"introducedAt":"16.6","beta":false,"unavailable":false},{"name":"iPadOS","deprecated":false,"introducedAt":"16.6","beta":false,"unavailable":false},{"name":"Mac Catalyst","deprecated":false,"introducedAt":"16.6","beta":false,"unavailable":false},{"name":"macOS","deprecated":false,"introducedAt":"13.5","beta":false,"unavailable":false},{"name":"visionOS","deprecated":false,"introducedAt":"1.0","beta":false,"unavailable":false}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey\/credentialID","interfaceLanguage":"swift"},"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/loginpasskey\/credentialid"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"credentialID","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Data","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/LoginPasskey":{"title":"LoginPasskey","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"LoginPasskey"}],"abstract":[{"text":"The login passkey credential obtained from the ","type":"text"},{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","isActive":true,"type":"reference"},{"text":" delegate.","type":"text"},{"text":" ","type":"text"},{"text":"Contains the subset of relevant properties from ","type":"text"},{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialassertion","isActive":true,"type":"reference"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/loginpasskey","navigatorTitle":[{"kind":"identifier","text":"LoginPasskey"}]},"https://developer.apple.com/documentation/authenticationservices/asauthorizationcontrollerdelegate":{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","titleInlineContent":[{"type":"codeVoice","code":"ASAuthorizationControllerDelegate"}],"type":"link","title":"ASAuthorizationControllerDelegate"},"https://developer.apple.com/documentation/authenticationservices/asauthorizationplatformpublickeycredentialassertion":{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialassertion","url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialassertion","titleInlineContent":[{"type":"codeVoice","code":"ASAuthorizationPlatformPublicKeyCredentialAssertion"}],"type":"link","title":"ASAuthorizationPlatformPublicKeyCredentialAssertion"},"doc://com.auth0.Auth0/documentation/Auth0/LoginPasskey/credentialID":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey\/credentialID","kind":"symbol","title":"credentialID","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"credentialID","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Data","preciseIdentifier":"s:10Foundation4DataV","kind":"typeIdentifier"}],"role":"symbol","required":true,"url":"\/documentation\/auth0\/loginpasskey\/credentialid","abstract":[],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/loginpasskey/rawauthenticatordata.json b/docs/data/documentation/auth0/loginpasskey/rawauthenticatordata.json index 3f0fccf76..3a162b3b3 100644 --- a/docs/data/documentation/auth0/loginpasskey/rawauthenticatordata.json +++ b/docs/data/documentation/auth0/loginpasskey/rawauthenticatordata.json @@ -1 +1 @@ -{"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"rawAuthenticatorData","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Data","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV"},{"text":"! { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey\/rawAuthenticatorData","interfaceLanguage":"swift"},"variants":[{"paths":["\/documentation\/auth0\/loginpasskey\/rawauthenticatordata"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"title":"rawAuthenticatorData","role":"symbol","symbolKind":"property","modules":[{"name":"Auth0"}],"externalID":"s:5Auth012LoginPasskeyP20rawAuthenticatorData10Foundation0F0VSgvp","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"rawAuthenticatorData","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Data","preciseIdentifier":"s:10Foundation4DataV","kind":"typeIdentifier"},{"text":"!","kind":"text"}],"roleHeading":"Instance Property","required":true,"platforms":[{"beta":false,"name":"iOS","deprecated":false,"introducedAt":"16.6","unavailable":false},{"beta":false,"name":"iPadOS","deprecated":false,"introducedAt":"16.6","unavailable":false},{"beta":false,"name":"Mac Catalyst","deprecated":false,"introducedAt":"16.6","unavailable":false},{"beta":false,"name":"macOS","deprecated":false,"introducedAt":"13.5","unavailable":false},{"beta":false,"name":"visionOS","deprecated":false,"introducedAt":"1.0","unavailable":false}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"https://developer.apple.com/documentation/authenticationservices/asauthorizationcontrollerdelegate":{"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","type":"link","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","title":"ASAuthorizationControllerDelegate","titleInlineContent":[{"type":"codeVoice","code":"ASAuthorizationControllerDelegate"}]},"doc://com.auth0.Auth0/documentation/Auth0/LoginPasskey":{"role":"symbol","url":"\/documentation\/auth0\/loginpasskey","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"LoginPasskey"}],"navigatorTitle":[{"kind":"identifier","text":"LoginPasskey"}],"title":"LoginPasskey","abstract":[{"type":"text","text":"The login passkey credential obtained from the "},{"isActive":true,"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate"},{"type":"text","text":" delegate."},{"type":"text","text":" "},{"type":"text","text":"Contains the subset of relevant properties from "},{"isActive":true,"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialassertion"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey"},"https://developer.apple.com/documentation/authenticationservices/asauthorizationplatformpublickeycredentialassertion":{"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialassertion","type":"link","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialassertion","title":"ASAuthorizationPlatformPublicKeyCredentialAssertion","titleInlineContent":[{"type":"codeVoice","code":"ASAuthorizationPlatformPublicKeyCredentialAssertion"}]},"doc://com.auth0.Auth0/documentation/Auth0/LoginPasskey/rawAuthenticatorData":{"abstract":[],"role":"symbol","url":"\/documentation\/auth0\/loginpasskey\/rawauthenticatordata","required":true,"kind":"symbol","type":"topic","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"rawAuthenticatorData","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Data","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV"},{"text":"!","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey\/rawAuthenticatorData","title":"rawAuthenticatorData"}}} \ No newline at end of file +{"variants":[{"paths":["\/documentation\/auth0\/loginpasskey\/rawauthenticatordata"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"rawAuthenticatorData","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Data","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV"},{"text":"! { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"platforms":["iOS"]}]}],"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"metadata":{"modules":[{"name":"Auth0"}],"title":"rawAuthenticatorData","roleHeading":"Instance Property","symbolKind":"property","platforms":[{"beta":false,"introducedAt":"16.6","deprecated":false,"name":"iOS","unavailable":false},{"beta":false,"introducedAt":"16.6","deprecated":false,"name":"iPadOS","unavailable":false},{"beta":false,"introducedAt":"16.6","deprecated":false,"name":"Mac Catalyst","unavailable":false},{"beta":false,"introducedAt":"13.5","deprecated":false,"name":"macOS","unavailable":false},{"beta":false,"introducedAt":"1.0","deprecated":false,"name":"visionOS","unavailable":false}],"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"rawAuthenticatorData"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"!"}],"required":true,"externalID":"s:5Auth012LoginPasskeyP20rawAuthenticatorData10Foundation0F0VSgvp"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey\/rawAuthenticatorData","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/LoginPasskey/rawAuthenticatorData":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey\/rawAuthenticatorData","title":"rawAuthenticatorData","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"rawAuthenticatorData"},{"text":": ","kind":"text"},{"text":"Data","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV"},{"text":"!","kind":"text"}],"role":"symbol","required":true,"url":"\/documentation\/auth0\/loginpasskey\/rawauthenticatordata","abstract":[],"type":"topic"},"https://developer.apple.com/documentation/authenticationservices/asauthorizationplatformpublickeycredentialassertion":{"title":"ASAuthorizationPlatformPublicKeyCredentialAssertion","type":"link","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialassertion","titleInlineContent":[{"type":"codeVoice","code":"ASAuthorizationPlatformPublicKeyCredentialAssertion"}],"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialassertion"},"doc://com.auth0.Auth0/documentation/Auth0/LoginPasskey":{"title":"LoginPasskey","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"LoginPasskey"}],"abstract":[{"text":"The login passkey credential obtained from the ","type":"text"},{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","isActive":true,"type":"reference"},{"text":" delegate.","type":"text"},{"text":" ","type":"text"},{"text":"Contains the subset of relevant properties from ","type":"text"},{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialassertion","isActive":true,"type":"reference"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/loginpasskey","navigatorTitle":[{"kind":"identifier","text":"LoginPasskey"}]},"https://developer.apple.com/documentation/authenticationservices/asauthorizationcontrollerdelegate":{"type":"link","titleInlineContent":[{"type":"codeVoice","code":"ASAuthorizationControllerDelegate"}],"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","title":"ASAuthorizationControllerDelegate","url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/loginpasskey/rawclientdatajson.json b/docs/data/documentation/auth0/loginpasskey/rawclientdatajson.json index 770d1e166..84dae9de3 100644 --- a/docs/data/documentation/auth0/loginpasskey/rawclientdatajson.json +++ b/docs/data/documentation/auth0/loginpasskey/rawclientdatajson.json @@ -1 +1 @@ -{"metadata":{"role":"symbol","externalID":"s:5Auth012LoginPasskeyP17rawClientDataJSON10Foundation0F0Vvp","required":true,"platforms":[{"introducedAt":"16.6","deprecated":false,"beta":false,"unavailable":false,"name":"iOS"},{"introducedAt":"16.6","deprecated":false,"beta":false,"unavailable":false,"name":"iPadOS"},{"introducedAt":"16.6","deprecated":false,"beta":false,"unavailable":false,"name":"Mac Catalyst"},{"introducedAt":"13.5","deprecated":false,"beta":false,"unavailable":false,"name":"macOS"},{"introducedAt":"1.0","deprecated":false,"beta":false,"unavailable":false,"name":"visionOS"}],"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"rawClientDataJSON","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation4DataV","text":"Data","kind":"typeIdentifier"}],"modules":[{"name":"Auth0"}],"title":"rawClientDataJSON","symbolKind":"property","roleHeading":"Instance Property"},"schemaVersion":{"minor":3,"major":0,"patch":0},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"rawClientDataJSON","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Data","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"kind":"symbol","sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey\/rawClientDataJSON","interfaceLanguage":"swift"},"variants":[{"paths":["\/documentation\/auth0\/loginpasskey\/rawclientdatajson"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/LoginPasskey/rawClientDataJSON":{"required":true,"title":"rawClientDataJSON","role":"symbol","type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey\/rawClientDataJSON","abstract":[],"fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"rawClientDataJSON","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Data","preciseIdentifier":"s:10Foundation4DataV","kind":"typeIdentifier"}],"url":"\/documentation\/auth0\/loginpasskey\/rawclientdatajson"},"https://developer.apple.com/documentation/authenticationservices/asauthorizationplatformpublickeycredentialassertion":{"type":"link","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialassertion","title":"ASAuthorizationPlatformPublicKeyCredentialAssertion","titleInlineContent":[{"type":"codeVoice","code":"ASAuthorizationPlatformPublicKeyCredentialAssertion"}],"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialassertion"},"doc://com.auth0.Auth0/documentation/Auth0/LoginPasskey":{"role":"symbol","url":"\/documentation\/auth0\/loginpasskey","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"LoginPasskey"}],"navigatorTitle":[{"kind":"identifier","text":"LoginPasskey"}],"title":"LoginPasskey","abstract":[{"type":"text","text":"The login passkey credential obtained from the "},{"isActive":true,"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate"},{"type":"text","text":" delegate."},{"type":"text","text":" "},{"type":"text","text":"Contains the subset of relevant properties from "},{"isActive":true,"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialassertion"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey"},"https://developer.apple.com/documentation/authenticationservices/asauthorizationcontrollerdelegate":{"type":"link","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","title":"ASAuthorizationControllerDelegate","titleInlineContent":[{"code":"ASAuthorizationControllerDelegate","type":"codeVoice"}],"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate"}}} \ No newline at end of file +{"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/loginpasskey\/rawclientdatajson"]}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey"]]},"schemaVersion":{"patch":0,"major":0,"minor":3},"metadata":{"roleHeading":"Instance Property","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"rawClientDataJSON"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"}],"platforms":[{"introducedAt":"16.6","unavailable":false,"beta":false,"name":"iOS","deprecated":false},{"introducedAt":"16.6","unavailable":false,"beta":false,"name":"iPadOS","deprecated":false},{"introducedAt":"16.6","unavailable":false,"beta":false,"name":"Mac Catalyst","deprecated":false},{"introducedAt":"13.5","unavailable":false,"beta":false,"name":"macOS","deprecated":false},{"introducedAt":"1.0","unavailable":false,"beta":false,"name":"visionOS","deprecated":false}],"role":"symbol","title":"rawClientDataJSON","required":true,"modules":[{"name":"Auth0"}],"externalID":"s:5Auth012LoginPasskeyP17rawClientDataJSON10Foundation0F0Vvp","symbolKind":"property"},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"rawClientDataJSON","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Data","preciseIdentifier":"s:10Foundation4DataV","kind":"typeIdentifier"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey\/rawClientDataJSON","interfaceLanguage":"swift"},"references":{"https://developer.apple.com/documentation/authenticationservices/asauthorizationplatformpublickeycredentialassertion":{"title":"ASAuthorizationPlatformPublicKeyCredentialAssertion","type":"link","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialassertion","titleInlineContent":[{"type":"codeVoice","code":"ASAuthorizationPlatformPublicKeyCredentialAssertion"}],"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialassertion"},"doc://com.auth0.Auth0/documentation/Auth0/LoginPasskey":{"title":"LoginPasskey","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"LoginPasskey"}],"abstract":[{"text":"The login passkey credential obtained from the ","type":"text"},{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","isActive":true,"type":"reference"},{"text":" delegate.","type":"text"},{"text":" ","type":"text"},{"text":"Contains the subset of relevant properties from ","type":"text"},{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialassertion","isActive":true,"type":"reference"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/loginpasskey","navigatorTitle":[{"kind":"identifier","text":"LoginPasskey"}]},"doc://com.auth0.Auth0/documentation/Auth0/LoginPasskey/rawClientDataJSON":{"kind":"symbol","title":"rawClientDataJSON","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"rawClientDataJSON"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV","text":"Data"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey\/rawClientDataJSON","required":true,"abstract":[],"url":"\/documentation\/auth0\/loginpasskey\/rawclientdatajson"},"https://developer.apple.com/documentation/authenticationservices/asauthorizationcontrollerdelegate":{"title":"ASAuthorizationControllerDelegate","type":"link","titleInlineContent":[{"code":"ASAuthorizationControllerDelegate","type":"codeVoice"}],"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/loginpasskey/signature.json b/docs/data/documentation/auth0/loginpasskey/signature.json index 2605a0693..362052d28 100644 --- a/docs/data/documentation/auth0/loginpasskey/signature.json +++ b/docs/data/documentation/auth0/loginpasskey/signature.json @@ -1 +1 @@ -{"metadata":{"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"signature","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Data","preciseIdentifier":"s:10Foundation4DataV","kind":"typeIdentifier"},{"text":"!","kind":"text"}],"roleHeading":"Instance Property","title":"signature","platforms":[{"name":"iOS","introducedAt":"16.6","unavailable":false,"beta":false,"deprecated":false},{"name":"iPadOS","introducedAt":"16.6","unavailable":false,"beta":false,"deprecated":false},{"name":"Mac Catalyst","introducedAt":"16.6","unavailable":false,"beta":false,"deprecated":false},{"name":"macOS","introducedAt":"13.5","unavailable":false,"beta":false,"deprecated":false},{"name":"visionOS","introducedAt":"1.0","unavailable":false,"beta":false,"deprecated":false}],"role":"symbol","externalID":"s:5Auth012LoginPasskeyP9signature10Foundation4DataVSgvp","required":true,"modules":[{"name":"Auth0"}],"symbolKind":"property"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey\/signature","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey"]]},"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/loginpasskey\/signature"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"schemaVersion":{"patch":0,"major":0,"minor":3},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"signature","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Data","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV"},{"text":"! { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"references":{"https://developer.apple.com/documentation/authenticationservices/asauthorizationcontrollerdelegate":{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","type":"link","url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","title":"ASAuthorizationControllerDelegate","titleInlineContent":[{"type":"codeVoice","code":"ASAuthorizationControllerDelegate"}]},"doc://com.auth0.Auth0/documentation/Auth0/LoginPasskey/signature":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey\/signature","type":"topic","required":true,"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"signature"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"!"}],"url":"\/documentation\/auth0\/loginpasskey\/signature","role":"symbol","title":"signature","kind":"symbol","abstract":[]},"https://developer.apple.com/documentation/authenticationservices/asauthorizationplatformpublickeycredentialassertion":{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialassertion","type":"link","title":"ASAuthorizationPlatformPublicKeyCredentialAssertion","titleInlineContent":[{"type":"codeVoice","code":"ASAuthorizationPlatformPublicKeyCredentialAssertion"}],"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialassertion"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/LoginPasskey":{"role":"symbol","url":"\/documentation\/auth0\/loginpasskey","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"LoginPasskey"}],"navigatorTitle":[{"kind":"identifier","text":"LoginPasskey"}],"title":"LoginPasskey","abstract":[{"type":"text","text":"The login passkey credential obtained from the "},{"isActive":true,"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate"},{"type":"text","text":" delegate."},{"type":"text","text":" "},{"type":"text","text":"Contains the subset of relevant properties from "},{"isActive":true,"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialassertion"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey"]]},"metadata":{"platforms":[{"deprecated":false,"introducedAt":"16.6","unavailable":false,"name":"iOS","beta":false},{"deprecated":false,"introducedAt":"16.6","unavailable":false,"name":"iPadOS","beta":false},{"deprecated":false,"introducedAt":"16.6","unavailable":false,"name":"Mac Catalyst","beta":false},{"deprecated":false,"introducedAt":"13.5","unavailable":false,"name":"macOS","beta":false},{"deprecated":false,"introducedAt":"1.0","unavailable":false,"name":"visionOS","beta":false}],"symbolKind":"property","modules":[{"name":"Auth0"}],"title":"signature","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"signature","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Data","preciseIdentifier":"s:10Foundation4DataV","kind":"typeIdentifier"},{"text":"!","kind":"text"}],"externalID":"s:5Auth012LoginPasskeyP9signature10Foundation4DataVSgvp","role":"symbol","required":true,"roleHeading":"Instance Property"},"sections":[],"variants":[{"paths":["\/documentation\/auth0\/loginpasskey\/signature"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey\/signature","interfaceLanguage":"swift"},"kind":"symbol","schemaVersion":{"minor":3,"patch":0,"major":0},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"signature"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV","text":"Data"},{"kind":"text","text":"! { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}]}],"kind":"declarations"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/LoginPasskey":{"title":"LoginPasskey","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"LoginPasskey"}],"abstract":[{"text":"The login passkey credential obtained from the ","type":"text"},{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","isActive":true,"type":"reference"},{"text":" delegate.","type":"text"},{"text":" ","type":"text"},{"text":"Contains the subset of relevant properties from ","type":"text"},{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialassertion","isActive":true,"type":"reference"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/loginpasskey","navigatorTitle":[{"kind":"identifier","text":"LoginPasskey"}]},"https://developer.apple.com/documentation/authenticationservices/asauthorizationplatformpublickeycredentialassertion":{"title":"ASAuthorizationPlatformPublicKeyCredentialAssertion","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialassertion","titleInlineContent":[{"code":"ASAuthorizationPlatformPublicKeyCredentialAssertion","type":"codeVoice"}],"type":"link","url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialassertion"},"doc://com.auth0.Auth0/documentation/Auth0/LoginPasskey/signature":{"url":"\/documentation\/auth0\/loginpasskey\/signature","title":"signature","abstract":[],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"signature"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"!"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey\/signature","required":true,"kind":"symbol","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"https://developer.apple.com/documentation/authenticationservices/asauthorizationcontrollerdelegate":{"title":"ASAuthorizationControllerDelegate","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","titleInlineContent":[{"code":"ASAuthorizationControllerDelegate","type":"codeVoice"}],"type":"link","url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/loginpasskey/userid.json b/docs/data/documentation/auth0/loginpasskey/userid.json index 6036d2037..4ba0102c3 100644 --- a/docs/data/documentation/auth0/loginpasskey/userid.json +++ b/docs/data/documentation/auth0/loginpasskey/userid.json @@ -1 +1 @@ -{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/loginpasskey\/userid"]}],"kind":"symbol","sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey"]]},"schemaVersion":{"patch":0,"major":0,"minor":3},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"userID"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"! { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}]}],"kind":"declarations"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey\/userID","interfaceLanguage":"swift"},"metadata":{"externalID":"s:5Auth012LoginPasskeyP6userID10Foundation4DataVSgvp","required":true,"title":"userID","symbolKind":"property","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"userID","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Data","preciseIdentifier":"s:10Foundation4DataV","kind":"typeIdentifier"},{"text":"!","kind":"text"}],"role":"symbol","platforms":[{"beta":false,"deprecated":false,"unavailable":false,"name":"iOS","introducedAt":"16.6"},{"beta":false,"deprecated":false,"unavailable":false,"name":"iPadOS","introducedAt":"16.6"},{"beta":false,"deprecated":false,"unavailable":false,"name":"Mac Catalyst","introducedAt":"16.6"},{"beta":false,"deprecated":false,"unavailable":false,"name":"macOS","introducedAt":"13.5"},{"beta":false,"deprecated":false,"unavailable":false,"name":"visionOS","introducedAt":"1.0"}],"modules":[{"name":"Auth0"}],"roleHeading":"Instance Property"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/LoginPasskey/userID":{"required":true,"title":"userID","role":"symbol","type":"topic","url":"\/documentation\/auth0\/loginpasskey\/userid","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey\/userID","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"userID","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Data","preciseIdentifier":"s:10Foundation4DataV","kind":"typeIdentifier"},{"text":"!","kind":"text"}],"kind":"symbol","abstract":[]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"https://developer.apple.com/documentation/authenticationservices/asauthorizationcontrollerdelegate":{"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","titleInlineContent":[{"code":"ASAuthorizationControllerDelegate","type":"codeVoice"}],"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","type":"link","title":"ASAuthorizationControllerDelegate"},"https://developer.apple.com/documentation/authenticationservices/asauthorizationplatformpublickeycredentialassertion":{"titleInlineContent":[{"code":"ASAuthorizationPlatformPublicKeyCredentialAssertion","type":"codeVoice"}],"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialassertion","title":"ASAuthorizationPlatformPublicKeyCredentialAssertion","url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialassertion","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/LoginPasskey":{"role":"symbol","url":"\/documentation\/auth0\/loginpasskey","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"LoginPasskey"}],"navigatorTitle":[{"kind":"identifier","text":"LoginPasskey"}],"title":"LoginPasskey","abstract":[{"type":"text","text":"The login passkey credential obtained from the "},{"isActive":true,"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate"},{"type":"text","text":" delegate."},{"type":"text","text":" "},{"type":"text","text":"Contains the subset of relevant properties from "},{"isActive":true,"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialassertion"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey"}}} \ No newline at end of file +{"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"userID"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"! { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}]}],"kind":"declarations"}],"variants":[{"paths":["\/documentation\/auth0\/loginpasskey\/userid"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey"]]},"metadata":{"modules":[{"name":"Auth0"}],"title":"userID","roleHeading":"Instance Property","symbolKind":"property","role":"symbol","platforms":[{"deprecated":false,"introducedAt":"16.6","unavailable":false,"name":"iOS","beta":false},{"deprecated":false,"introducedAt":"16.6","unavailable":false,"name":"iPadOS","beta":false},{"deprecated":false,"introducedAt":"16.6","unavailable":false,"name":"Mac Catalyst","beta":false},{"deprecated":false,"introducedAt":"13.5","unavailable":false,"name":"macOS","beta":false},{"deprecated":false,"introducedAt":"1.0","unavailable":false,"name":"visionOS","beta":false}],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"userID"},{"kind":"text","text":": "},{"preciseIdentifier":"s:10Foundation4DataV","kind":"typeIdentifier","text":"Data"},{"kind":"text","text":"!"}],"required":true,"externalID":"s:5Auth012LoginPasskeyP6userID10Foundation4DataVSgvp"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey\/userID","interfaceLanguage":"swift"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/LoginPasskey/userID":{"kind":"symbol","required":true,"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"userID","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Data","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV"},{"text":"!","kind":"text"}],"title":"userID","type":"topic","role":"symbol","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey\/userID","url":"\/documentation\/auth0\/loginpasskey\/userid"},"doc://com.auth0.Auth0/documentation/Auth0/LoginPasskey":{"title":"LoginPasskey","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/LoginPasskey","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"LoginPasskey"}],"abstract":[{"text":"The login passkey credential obtained from the ","type":"text"},{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","isActive":true,"type":"reference"},{"text":" delegate.","type":"text"},{"text":" ","type":"text"},{"text":"Contains the subset of relevant properties from ","type":"text"},{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialassertion","isActive":true,"type":"reference"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/loginpasskey","navigatorTitle":[{"kind":"identifier","text":"LoginPasskey"}]},"https://developer.apple.com/documentation/authenticationservices/asauthorizationplatformpublickeycredentialassertion":{"title":"ASAuthorizationPlatformPublicKeyCredentialAssertion","type":"link","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialassertion","titleInlineContent":[{"code":"ASAuthorizationPlatformPublicKeyCredentialAssertion","type":"codeVoice"}],"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialassertion"},"https://developer.apple.com/documentation/authenticationservices/asauthorizationcontrollerdelegate":{"title":"ASAuthorizationControllerDelegate","type":"link","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","titleInlineContent":[{"code":"ASAuthorizationControllerDelegate","type":"codeVoice"}],"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/managementerror.json b/docs/data/documentation/auth0/managementerror.json index c4da64380..5ae08e94c 100644 --- a/docs/data/documentation/auth0/managementerror.json +++ b/docs/data/documentation/auth0/managementerror.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"},"metadata":{"symbolKind":"struct","roleHeading":"Structure","externalID":"s:5Auth015ManagementErrorV","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ManagementError","kind":"identifier"}],"navigatorTitle":[{"text":"ManagementError","kind":"identifier"}],"title":"ManagementError","modules":[{"name":"Auth0"}],"role":"symbol"},"topicSections":[{"generated":true,"title":"Initializers","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/init(info:statusCode:)"],"anchor":"Initializers"},{"generated":true,"title":"Instance Properties","identifiers":["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"],"anchor":"Instance-Properties"},{"generated":true,"title":"Default Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/Auth0APIError-Implementations","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"],"anchor":"Default-Implementations"}],"relationshipsSections":[{"title":"Conforms To","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","doc:\/\/com.auth0.Auth0\/10Foundation14LocalizedErrorP","doc:\/\/com.auth0.Auth0\/s8CopyableP","doc:\/\/com.auth0.Auth0\/s28CustomDebugStringConvertibleP","doc:\/\/com.auth0.Auth0\/SQ","doc:\/\/com.auth0.Auth0\/s5ErrorP","doc:\/\/com.auth0.Auth0\/s8SendableP","doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP"],"kind":"relationships","type":"conformsTo"}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"platforms":["iOS"]}],"kind":"declarations"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/managementerror"]}],"sections":[],"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"text":"Represents an error during a request to the Auth0 Management API v2.","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/Auth0APIError-Implementations":{"title":"Auth0APIError Implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/Auth0APIError-Implementations","url":"\/documentation\/auth0\/managementerror\/auth0apierror-implementations","kind":"article","role":"collectionGroup","abstract":[],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/debugDescription":{"title":"debugDescription","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/debugDescription","kind":"symbol","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"debugDescription","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"url":"\/documentation\/auth0\/managementerror\/debugdescription","type":"topic","abstract":[{"text":"Description of the error.","type":"text"}]},"doc://com.auth0.Auth0/s8CopyableP":{"type":"unresolvable","title":"Swift.Copyable","identifier":"doc:\/\/com.auth0.Auth0\/s8CopyableP"},"doc://com.auth0.Auth0/s28CustomDebugStringConvertibleP":{"identifier":"doc:\/\/com.auth0.Auth0\/s28CustomDebugStringConvertibleP","title":"Swift.CustomDebugStringConvertible","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/Auth0Error-Implementations":{"title":"Auth0Error Implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/Auth0Error-Implementations","url":"\/documentation\/auth0\/managementerror\/auth0error-implementations","kind":"article","role":"collectionGroup","abstract":[],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/s5ErrorP":{"identifier":"doc:\/\/com.auth0.Auth0\/s5ErrorP","title":"Swift.Error","type":"unresolvable"},"doc://com.auth0.Auth0/s8SendableP":{"type":"unresolvable","title":"Swift.Sendable","identifier":"doc:\/\/com.auth0.Auth0\/s8SendableP"},"doc://com.auth0.Auth0/SQ":{"identifier":"doc:\/\/com.auth0.Auth0\/SQ","title":"Swift.Equatable","type":"unresolvable"},"doc://com.auth0.Auth0/s16SendableMetatypeP":{"type":"unresolvable","title":"Swift.SendableMetatype","identifier":"doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error":{"url":"\/documentation\/auth0\/auth0error","title":"Auth0Error","kind":"symbol","type":"topic","abstract":[{"type":"text","text":"Generic representation of Auth0 errors."}],"role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Auth0Error"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","navigatorTitle":[{"kind":"identifier","text":"Auth0Error"}]},"doc://com.auth0.Auth0/10Foundation14LocalizedErrorP":{"identifier":"doc:\/\/com.auth0.Auth0\/10Foundation14LocalizedErrorP","title":"Foundation.LocalizedError","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/code":{"url":"\/documentation\/auth0\/managementerror\/code","abstract":[{"text":"Error code.","type":"text"}],"kind":"symbol","title":"code","role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/code","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"code","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/Equatable-Implementations":{"kind":"article","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/Equatable-Implementations","title":"Equatable Implementations","type":"topic","abstract":[],"url":"\/documentation\/auth0\/managementerror\/equatable-implementations","role":"collectionGroup"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"type":"topic","url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","kind":"symbol","title":"ManagementError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/statusCode":{"role":"symbol","url":"\/documentation\/auth0\/managementerror\/statuscode","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/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"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"}],"title":"statusCode","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/init(info:statusCode:)":{"fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"info"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"statusCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"kind":"text","text":")"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/init(info:statusCode:)","type":"topic","title":"init(info:statusCode:)","role":"symbol","abstract":[{"type":"text","text":"Creates an error from a JSON response."}],"kind":"symbol","url":"\/documentation\/auth0\/managementerror\/init(info:statuscode:)"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","type":"topic","url":"\/documentation\/auth0\/auth0apierror","title":"Auth0APIError","abstract":[{"type":"text","text":"Generic representation of Auth0 API errors."}],"role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Auth0APIError","kind":"identifier"}],"kind":"symbol","navigatorTitle":[{"text":"Auth0APIError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/LocalizedError-Implementations":{"abstract":[],"kind":"article","title":"LocalizedError Implementations","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/info":{"abstract":[{"text":"Raw error values.","type":"text"}],"role":"symbol","title":"info","kind":"symbol","url":"\/documentation\/auth0\/managementerror\/info","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"info","kind":"identifier"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"]","kind":"text"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/info"}}} \ No newline at end of file +{"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","interfaceLanguage":"swift"},"kind":"symbol","metadata":{"externalID":"s:5Auth015ManagementErrorV","modules":[{"name":"Auth0"}],"title":"ManagementError","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ManagementError","kind":"identifier"}],"roleHeading":"Structure","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}],"symbolKind":"struct"},"topicSections":[{"generated":true,"title":"Initializers","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/init(info:statusCode:)"],"anchor":"Initializers"},{"generated":true,"title":"Instance Properties","identifiers":["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"],"anchor":"Instance-Properties"},{"generated":true,"title":"Default Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/Auth0APIError-Implementations","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"],"anchor":"Default-Implementations"}],"relationshipsSections":[{"title":"Conforms To","kind":"relationships","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","doc:\/\/com.auth0.Auth0\/10Foundation14LocalizedErrorP","doc:\/\/com.auth0.Auth0\/s8CopyableP","doc:\/\/com.auth0.Auth0\/s28CustomDebugStringConvertibleP","doc:\/\/com.auth0.Auth0\/SQ","doc:\/\/com.auth0.Auth0\/s5ErrorP","doc:\/\/com.auth0.Auth0\/s8SendableP","doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP"],"type":"conformsTo"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/managementerror"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"schemaVersion":{"minor":3,"patch":0,"major":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"platforms":["iOS"],"languages":["swift"]}]}],"abstract":[{"text":"Represents an error during a request to the Auth0 Management API v2.","type":"text"}],"references":{"doc://com.auth0.Auth0/s28CustomDebugStringConvertibleP":{"title":"Swift.CustomDebugStringConvertible","identifier":"doc:\/\/com.auth0.Auth0\/s28CustomDebugStringConvertibleP","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/Auth0Error-Implementations":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/Auth0Error-Implementations","kind":"article","title":"Auth0Error Implementations","role":"collectionGroup","url":"\/documentation\/auth0\/managementerror\/auth0error-implementations","abstract":[],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/Equatable-Implementations":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/Equatable-Implementations","kind":"article","title":"Equatable Implementations","role":"collectionGroup","url":"\/documentation\/auth0\/managementerror\/equatable-implementations","abstract":[],"type":"topic"},"doc://com.auth0.Auth0/s8CopyableP":{"title":"Swift.Copyable","identifier":"doc:\/\/com.auth0.Auth0\/s8CopyableP","type":"unresolvable"},"doc://com.auth0.Auth0/s5ErrorP":{"title":"Swift.Error","identifier":"doc:\/\/com.auth0.Auth0\/s5ErrorP","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/init(info:statusCode:)":{"type":"topic","title":"init(info:statusCode:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/init(info:statusCode:)","kind":"symbol","abstract":[{"text":"Creates an error from a JSON response.","type":"text"}],"url":"\/documentation\/auth0\/managementerror\/init(info:statuscode:)","role":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"info","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"], ","kind":"text"},{"text":"statusCode","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"text":")","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/Auth0APIError-Implementations":{"url":"\/documentation\/auth0\/managementerror\/auth0apierror-implementations","abstract":[],"title":"Auth0APIError Implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/Auth0APIError-Implementations","role":"collectionGroup","kind":"article","type":"topic"},"doc://com.auth0.Auth0/s16SendableMetatypeP":{"title":"Swift.SendableMetatype","identifier":"doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/debugDescription":{"url":"\/documentation\/auth0\/managementerror\/debugdescription","abstract":[{"text":"Description of the error.","type":"text"}],"title":"debugDescription","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"debugDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/debugDescription","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError":{"url":"\/documentation\/auth0\/auth0apierror","abstract":[{"type":"text","text":"Generic representation of Auth0 API errors."}],"title":"Auth0APIError","navigatorTitle":[{"kind":"identifier","text":"Auth0APIError"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Auth0APIError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/LocalizedError-Implementations":{"url":"\/documentation\/auth0\/managementerror\/localizederror-implementations","abstract":[],"title":"LocalizedError Implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/LocalizedError-Implementations","role":"collectionGroup","kind":"article","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/code":{"url":"\/documentation\/auth0\/managementerror\/code","abstract":[{"text":"Error code.","type":"text"}],"title":"code","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"code","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/code","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/statusCode":{"url":"\/documentation\/auth0\/managementerror\/statuscode","abstract":[{"text":"HTTP status code of the response.","type":"text"}],"title":"statusCode","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"statusCode","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Int","preciseIdentifier":"s:Si","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/statusCode","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/info":{"type":"topic","abstract":[{"type":"text","text":"Raw error values."}],"kind":"symbol","title":"info","url":"\/documentation\/auth0\/managementerror\/info","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"info","kind":"identifier"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"]","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/info"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error":{"url":"\/documentation\/auth0\/auth0error","title":"Auth0Error","abstract":[{"type":"text","text":"Generic representation of Auth0 errors."}],"navigatorTitle":[{"kind":"identifier","text":"Auth0Error"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Auth0Error"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"title":"ManagementError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}]},"doc://com.auth0.Auth0/SQ":{"title":"Swift.Equatable","identifier":"doc:\/\/com.auth0.Auth0\/SQ","type":"unresolvable"},"doc://com.auth0.Auth0/10Foundation14LocalizedErrorP":{"title":"Foundation.LocalizedError","identifier":"doc:\/\/com.auth0.Auth0\/10Foundation14LocalizedErrorP","type":"unresolvable"},"doc://com.auth0.Auth0/s8SendableP":{"title":"Swift.Sendable","identifier":"doc:\/\/com.auth0.Auth0\/s8SendableP","type":"unresolvable"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/managementerror/!=(_:_:).json b/docs/data/documentation/auth0/managementerror/!=(_:_:).json index 1946ded0e..bb1ea8732 100644 --- a/docs/data/documentation/auth0/managementerror/!=(_:_:).json +++ b/docs/data/documentation/auth0/managementerror/!=(_:_:).json @@ -1 +1 @@ -{"abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"Equatable.!=(_:_:)"},{"type":"text","text":"."}],"variants":[{"paths":["\/documentation\/auth0\/managementerror\/!=(_:_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"!="},{"kind":"text","text":" "},{"kind":"text","text":"("},{"kind":"internalParam","text":"lhs"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":", "},{"kind":"internalParam","text":"rhs"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}]}],"kind":"declarations"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"modules":[{"relatedModules":["Swift"],"name":"Auth0"}],"roleHeading":"Operator","role":"symbol","externalID":"s:SQsE2neoiySbx_xtFZ::SYNTHESIZED::s:5Auth015ManagementErrorV","extendedModule":"Swift","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","text":"Self"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"title":"!=(_:_:)"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/!=(_:_:)"},"kind":"symbol","sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/!=(_:_:)":{"type":"topic","kind":"symbol","abstract":[],"url":"\/documentation\/auth0\/managementerror\/!=(_:_:)","title":"!=(_:_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/!=(_:_:)","role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"type":"topic","url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","kind":"symbol","title":"ManagementError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"!=","kind":"identifier"},{"kind":"text","text":" "},{"text":"(","kind":"text"},{"kind":"internalParam","text":"lhs"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Self"},{"text":", ","kind":"text"},{"text":"rhs","kind":"internalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/managementerror\/!=(_:_:)"]}],"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/!=(_:_:)","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"]]},"abstract":[{"type":"text","text":"Inherited from "},{"code":"Equatable.!=(_:_:)","type":"codeVoice"},{"type":"text","text":"."}],"metadata":{"roleHeading":"Operator","extendedModule":"Swift","title":"!=(_:_:)","role":"symbol","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","text":"Self"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"externalID":"s:SQsE2neoiySbx_xtFZ::SYNTHESIZED::s:5Auth015ManagementErrorV","modules":[{"relatedModules":["Swift"],"name":"Auth0"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/!=(_:_:)":{"type":"topic","abstract":[],"kind":"symbol","title":"!=(_:_:)","url":"\/documentation\/auth0\/managementerror\/!=(_:_:)","role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/!=(_:_:)"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"title":"ManagementError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/managementerror/==(_:_:).json b/docs/data/documentation/auth0/managementerror/==(_:_:).json index fa4c05007..fb7065052 100644 --- a/docs/data/documentation/auth0/managementerror/==(_:_:).json +++ b/docs/data/documentation/auth0/managementerror/==(_:_:).json @@ -1 +1 @@ -{"metadata":{"extendedModule":"Auth0","role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"==","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"ManagementError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"text":", ","kind":"text"},{"text":"ManagementError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"externalID":"s:5Auth015ManagementErrorV2eeoiySbAC_ACtFZ","modules":[{"name":"Auth0"}],"title":"==(_:_:)","roleHeading":"Operator","symbolKind":"op"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/==(_:_:)","interfaceLanguage":"swift"},"kind":"symbol","schemaVersion":{"minor":3,"patch":0,"major":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"]]},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"==","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"lhs","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"rhs","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"ManagementError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"abstract":[{"text":"Conformance to ","type":"text"},{"code":"Equatable","type":"codeVoice"},{"text":".","type":"text"}],"variants":[{"paths":["\/documentation\/auth0\/managementerror\/==(_:_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"type":"topic","url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","kind":"symbol","title":"ManagementError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/==(_:_:)":{"role":"symbol","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:5Auth015ManagementErrorV","text":"ManagementError"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"kind":"symbol","type":"topic","title":"==(_:_:)","url":"\/documentation\/auth0\/managementerror\/==(_:_:)","abstract":[{"type":"text","text":"Conformance to "},{"type":"codeVoice","code":"Equatable"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/==(_:_:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"]]},"metadata":{"externalID":"s:5Auth015ManagementErrorV2eeoiySbAC_ACtFZ","modules":[{"name":"Auth0"}],"title":"==(_:_:)","extendedModule":"Auth0","roleHeading":"Operator","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"==","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"role":"symbol","symbolKind":"op"},"sections":[],"abstract":[{"type":"text","text":"Conformance to "},{"type":"codeVoice","code":"Equatable"},{"type":"text","text":"."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/managementerror\/==(_:_:)"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/==(_:_:)"},"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"==","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"lhs","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"ManagementError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"text":", ","kind":"text"},{"text":"rhs","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"ManagementError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"text":") -> ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/==(_:_:)":{"url":"\/documentation\/auth0\/managementerror\/==(_:_:)","title":"==(_:_:)","abstract":[{"type":"text","text":"Conformance to "},{"type":"codeVoice","code":"Equatable"},{"type":"text","text":"."}],"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:5Auth015ManagementErrorV","text":"ManagementError"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/==(_:_:)","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"title":"ManagementError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/managementerror/auth0apierror-implementations.json b/docs/data/documentation/auth0/managementerror/auth0apierror-implementations.json index 3f9825878..01f760757 100644 --- a/docs/data/documentation/auth0/managementerror/auth0apierror-implementations.json +++ b/docs/data/documentation/auth0/managementerror/auth0apierror-implementations.json @@ -1 +1 @@ -{"topicSections":[{"anchor":"Instance-Properties","title":"Instance Properties","generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/cause","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/isNetworkError"]}],"variants":[{"paths":["\/documentation\/auth0\/managementerror\/auth0apierror-implementations"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/Auth0APIError-Implementations"},"metadata":{"title":"Auth0APIError Implementations","roleHeading":"API Collection","modules":[{"name":"Auth0"}],"role":"collectionGroup"},"sections":[],"schemaVersion":{"minor":3,"patch":0,"major":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"]]},"kind":"article","references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"type":"topic","url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","kind":"symbol","title":"ManagementError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/isNetworkError":{"abstract":[{"text":"Whether the request failed due to network issues.","type":"text"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/isNetworkError","url":"\/documentation\/auth0\/managementerror\/isnetworkerror","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isNetworkError","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"title":"isNetworkError","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/cause":{"url":"\/documentation\/auth0\/managementerror\/cause","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/cause","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP","text":"Error"},{"kind":"text","text":"?"}],"type":"topic","role":"symbol","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":"."}],"title":"cause"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"metadata":{"title":"Auth0APIError Implementations","roleHeading":"API Collection","role":"collectionGroup","modules":[{"name":"Auth0"}]},"sections":[],"variants":[{"paths":["\/documentation\/auth0\/managementerror\/auth0apierror-implementations"],"traits":[{"interfaceLanguage":"swift"}]}],"topicSections":[{"title":"Instance Properties","generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/cause","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/isNetworkError"],"anchor":"Instance-Properties"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/Auth0APIError-Implementations"},"kind":"article","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"title":"ManagementError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/isNetworkError":{"type":"topic","abstract":[{"text":"Whether the request failed due to network issues.","type":"text"}],"title":"isNetworkError","kind":"symbol","url":"\/documentation\/auth0\/managementerror\/isnetworkerror","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isNetworkError"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/isNetworkError"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/cause":{"type":"topic","title":"cause","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/cause","kind":"symbol","abstract":[{"text":"The underlying ","type":"text"},{"code":"Error","type":"codeVoice"},{"text":" value, if any. Defaults to ","type":"text"},{"code":"nil","type":"codeVoice"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/managementerror\/cause","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP","text":"Error"},{"kind":"text","text":"?"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/managementerror/auth0error-implementations.json b/docs/data/documentation/auth0/managementerror/auth0error-implementations.json index eae98cc70..879b0492e 100644 --- a/docs/data/documentation/auth0/managementerror/auth0error-implementations.json +++ b/docs/data/documentation/auth0/managementerror/auth0error-implementations.json @@ -1 +1 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/Auth0Error-Implementations","interfaceLanguage":"swift"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/managementerror\/auth0error-implementations"]}],"schemaVersion":{"major":0,"patch":0,"minor":3},"topicSections":[{"anchor":"Instance-Properties","title":"Instance Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/errorDescription","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/localizedDescription"],"generated":true}],"kind":"article","sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"]]},"metadata":{"roleHeading":"API Collection","title":"Auth0Error Implementations","role":"collectionGroup","modules":[{"name":"Auth0"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/localizedDescription":{"kind":"symbol","abstract":[{"type":"text","text":"Description of the error."}],"title":"localizedDescription","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/localizedDescription","type":"topic","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"localizedDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"url":"\/documentation\/auth0\/managementerror\/localizeddescription","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"type":"topic","url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","kind":"symbol","title":"ManagementError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/errorDescription":{"title":"errorDescription","url":"\/documentation\/auth0\/managementerror\/errordescription","type":"topic","role":"symbol","abstract":[{"text":"Description of the error.","type":"text"}],"kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"errorDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/errorDescription"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/Auth0Error-Implementations","interfaceLanguage":"swift"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/managementerror\/auth0error-implementations"]}],"kind":"article","metadata":{"title":"Auth0Error Implementations","roleHeading":"API Collection","role":"collectionGroup","modules":[{"name":"Auth0"}]},"schemaVersion":{"major":0,"minor":3,"patch":0},"topicSections":[{"title":"Instance Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/errorDescription","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/localizedDescription"],"anchor":"Instance-Properties","generated":true}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/localizedDescription":{"title":"localizedDescription","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/localizedDescription","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"localizedDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"abstract":[{"type":"text","text":"Description of the error."}],"url":"\/documentation\/auth0\/managementerror\/localizeddescription"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"title":"ManagementError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/errorDescription":{"title":"errorDescription","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/errorDescription","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"errorDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"Description of the error."}],"url":"\/documentation\/auth0\/managementerror\/errordescription"}}} \ 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 508a1ba25..a03034b33 100644 --- a/docs/data/documentation/auth0/managementerror/cause.json +++ b/docs/data/documentation/auth0/managementerror/cause.json @@ -1 +1 @@ -{"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/managementerror\/cause"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":"? { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"schemaVersion":{"major":0,"patch":0,"minor":3},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/cause","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"sections":[],"metadata":{"role":"symbol","title":"cause","modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","extendedModule":"Auth0","symbolKind":"property","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP","text":"Error"},{"kind":"text","text":"?"}],"externalID":"s:5Auth00A8APIErrorPAAE5causes5Error_pSgvp::SYNTHESIZED::s:5Auth015ManagementErrorV"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/cause":{"url":"\/documentation\/auth0\/managementerror\/cause","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/cause","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP","text":"Error"},{"kind":"text","text":"?"}],"type":"topic","role":"symbol","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":"."}],"title":"cause"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"type":"topic","url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","kind":"symbol","title":"ManagementError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}]}}} \ No newline at end of file +{"metadata":{"symbolKind":"property","title":"cause","externalID":"s:5Auth00A8APIErrorPAAE5causes5Error_pSgvp::SYNTHESIZED::s:5Auth015ManagementErrorV","extendedModule":"Auth0","roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":"?"}],"role":"symbol"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/managementerror\/cause"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/cause"},"kind":"symbol","abstract":[{"text":"The underlying ","type":"text"},{"code":"Error","type":"codeVoice"},{"text":" value, if any. Defaults to ","type":"text"},{"code":"nil","type":"codeVoice"},{"text":".","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":"? { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"languages":["swift"],"platforms":["iOS"]}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/cause":{"type":"topic","title":"cause","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/cause","kind":"symbol","abstract":[{"text":"The underlying ","type":"text"},{"code":"Error","type":"codeVoice"},{"text":" value, if any. Defaults to ","type":"text"},{"code":"nil","type":"codeVoice"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/managementerror\/cause","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP","text":"Error"},{"kind":"text","text":"?"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"title":"ManagementError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}]}}} \ 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 3a0b77acd..2193c4aee 100644 --- a/docs/data/documentation/auth0/managementerror/code.json +++ b/docs/data/documentation/auth0/managementerror/code.json @@ -1 +1 @@ -{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/managementerror\/code"]}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/code","interfaceLanguage":"swift"},"abstract":[{"text":"Error code.","type":"text"}],"metadata":{"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"code","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"title":"code","symbolKind":"property","roleHeading":"Instance Property","role":"symbol","externalID":"s:5Auth015ManagementErrorV4codeSSvp","modules":[{"name":"Auth0"}]},"sections":[],"schemaVersion":{"minor":3,"patch":0,"major":0},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"code"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"languages":["swift"]}],"kind":"declarations"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/code":{"url":"\/documentation\/auth0\/managementerror\/code","abstract":[{"text":"Error code.","type":"text"}],"kind":"symbol","title":"code","role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/code","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"code","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"type":"topic","url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","kind":"symbol","title":"ManagementError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"schemaVersion":{"patch":0,"minor":3,"major":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"code"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]}],"sections":[],"abstract":[{"type":"text","text":"Error code."}],"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/managementerror\/code"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"role":"symbol","title":"code","modules":[{"name":"Auth0"}],"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"code","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"externalID":"s:5Auth015ManagementErrorV4codeSSvp","roleHeading":"Instance Property","symbolKind":"property"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/code","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/code":{"url":"\/documentation\/auth0\/managementerror\/code","abstract":[{"text":"Error code.","type":"text"}],"title":"code","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"code","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/code","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"title":"ManagementError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"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 0cf2e42a1..2e6d1b31c 100644 --- a/docs/data/documentation/auth0/managementerror/debugdescription.json +++ b/docs/data/documentation/auth0/managementerror/debugdescription.json @@ -1 +1 @@ -{"metadata":{"title":"debugDescription","role":"symbol","roleHeading":"Instance Property","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"debugDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"symbolKind":"property","externalID":"s:5Auth015ManagementErrorV16debugDescriptionSSvp","modules":[{"name":"Auth0"}]},"kind":"symbol","sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/managementerror\/debugdescription"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/debugDescription","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"]]},"schemaVersion":{"major":0,"patch":0,"minor":3},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"debugDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"},{"content":[{"anchor":"discussion","level":2,"text":"Discussion","type":"heading"},{"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"}],"style":"important","name":"Important","type":"aside"}],"kind":"content"}],"abstract":[{"text":"Description of the error.","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/debugDescription":{"title":"debugDescription","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/debugDescription","kind":"symbol","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"debugDescription","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"url":"\/documentation\/auth0\/managementerror\/debugdescription","type":"topic","abstract":[{"text":"Description of the error.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"type":"topic","url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","kind":"symbol","title":"ManagementError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"metadata":{"symbolKind":"property","title":"debugDescription","externalID":"s:5Auth015ManagementErrorV16debugDescriptionSSvp","roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"debugDescription"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"role":"symbol"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/managementerror\/debugdescription"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/debugDescription","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"type":"text","text":"Description of the error."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"debugDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}]}]},{"kind":"content","content":[{"anchor":"discussion","text":"Discussion","type":"heading","level":2},{"name":"Important","type":"aside","style":"important","content":[{"inlineContent":[{"type":"text","text":"You should avoid displaying the error description to the user, it’s meant for "},{"type":"strong","inlineContent":[{"type":"text","text":"debugging"}]},{"type":"text","text":" only."}],"type":"paragraph"}]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/debugDescription":{"url":"\/documentation\/auth0\/managementerror\/debugdescription","abstract":[{"text":"Description of the error.","type":"text"}],"title":"debugDescription","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"debugDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/debugDescription","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"title":"ManagementError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"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 7b52ed24e..38bc51155 100644 --- a/docs/data/documentation/auth0/managementerror/equatable-implementations.json +++ b/docs/data/documentation/auth0/managementerror/equatable-implementations.json @@ -1 +1 @@ -{"topicSections":[{"title":"Operators","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/!=(_:_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/==(_:_:)"],"generated":true,"anchor":"Operators"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/managementerror\/equatable-implementations"]}],"metadata":{"modules":[{"name":"Auth0"}],"role":"collectionGroup","title":"Equatable Implementations","roleHeading":"API Collection"},"kind":"article","sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"]]},"schemaVersion":{"patch":0,"major":0,"minor":3},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/Equatable-Implementations"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/==(_:_:)":{"role":"symbol","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:5Auth015ManagementErrorV","text":"ManagementError"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"kind":"symbol","type":"topic","title":"==(_:_:)","url":"\/documentation\/auth0\/managementerror\/==(_:_:)","abstract":[{"type":"text","text":"Conformance to "},{"type":"codeVoice","code":"Equatable"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/==(_:_:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"type":"topic","url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","kind":"symbol","title":"ManagementError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/!=(_:_:)":{"type":"topic","kind":"symbol","abstract":[],"url":"\/documentation\/auth0\/managementerror\/!=(_:_:)","title":"!=(_:_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/!=(_:_:)","role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}]}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/managementerror\/equatable-implementations"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"]]},"topicSections":[{"title":"Operators","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/!=(_:_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/==(_:_:)"],"anchor":"Operators","generated":true}],"kind":"article","sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"title":"Equatable Implementations","role":"collectionGroup","modules":[{"name":"Auth0"}],"roleHeading":"API Collection"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/Equatable-Implementations"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"title":"ManagementError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/!=(_:_:)":{"type":"topic","abstract":[],"kind":"symbol","title":"!=(_:_:)","url":"\/documentation\/auth0\/managementerror\/!=(_:_:)","role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/!=(_:_:)"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/==(_:_:)":{"url":"\/documentation\/auth0\/managementerror\/==(_:_:)","title":"==(_:_:)","abstract":[{"type":"text","text":"Conformance to "},{"type":"codeVoice","code":"Equatable"},{"type":"text","text":"."}],"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:5Auth015ManagementErrorV","text":"ManagementError"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/==(_:_:)","role":"symbol","kind":"symbol","type":"topic"}}} \ 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 8cfbcaebb..d09d54553 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},"sections":[],"metadata":{"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"errorDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"roleHeading":"Instance Property","symbolKind":"property","modules":[{"name":"Auth0"}],"title":"errorDescription","extendedModule":"Auth0","role":"symbol","externalID":"s:5Auth00A5ErrorPAAE16errorDescriptionSSSgvp::SYNTHESIZED::s:5Auth015ManagementErrorV"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/managementerror\/errordescription"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/errorDescription","interfaceLanguage":"swift"},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"]]},"abstract":[{"type":"text","text":"Description of the error."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"errorDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"? { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"platforms":["iOS"],"languages":["swift"]}]},{"kind":"content","content":[{"anchor":"discussion","level":2,"text":"Discussion","type":"heading"},{"name":"Important","style":"important","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"You should avoid displaying the error description to the user, it’s meant for "},{"type":"strong","inlineContent":[{"type":"text","text":"debugging"}]},{"type":"text","text":" only."}]}],"type":"aside"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"type":"topic","url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","kind":"symbol","title":"ManagementError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/errorDescription":{"title":"errorDescription","url":"\/documentation\/auth0\/managementerror\/errordescription","type":"topic","role":"symbol","abstract":[{"text":"Description of the error.","type":"text"}],"kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"errorDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/errorDescription"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"]]},"metadata":{"roleHeading":"Instance Property","symbolKind":"property","modules":[{"name":"Auth0"}],"title":"errorDescription","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"errorDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"externalID":"s:5Auth00A5ErrorPAAE16errorDescriptionSSSgvp::SYNTHESIZED::s:5Auth015ManagementErrorV","role":"symbol","extendedModule":"Auth0"},"sections":[],"abstract":[{"type":"text","text":"Description of the error."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/managementerror\/errordescription"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/errorDescription","interfaceLanguage":"swift"},"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"errorDescription"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"? { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}]}]},{"content":[{"type":"heading","text":"Discussion","anchor":"discussion","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"}]},{"text":" only.","type":"text"}]}],"style":"important"}],"kind":"content"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"title":"ManagementError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/errorDescription":{"title":"errorDescription","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/errorDescription","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"errorDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"Description of the error."}],"url":"\/documentation\/auth0\/managementerror\/errordescription"}}} \ 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 e4708753f..c11cfa8b6 100644 --- a/docs/data/documentation/auth0/managementerror/failurereason.json +++ b/docs/data/documentation/auth0/managementerror/failurereason.json @@ -1 +1 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/failureReason","interfaceLanguage":"swift"},"kind":"symbol","metadata":{"extendedModule":"Foundation","title":"failureReason","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"failureReason"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"externalID":"s:10Foundation14LocalizedErrorPAAE13failureReasonSSSgvp::SYNTHESIZED::s:5Auth015ManagementErrorV","roleHeading":"Instance Property","platforms":[{"beta":false,"unavailable":false,"deprecated":false,"introducedAt":"8.0","name":"iOS"},{"beta":false,"unavailable":false,"deprecated":false,"introducedAt":"8.0","name":"iPadOS"},{"beta":false,"unavailable":false,"deprecated":false,"introducedAt":"8.0","name":"Mac Catalyst"},{"beta":false,"unavailable":false,"deprecated":false,"introducedAt":"10.10","name":"macOS"},{"beta":false,"unavailable":false,"deprecated":false,"introducedAt":"9.0","name":"tvOS"},{"beta":false,"unavailable":false,"deprecated":false,"introducedAt":"2.0","name":"watchOS"}],"role":"symbol","symbolKind":"property","modules":[{"relatedModules":["Foundation"],"name":"Auth0"}]},"sections":[],"variants":[{"paths":["\/documentation\/auth0\/managementerror\/failurereason"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"]]},"abstract":[{"text":"Inherited from ","type":"text"},{"code":"LocalizedError.failureReason","type":"codeVoice"},{"text":".","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"failureReason"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"? { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}]}]}],"schemaVersion":{"minor":3,"major":0,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"type":"topic","url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","kind":"symbol","title":"ManagementError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/failureReason":{"kind":"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"}],"type":"topic","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/failureReason","abstract":[],"url":"\/documentation\/auth0\/managementerror\/failurereason","title":"failureReason"}}} \ No newline at end of file +{"abstract":[{"type":"text","text":"Inherited from "},{"code":"LocalizedError.failureReason","type":"codeVoice"},{"type":"text","text":"."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"failureReason"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"? { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/managementerror\/failurereason"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"]]},"metadata":{"modules":[{"name":"Auth0","relatedModules":["Foundation"]}],"title":"failureReason","roleHeading":"Instance Property","symbolKind":"property","platforms":[{"name":"iOS","deprecated":false,"introducedAt":"8.0","beta":false,"unavailable":false},{"name":"iPadOS","deprecated":false,"introducedAt":"8.0","beta":false,"unavailable":false},{"name":"Mac Catalyst","deprecated":false,"introducedAt":"8.0","beta":false,"unavailable":false},{"name":"macOS","deprecated":false,"introducedAt":"10.10","beta":false,"unavailable":false},{"name":"tvOS","deprecated":false,"introducedAt":"9.0","beta":false,"unavailable":false},{"name":"watchOS","deprecated":false,"introducedAt":"2.0","beta":false,"unavailable":false}],"role":"symbol","extendedModule":"Foundation","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"failureReason"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"externalID":"s:10Foundation14LocalizedErrorPAAE13failureReasonSSSgvp::SYNTHESIZED::s:5Auth015ManagementErrorV"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/failureReason","interfaceLanguage":"swift"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"title":"ManagementError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/failureReason":{"url":"\/documentation\/auth0\/managementerror\/failurereason","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"failureReason"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"title":"failureReason","type":"topic","role":"symbol","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/failureReason","kind":"symbol"}}} \ 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 4fd77877a..487c1802c 100644 --- a/docs/data/documentation/auth0/managementerror/helpanchor.json +++ b/docs/data/documentation/auth0/managementerror/helpanchor.json @@ -1 +1 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/helpAnchor","interfaceLanguage":"swift"},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"helpAnchor","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"? { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"languages":["swift"]}],"kind":"declarations"}],"kind":"symbol","schemaVersion":{"patch":0,"major":0,"minor":3},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"]]},"variants":[{"paths":["\/documentation\/auth0\/managementerror\/helpanchor"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"LocalizedError.helpAnchor"},{"type":"text","text":"."}],"metadata":{"extendedModule":"Foundation","symbolKind":"property","roleHeading":"Instance Property","role":"symbol","externalID":"s:10Foundation14LocalizedErrorPAAE10helpAnchorSSSgvp::SYNTHESIZED::s:5Auth015ManagementErrorV","platforms":[{"beta":false,"introducedAt":"8.0","deprecated":false,"name":"iOS","unavailable":false},{"beta":false,"introducedAt":"8.0","deprecated":false,"name":"iPadOS","unavailable":false},{"beta":false,"introducedAt":"8.0","deprecated":false,"name":"Mac Catalyst","unavailable":false},{"beta":false,"introducedAt":"10.10","deprecated":false,"name":"macOS","unavailable":false},{"beta":false,"introducedAt":"9.0","deprecated":false,"name":"tvOS","unavailable":false},{"beta":false,"introducedAt":"2.0","deprecated":false,"name":"watchOS","unavailable":false}],"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"helpAnchor","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"title":"helpAnchor","modules":[{"relatedModules":["Foundation"],"name":"Auth0"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"type":"topic","url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","kind":"symbol","title":"ManagementError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/helpAnchor":{"url":"\/documentation\/auth0\/managementerror\/helpanchor","abstract":[],"type":"topic","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"helpAnchor","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/helpAnchor","role":"symbol","title":"helpAnchor","kind":"symbol"}}} \ No newline at end of file +{"variants":[{"paths":["\/documentation\/auth0\/managementerror\/helpanchor"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"]]},"abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"LocalizedError.helpAnchor"},{"type":"text","text":"."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"helpAnchor"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"? { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"platforms":["iOS"]}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"kind":"symbol","sections":[],"metadata":{"externalID":"s:10Foundation14LocalizedErrorPAAE10helpAnchorSSSgvp::SYNTHESIZED::s:5Auth015ManagementErrorV","extendedModule":"Foundation","platforms":[{"beta":false,"introducedAt":"8.0","deprecated":false,"name":"iOS","unavailable":false},{"beta":false,"introducedAt":"8.0","deprecated":false,"name":"iPadOS","unavailable":false},{"beta":false,"introducedAt":"8.0","deprecated":false,"name":"Mac Catalyst","unavailable":false},{"beta":false,"introducedAt":"10.10","deprecated":false,"name":"macOS","unavailable":false},{"beta":false,"introducedAt":"9.0","deprecated":false,"name":"tvOS","unavailable":false},{"beta":false,"introducedAt":"2.0","deprecated":false,"name":"watchOS","unavailable":false}],"symbolKind":"property","title":"helpAnchor","roleHeading":"Instance Property","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"helpAnchor","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"modules":[{"name":"Auth0","relatedModules":["Foundation"]}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/helpAnchor"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"title":"ManagementError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/helpAnchor":{"type":"topic","abstract":[],"kind":"symbol","title":"helpAnchor","url":"\/documentation\/auth0\/managementerror\/helpanchor","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"helpAnchor","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/helpAnchor"}}} \ 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 054c9aaac..3633d7c3c 100644 --- a/docs/data/documentation/auth0/managementerror/info.json +++ b/docs/data/documentation/auth0/managementerror/info.json @@ -1 +1 @@ -{"abstract":[{"text":"Raw error values.","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"info"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]"}],"languages":["swift"],"platforms":["iOS"]}]}],"metadata":{"modules":[{"name":"Auth0"}],"role":"symbol","title":"info","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"info"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]"}],"roleHeading":"Instance Property","externalID":"s:5Auth015ManagementErrorV4infoSDySSypGvp","symbolKind":"property"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"]]},"sections":[],"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/managementerror\/info"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/info","interfaceLanguage":"swift"},"schemaVersion":{"patch":0,"minor":3,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/info":{"abstract":[{"text":"Raw error values.","type":"text"}],"role":"symbol","title":"info","kind":"symbol","url":"\/documentation\/auth0\/managementerror\/info","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"info","kind":"identifier"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"]","kind":"text"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/info"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"type":"topic","url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","kind":"symbol","title":"ManagementError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}]}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/managementerror\/info"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"]]},"abstract":[{"type":"text","text":"Raw error values."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"info","kind":"identifier"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"]","kind":"text"}]}]}],"kind":"symbol","sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"externalID":"s:5Auth015ManagementErrorV4infoSDySSypGvp","symbolKind":"property","title":"info","role":"symbol","roleHeading":"Instance Property","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"info","kind":"identifier"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"]","kind":"text"}],"modules":[{"name":"Auth0"}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/info"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/info":{"type":"topic","abstract":[{"type":"text","text":"Raw error values."}],"kind":"symbol","title":"info","url":"\/documentation\/auth0\/managementerror\/info","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"info","kind":"identifier"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"]","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/info"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"title":"ManagementError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/managementerror/init(info:statuscode:).json b/docs/data/documentation/auth0/managementerror/init(info:statuscode:).json index 363aae2bd..577ba82c3 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:)"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"symbolKind":"init","modules":[{"name":"Auth0"}],"fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"info","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"], ","kind":"text"},{"text":"statusCode","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"text":")","kind":"text"}],"title":"init(info:statusCode:)","roleHeading":"Initializer","role":"symbol","externalID":"s:5Auth015ManagementErrorV4info10statusCodeACSDySSypG_Sitcfc"},"abstract":[{"text":"Creates an error from a JSON response.","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/init(info:statusCode:)","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"init","kind":"keyword"},{"text":"(","kind":"text"},{"text":"info","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"], ","kind":"text"},{"text":"statusCode","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"text":")","kind":"text"}],"platforms":["iOS"]}]},{"kind":"parameters","parameters":[{"name":"info","content":[{"inlineContent":[{"text":"JSON response from Auth0.","type":"text"}],"type":"paragraph"}]},{"name":"statusCode","content":[{"type":"paragraph","inlineContent":[{"text":"HTTP status code of the response.","type":"text"}]}]}]},{"kind":"content","content":[{"type":"heading","level":2,"text":"Return Value","anchor":"return-value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A new "},{"type":"codeVoice","code":"ManagementError"},{"type":"text","text":"."}]}]}],"sections":[],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"type":"topic","url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","kind":"symbol","title":"ManagementError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/init(info:statusCode:)":{"fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"info"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"statusCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"kind":"text","text":")"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/init(info:statusCode:)","type":"topic","title":"init(info:statusCode:)","role":"symbol","abstract":[{"type":"text","text":"Creates an error from a JSON response."}],"kind":"symbol","url":"\/documentation\/auth0\/managementerror\/init(info:statuscode:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"metadata":{"symbolKind":"init","title":"init(info:statusCode:)","externalID":"s:5Auth015ManagementErrorV4info10statusCodeACSDySSypG_Sitcfc","roleHeading":"Initializer","modules":[{"name":"Auth0"}],"fragments":[{"kind":"identifier","text":"init"},{"text":"(","kind":"text"},{"text":"info","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"], ","kind":"text"},{"text":"statusCode","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Int","preciseIdentifier":"s:Si","kind":"typeIdentifier"},{"text":")","kind":"text"}],"role":"symbol"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/managementerror\/init(info:statuscode:)"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/init(info:statusCode:)"},"kind":"symbol","abstract":[{"text":"Creates an error from a JSON response.","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"init"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"info"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"], ","kind":"text"},{"text":"statusCode","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Int","preciseIdentifier":"s:Si","kind":"typeIdentifier"},{"text":")","kind":"text"}]}]},{"parameters":[{"content":[{"inlineContent":[{"type":"text","text":"JSON response from Auth0."}],"type":"paragraph"}],"name":"info"},{"content":[{"inlineContent":[{"text":"HTTP status code of the response.","type":"text"}],"type":"paragraph"}],"name":"statusCode"}],"kind":"parameters"},{"kind":"content","content":[{"level":2,"type":"heading","anchor":"return-value","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A new "},{"code":"ManagementError","type":"codeVoice"},{"type":"text","text":"."}]}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"title":"ManagementError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/init(info:statusCode:)":{"type":"topic","title":"init(info:statusCode:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/init(info:statusCode:)","kind":"symbol","abstract":[{"text":"Creates an error from a JSON response.","type":"text"}],"url":"\/documentation\/auth0\/managementerror\/init(info:statuscode:)","role":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"info","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"], ","kind":"text"},{"text":"statusCode","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"text":")","kind":"text"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/managementerror/isnetworkerror.json b/docs/data/documentation/auth0/managementerror/isnetworkerror.json index 2a76a235c..d8da080d5 100644 --- a/docs/data/documentation/auth0/managementerror/isnetworkerror.json +++ b/docs/data/documentation/auth0/managementerror/isnetworkerror.json @@ -1 +1 @@ -{"metadata":{"symbolKind":"property","modules":[{"name":"Auth0"}],"extendedModule":"Auth0","title":"isNetworkError","roleHeading":"Instance Property","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isNetworkError","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"externalID":"s:5Auth00A8APIErrorPAAE14isNetworkErrorSbvp::SYNTHESIZED::s:5Auth015ManagementErrorV","role":"symbol"},"sections":[],"kind":"symbol","schemaVersion":{"patch":0,"major":0,"minor":3},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isNetworkError","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]},{"kind":"content","content":[{"type":"heading","text":"Discussion","level":2,"anchor":"discussion"},{"type":"paragraph","inlineContent":[{"text":"Returns ","type":"text"},{"type":"codeVoice","code":"true"},{"text":" when the ","type":"text"},{"type":"codeVoice","code":"URLError"},{"text":" code is one of the following:","type":"text"}]},{"type":"unorderedList","items":[{"content":[{"inlineContent":[{"isActive":true,"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/datanotallowed","type":"reference"}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"isActive":true,"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/notconnectedtointernet"}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/networkconnectionlost","isActive":true}]}]},{"content":[{"type":"paragraph","inlineContent":[{"isActive":true,"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/dnslookupfailed"}]}]},{"content":[{"inlineContent":[{"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/cannotfindhost","isActive":true,"type":"reference"}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/cannotconnecttohost","isActive":true,"type":"reference"}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"isActive":true,"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/timedout","type":"reference"}]}]},{"content":[{"type":"paragraph","inlineContent":[{"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/internationalroamingoff","type":"reference","isActive":true}]}]},{"content":[{"inlineContent":[{"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/callisactive","isActive":true}],"type":"paragraph"}]}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"The underlying "},{"code":"URLError","type":"codeVoice"},{"type":"text","text":" is available in the "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/cause","isActive":true},{"type":"text","text":" property."}]}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/isNetworkError"},"variants":[{"paths":["\/documentation\/auth0\/managementerror\/isnetworkerror"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"type":"text","text":"Whether the request failed due to network issues."}],"references":{"https://developer.apple.com/documentation/foundation/urlerror/datanotallowed":{"url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/datanotallowed","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/datanotallowed","titleInlineContent":[{"text":"dataNotAllowed","type":"text"}],"type":"link","title":"dataNotAllowed"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/cause":{"url":"\/documentation\/auth0\/managementerror\/cause","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/cause","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP","text":"Error"},{"kind":"text","text":"?"}],"type":"topic","role":"symbol","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":"."}],"title":"cause"},"https://developer.apple.com/documentation/foundation/urlerror/networkconnectionlost":{"url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/networkconnectionlost","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/networkconnectionlost","titleInlineContent":[{"type":"text","text":"networkConnectionLost"}],"type":"link","title":"networkConnectionLost"},"https://developer.apple.com/documentation/foundation/urlerror/callisactive":{"url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/callisactive","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/callisactive","titleInlineContent":[{"text":"callIsActive","type":"text"}],"type":"link","title":"callIsActive"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"type":"topic","url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","kind":"symbol","title":"ManagementError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}]},"https://developer.apple.com/documentation/foundation/urlerror/timedout":{"url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/timedout","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/timedout","titleInlineContent":[{"type":"text","text":"timedOut"}],"type":"link","title":"timedOut"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/isNetworkError":{"abstract":[{"text":"Whether the request failed due to network issues.","type":"text"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/isNetworkError","url":"\/documentation\/auth0\/managementerror\/isnetworkerror","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isNetworkError","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"title":"isNetworkError","type":"topic"},"https://developer.apple.com/documentation/foundation/urlerror/cannotconnecttohost":{"url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/cannotconnecttohost","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/cannotconnecttohost","titleInlineContent":[{"text":"cannotConnectToHost","type":"text"}],"type":"link","title":"cannotConnectToHost"},"https://developer.apple.com/documentation/foundation/urlerror/cannotfindhost":{"url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/cannotfindhost","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/cannotfindhost","titleInlineContent":[{"type":"text","text":"cannotFindHost"}],"type":"link","title":"cannotFindHost"},"https://developer.apple.com/documentation/foundation/urlerror/dnslookupfailed":{"url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/dnslookupfailed","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/dnslookupfailed","titleInlineContent":[{"text":"dnsLookupFailed","type":"text"}],"type":"link","title":"dnsLookupFailed"},"https://developer.apple.com/documentation/foundation/urlerror/internationalroamingoff":{"url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/internationalroamingoff","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/internationalroamingoff","titleInlineContent":[{"type":"text","text":"internationalRoamingOff"}],"type":"link","title":"internationalRoamingOff"},"https://developer.apple.com/documentation/foundation/urlerror/notconnectedtointernet":{"url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/notconnectedtointernet","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/notconnectedtointernet","titleInlineContent":[{"text":"notConnectedToInternet","type":"text"}],"type":"link","title":"notConnectedToInternet"}}} \ No newline at end of file +{"abstract":[{"text":"Whether the request failed due to network issues.","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isNetworkError","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"platforms":["iOS"],"languages":["swift"]}]},{"kind":"content","content":[{"level":2,"text":"Discussion","anchor":"discussion","type":"heading"},{"inlineContent":[{"text":"Returns ","type":"text"},{"code":"true","type":"codeVoice"},{"text":" when the ","type":"text"},{"code":"URLError","type":"codeVoice"},{"text":" code is one of the following:","type":"text"}],"type":"paragraph"},{"type":"unorderedList","items":[{"content":[{"inlineContent":[{"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/datanotallowed","isActive":true,"type":"reference"}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/notconnectedtointernet","type":"reference","isActive":true}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"isActive":true,"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/networkconnectionlost"}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/dnslookupfailed","isActive":true,"type":"reference"}]}]},{"content":[{"type":"paragraph","inlineContent":[{"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/cannotfindhost","isActive":true,"type":"reference"}]}]},{"content":[{"type":"paragraph","inlineContent":[{"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/cannotconnecttohost","isActive":true,"type":"reference"}]}]},{"content":[{"type":"paragraph","inlineContent":[{"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/timedout","isActive":true,"type":"reference"}]}]},{"content":[{"type":"paragraph","inlineContent":[{"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/internationalroamingoff","isActive":true,"type":"reference"}]}]},{"content":[{"inlineContent":[{"isActive":true,"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/callisactive"}],"type":"paragraph"}]}]},{"inlineContent":[{"text":"The underlying ","type":"text"},{"code":"URLError","type":"codeVoice"},{"text":" is available in the ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/cause","isActive":true,"type":"reference"},{"text":" property.","type":"text"}],"type":"paragraph"}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/managementerror\/isnetworkerror"]}],"schemaVersion":{"minor":3,"major":0,"patch":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"]]},"metadata":{"modules":[{"name":"Auth0"}],"title":"isNetworkError","roleHeading":"Instance Property","symbolKind":"property","role":"symbol","extendedModule":"Auth0","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isNetworkError","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"externalID":"s:5Auth00A8APIErrorPAAE14isNetworkErrorSbvp::SYNTHESIZED::s:5Auth015ManagementErrorV"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/isNetworkError","interfaceLanguage":"swift"},"kind":"symbol","references":{"https://developer.apple.com/documentation/foundation/urlerror/networkconnectionlost":{"url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/networkconnectionlost","titleInlineContent":[{"type":"text","text":"networkConnectionLost"}],"title":"networkConnectionLost","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/networkconnectionlost","type":"link"},"https://developer.apple.com/documentation/foundation/urlerror/cannotconnecttohost":{"url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/cannotconnecttohost","titleInlineContent":[{"type":"text","text":"cannotConnectToHost"}],"title":"cannotConnectToHost","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/cannotconnecttohost","type":"link"},"https://developer.apple.com/documentation/foundation/urlerror/callisactive":{"url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/callisactive","titleInlineContent":[{"type":"text","text":"callIsActive"}],"title":"callIsActive","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/callisactive","type":"link"},"https://developer.apple.com/documentation/foundation/urlerror/cannotfindhost":{"url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/cannotfindhost","titleInlineContent":[{"type":"text","text":"cannotFindHost"}],"title":"cannotFindHost","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/cannotfindhost","type":"link"},"https://developer.apple.com/documentation/foundation/urlerror/internationalroamingoff":{"url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/internationalroamingoff","titleInlineContent":[{"type":"text","text":"internationalRoamingOff"}],"title":"internationalRoamingOff","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/internationalroamingoff","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"https://developer.apple.com/documentation/foundation/urlerror/notconnectedtointernet":{"url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/notconnectedtointernet","titleInlineContent":[{"type":"text","text":"notConnectedToInternet"}],"title":"notConnectedToInternet","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/notconnectedtointernet","type":"link"},"https://developer.apple.com/documentation/foundation/urlerror/datanotallowed":{"url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/datanotallowed","titleInlineContent":[{"type":"text","text":"dataNotAllowed"}],"title":"dataNotAllowed","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/datanotallowed","type":"link"},"https://developer.apple.com/documentation/foundation/urlerror/timedout":{"url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/timedout","titleInlineContent":[{"type":"text","text":"timedOut"}],"title":"timedOut","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/timedout","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"title":"ManagementError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}]},"https://developer.apple.com/documentation/foundation/urlerror/dnslookupfailed":{"url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/dnslookupfailed","titleInlineContent":[{"type":"text","text":"dnsLookupFailed"}],"title":"dnsLookupFailed","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/dnslookupfailed","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/cause":{"type":"topic","title":"cause","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/cause","kind":"symbol","abstract":[{"text":"The underlying ","type":"text"},{"code":"Error","type":"codeVoice"},{"text":" value, if any. Defaults to ","type":"text"},{"code":"nil","type":"codeVoice"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/managementerror\/cause","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP","text":"Error"},{"kind":"text","text":"?"}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/isNetworkError":{"type":"topic","abstract":[{"text":"Whether the request failed due to network issues.","type":"text"}],"title":"isNetworkError","kind":"symbol","url":"\/documentation\/auth0\/managementerror\/isnetworkerror","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isNetworkError"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/isNetworkError"}}} \ 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 25c214dcf..e98c2c84d 100644 --- a/docs/data/documentation/auth0/managementerror/localizeddescription.json +++ b/docs/data/documentation/auth0/managementerror/localizeddescription.json @@ -1 +1 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/localizedDescription","interfaceLanguage":"swift"},"abstract":[{"text":"Description of the error.","type":"text"}],"kind":"symbol","sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"]]},"schemaVersion":{"minor":3,"major":0,"patch":0},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"localizedDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}]}],"kind":"declarations"},{"content":[{"level":2,"anchor":"discussion","type":"heading","text":"Discussion"},{"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"}],"type":"aside","style":"important","name":"Important"}],"kind":"content"}],"variants":[{"paths":["\/documentation\/auth0\/managementerror\/localizeddescription"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"externalID":"s:5Auth00A5ErrorPAAE20localizedDescriptionSSvp::SYNTHESIZED::s:5Auth015ManagementErrorV","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"localizedDescription","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"symbolKind":"property","role":"symbol","extendedModule":"Auth0","roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"title":"localizedDescription"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"type":"topic","url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","kind":"symbol","title":"ManagementError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/localizedDescription":{"kind":"symbol","abstract":[{"type":"text","text":"Description of the error."}],"title":"localizedDescription","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/localizedDescription","type":"topic","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"localizedDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"url":"\/documentation\/auth0\/managementerror\/localizeddescription","role":"symbol"}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/managementerror\/localizeddescription"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"]]},"abstract":[{"type":"text","text":"Description of the error."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"localizedDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}]}]},{"kind":"content","content":[{"type":"heading","anchor":"discussion","level":2,"text":"Discussion"},{"type":"aside","name":"Important","content":[{"inlineContent":[{"text":"You should avoid displaying the error description to the user, it’s meant for ","type":"text"},{"inlineContent":[{"type":"text","text":"debugging"}],"type":"strong"},{"text":" only.","type":"text"}],"type":"paragraph"}],"style":"important"}]}],"kind":"symbol","sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"externalID":"s:5Auth00A5ErrorPAAE20localizedDescriptionSSvp::SYNTHESIZED::s:5Auth015ManagementErrorV","extendedModule":"Auth0","symbolKind":"property","title":"localizedDescription","role":"symbol","roleHeading":"Instance Property","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"localizedDescription"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"modules":[{"name":"Auth0"}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/localizedDescription"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/localizedDescription":{"title":"localizedDescription","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/localizedDescription","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"localizedDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"abstract":[{"type":"text","text":"Description of the error."}],"url":"\/documentation\/auth0\/managementerror\/localizeddescription"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"title":"ManagementError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"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 3d0cbafc0..917a02ac7 100644 --- a/docs/data/documentation/auth0/managementerror/localizederror-implementations.json +++ b/docs/data/documentation/auth0/managementerror/localizederror-implementations.json @@ -1 +1 @@ -{"metadata":{"modules":[{"name":"Auth0"}],"roleHeading":"API Collection","title":"LocalizedError Implementations","role":"collectionGroup"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/managementerror\/localizederror-implementations"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/LocalizedError-Implementations"},"topicSections":[{"anchor":"Instance-Properties","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}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"article","sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/failureReason":{"kind":"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"}],"type":"topic","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/failureReason","abstract":[],"url":"\/documentation\/auth0\/managementerror\/failurereason","title":"failureReason"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/helpAnchor":{"url":"\/documentation\/auth0\/managementerror\/helpanchor","abstract":[],"type":"topic","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"helpAnchor","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/helpAnchor","role":"symbol","title":"helpAnchor","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"type":"topic","url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","kind":"symbol","title":"ManagementError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/recoverySuggestion":{"kind":"symbol","abstract":[],"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"recoverySuggestion","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"type":"topic","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/recoverySuggestion","title":"recoverySuggestion","url":"\/documentation\/auth0\/managementerror\/recoverysuggestion"}}} \ No newline at end of file +{"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/LocalizedError-Implementations","interfaceLanguage":"swift"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/managementerror\/localizederror-implementations"]}],"kind":"article","metadata":{"title":"LocalizedError Implementations","modules":[{"name":"Auth0"}],"roleHeading":"API Collection","role":"collectionGroup"},"schemaVersion":{"major":0,"minor":3,"patch":0},"topicSections":[{"title":"Instance Properties","generated":true,"anchor":"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"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/helpAnchor":{"type":"topic","abstract":[],"kind":"symbol","title":"helpAnchor","url":"\/documentation\/auth0\/managementerror\/helpanchor","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"helpAnchor","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/helpAnchor"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/recoverySuggestion":{"title":"recoverySuggestion","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/recoverySuggestion","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"recoverySuggestion"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}],"abstract":[],"url":"\/documentation\/auth0\/managementerror\/recoverysuggestion"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/failureReason":{"url":"\/documentation\/auth0\/managementerror\/failurereason","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"failureReason"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"title":"failureReason","type":"topic","role":"symbol","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/failureReason","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"title":"ManagementError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}]}}} \ 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 58189a546..d999a8d77 100644 --- a/docs/data/documentation/auth0/managementerror/recoverysuggestion.json +++ b/docs/data/documentation/auth0/managementerror/recoverysuggestion.json @@ -1 +1 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/recoverySuggestion","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"recoverySuggestion","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"? { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}]}],"kind":"symbol","schemaVersion":{"patch":0,"minor":3,"major":0},"metadata":{"externalID":"s:10Foundation14LocalizedErrorPAAE18recoverySuggestionSSSgvp::SYNTHESIZED::s:5Auth015ManagementErrorV","extendedModule":"Foundation","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"recoverySuggestion","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"symbolKind":"property","roleHeading":"Instance Property","role":"symbol","title":"recoverySuggestion","platforms":[{"name":"iOS","introducedAt":"8.0","unavailable":false,"deprecated":false,"beta":false},{"name":"iPadOS","introducedAt":"8.0","unavailable":false,"deprecated":false,"beta":false},{"name":"Mac Catalyst","introducedAt":"8.0","unavailable":false,"deprecated":false,"beta":false},{"name":"macOS","introducedAt":"10.10","unavailable":false,"deprecated":false,"beta":false},{"name":"tvOS","introducedAt":"9.0","unavailable":false,"deprecated":false,"beta":false},{"name":"watchOS","introducedAt":"2.0","unavailable":false,"deprecated":false,"beta":false}],"modules":[{"name":"Auth0","relatedModules":["Foundation"]}]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/managementerror\/recoverysuggestion"]}],"abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"LocalizedError.recoverySuggestion"},{"type":"text","text":"."}],"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/recoverySuggestion":{"kind":"symbol","abstract":[],"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"recoverySuggestion","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"type":"topic","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/recoverySuggestion","title":"recoverySuggestion","url":"\/documentation\/auth0\/managementerror\/recoverysuggestion"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"type":"topic","url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","kind":"symbol","title":"ManagementError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}]}}} \ No newline at end of file +{"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"recoverySuggestion"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"? { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/managementerror\/recoverysuggestion"]}],"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"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\/recoverySuggestion"},"abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"LocalizedError.recoverySuggestion"},{"type":"text","text":"."}],"metadata":{"roleHeading":"Instance Property","extendedModule":"Foundation","title":"recoverySuggestion","role":"symbol","symbolKind":"property","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"recoverySuggestion"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}],"externalID":"s:10Foundation14LocalizedErrorPAAE18recoverySuggestionSSSgvp::SYNTHESIZED::s:5Auth015ManagementErrorV","modules":[{"name":"Auth0","relatedModules":["Foundation"]}],"platforms":[{"deprecated":false,"name":"iOS","beta":false,"introducedAt":"8.0","unavailable":false},{"deprecated":false,"name":"iPadOS","beta":false,"introducedAt":"8.0","unavailable":false},{"deprecated":false,"name":"Mac Catalyst","beta":false,"introducedAt":"8.0","unavailable":false},{"deprecated":false,"name":"macOS","beta":false,"introducedAt":"10.10","unavailable":false},{"deprecated":false,"name":"tvOS","beta":false,"introducedAt":"9.0","unavailable":false},{"deprecated":false,"name":"watchOS","beta":false,"introducedAt":"2.0","unavailable":false}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"title":"ManagementError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/recoverySuggestion":{"title":"recoverySuggestion","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/recoverySuggestion","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"recoverySuggestion"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}],"abstract":[],"url":"\/documentation\/auth0\/managementerror\/recoverysuggestion"}}} \ 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 28c5fa499..3f651b205 100644 --- a/docs/data/documentation/auth0/managementerror/statuscode.json +++ b/docs/data/documentation/auth0/managementerror/statuscode.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/statusCode","interfaceLanguage":"swift"},"kind":"symbol","schemaVersion":{"patch":0,"major":0,"minor":3},"abstract":[{"text":"HTTP status code of the response.","type":"text"}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"statusCode","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"}]}],"kind":"declarations"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/managementerror\/statuscode"]}],"metadata":{"roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"statusCode","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"}],"title":"statusCode","symbolKind":"property","externalID":"s:5Auth015ManagementErrorV10statusCodeSivp","role":"symbol"},"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/statusCode":{"role":"symbol","url":"\/documentation\/auth0\/managementerror\/statuscode","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/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"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"}],"title":"statusCode","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"type":"topic","url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","kind":"symbol","title":"ManagementError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}]}}} \ No newline at end of file +{"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"statusCode","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Int","preciseIdentifier":"s:Si","kind":"typeIdentifier"}]}]}],"sections":[],"abstract":[{"type":"text","text":"HTTP status code of the response."}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/managementerror\/statuscode"]}],"metadata":{"roleHeading":"Instance Property","symbolKind":"property","title":"statusCode","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"statusCode","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Int","preciseIdentifier":"s:Si","kind":"typeIdentifier"}],"externalID":"s:5Auth015ManagementErrorV10statusCodeSivp","modules":[{"name":"Auth0"}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/statusCode"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError/statusCode":{"url":"\/documentation\/auth0\/managementerror\/statuscode","abstract":[{"text":"HTTP status code of the response.","type":"text"}],"title":"statusCode","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"statusCode","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Int","preciseIdentifier":"s:Si","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError\/statusCode","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"title":"ManagementError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/managementobject.json b/docs/data/documentation/auth0/managementobject.json index 6d2f41b4e..018b4de68 100644 --- a/docs/data/documentation/auth0/managementobject.json +++ b/docs/data/documentation/auth0/managementobject.json @@ -1 +1 @@ -{"abstract":[{"text":"A dictionary containing a user profile.","type":"text"}],"metadata":{"symbolKind":"typealias","title":"ManagementObject","roleHeading":"Type Alias","navigatorTitle":[{"text":"ManagementObject","kind":"identifier"}],"role":"symbol","externalID":"s:5Auth016ManagementObjecta","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ManagementObject","kind":"identifier"}],"modules":[{"name":"Auth0"}]},"schemaVersion":{"patch":0,"major":0,"minor":3},"sections":[],"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementObject"},{"kind":"text","text":" = ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]"}]}]}],"variants":[{"paths":["\/documentation\/auth0\/managementobject"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementObject":{"type":"topic","title":"ManagementObject","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","role":"symbol","kind":"symbol","navigatorTitle":[{"text":"ManagementObject","kind":"identifier"}],"fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ManagementObject","kind":"identifier"}],"url":"\/documentation\/auth0\/managementobject","abstract":[{"text":"A dictionary containing a user profile.","type":"text"}]}}} \ No newline at end of file +{"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"text":"ManagementObject","kind":"identifier"},{"kind":"text","text":" = ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]"}],"languages":["swift"],"platforms":["iOS"]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/managementobject"]}],"sections":[],"schemaVersion":{"minor":3,"major":0,"patch":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"abstract":[{"text":"A dictionary containing a user profile.","type":"text"}],"metadata":{"externalID":"s:5Auth016ManagementObjecta","modules":[{"name":"Auth0"}],"role":"symbol","roleHeading":"Type Alias","symbolKind":"typealias","navigatorTitle":[{"text":"ManagementObject","kind":"identifier"}],"title":"ManagementObject","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ManagementObject","kind":"identifier"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementObject":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"ManagementObject"}],"title":"ManagementObject","role":"symbol","fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementObject"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","abstract":[{"text":"A dictionary containing a user profile.","type":"text"}],"url":"\/documentation\/auth0\/managementobject"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/managementresult.json b/docs/data/documentation/auth0/managementresult.json index 3a00e4155..9259156f5 100644 --- a/docs/data/documentation/auth0/managementresult.json +++ b/docs/data/documentation/auth0/managementresult.json @@ -1 +1 @@ -{"sections":[],"kind":"symbol","abstract":[{"code":"Result","type":"codeVoice"},{"text":" wrapper for Management API operations.","type":"text"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/managementresult"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ManagementResult","kind":"identifier"},{"text":"<","kind":"text"},{"text":"T","kind":"genericParameter"},{"text":"> = ","kind":"text"},{"text":"Result","preciseIdentifier":"s:s6ResultO","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"T","preciseIdentifier":"s:5Auth016ManagementResulta1Txmfp","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"ManagementError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"languages":["swift"]}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementResult"},"metadata":{"externalID":"s:5Auth016ManagementResulta","modules":[{"name":"Auth0"}],"navigatorTitle":[{"kind":"identifier","text":"ManagementResult"}],"role":"symbol","symbolKind":"typealias","title":"ManagementResult","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ManagementResult","kind":"identifier"}],"roleHeading":"Type Alias"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementResult":{"abstract":[{"type":"codeVoice","code":"Result"},{"type":"text","text":" wrapper for Management API operations."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementResult","role":"symbol","url":"\/documentation\/auth0\/managementresult","title":"ManagementResult","type":"topic","kind":"symbol","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ManagementResult","kind":"identifier"}],"navigatorTitle":[{"text":"ManagementResult","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"type":"topic","url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","kind":"symbol","title":"ManagementError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"variants":[{"paths":["\/documentation\/auth0\/managementresult"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"abstract":[{"code":"Result","type":"codeVoice"},{"text":" wrapper for Management API operations.","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementResult"},{"kind":"text","text":"<"},{"kind":"genericParameter","text":"T"},{"kind":"text","text":"> = "},{"kind":"typeIdentifier","text":"Result","preciseIdentifier":"s:s6ResultO"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"T","preciseIdentifier":"s:5Auth016ManagementResulta1Txmfp"},{"kind":"text","text":", "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","kind":"typeIdentifier","text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"kind":"text","text":">"}],"platforms":["iOS"]}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"kind":"symbol","sections":[],"metadata":{"externalID":"s:5Auth016ManagementResulta","symbolKind":"typealias","title":"ManagementResult","roleHeading":"Type Alias","role":"symbol","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementResult"}],"navigatorTitle":[{"text":"ManagementResult","kind":"identifier"}],"modules":[{"name":"Auth0"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementResult","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"title":"ManagementError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementResult":{"url":"\/documentation\/auth0\/managementresult","title":"ManagementResult","abstract":[{"type":"codeVoice","code":"Result"},{"text":" wrapper for Management API operations.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"ManagementResult"}],"fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"kind":"identifier","text":"ManagementResult"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementResult","role":"symbol","kind":"symbol","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/myaccount(token:domain:session:).json b/docs/data/documentation/auth0/myaccount(token:domain:session:).json index 71b626720..53f76ed6c 100644 --- a/docs/data/documentation/auth0/myaccount(token:domain:session:).json +++ b/docs/data/documentation/auth0/myaccount(token:domain:session:).json @@ -1 +1 @@ -{"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"myAccount"},{"kind":"text","text":"("},{"kind":"externalParam","text":"token"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"domain"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"session"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSURLSession","text":"URLSession"},{"kind":"text","text":" = .shared) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth09MyAccountP","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccount","text":"MyAccount"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"},{"parameters":[{"content":[{"inlineContent":[{"text":"Access token for the My Account API with the correct scopes to perform the desired action.","type":"text"}],"type":"paragraph"}],"name":"token"},{"content":[{"type":"paragraph","inlineContent":[{"text":"Domain of your Auth0 account, for example ","type":"text"},{"code":"samples.us.auth0.com","type":"codeVoice"},{"text":".","type":"text"}]}],"name":"domain"},{"content":[{"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":"."}],"type":"paragraph"}],"name":"session"}],"kind":"parameters"},{"kind":"content","content":[{"text":"Return Value","anchor":"return-value","type":"heading","level":2},{"type":"paragraph","inlineContent":[{"type":"text","text":"My Account API client."}]}]},{"kind":"content","content":[{"level":2,"anchor":"Usage","type":"heading","text":"Usage"},{"code":["Auth0.myAccount(token: apiCredentials.accessToken, domain: \"samples.us.auth0.com\")"],"syntax":"swift","type":"codeListing"},{"inlineContent":[{"type":"text","text":"You can use the refresh token to get an access token for the My Account API. Refer to"},{"type":"text","text":" "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/apiCredentials(forAudience:scope:minTTL:parameters:headers:callback:)","type":"reference","isActive":true},{"type":"text","text":","},{"type":"text","text":" "},{"type":"text","text":"or alternatively "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/renew(withRefreshToken:audience:scope:)","type":"reference","isActive":true},{"type":"text","text":" if you are not using the"},{"type":"text","text":" "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","type":"reference","isActive":true},{"type":"text","text":"."}],"type":"paragraph"},{"style":"note","name":"Note","type":"aside","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"See "},{"identifier":"https:\/\/github.com\/auth0\/Auth0.swift\/blob\/master\/EXAMPLES.md#get-a-refresh-token","isActive":true,"type":"reference"},{"type":"text","text":" "},{"type":"text","text":"to learn how to obtain a refresh token."}]}]}]}],"abstract":[{"type":"text","text":"Auth0 My Account API client for managing the current user’s account."}],"variants":[{"paths":["\/documentation\/auth0\/myaccount(token:domain:session:)"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"minor":3,"major":0,"patch":0},"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/myAccount(token:domain:session:)"},"sections":[],"metadata":{"symbolKind":"func","role":"symbol","roleHeading":"Function","title":"myAccount(token:domain:session:)","modules":[{"name":"Auth0"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"myAccount","kind":"identifier"},{"text":"(","kind":"text"},{"text":"token","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"domain","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"session","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"URLSession","kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSURLSession"},{"text":") -> ","kind":"text"},{"text":"MyAccount","kind":"typeIdentifier","preciseIdentifier":"s:5Auth09MyAccountP"}],"externalID":"s:5Auth09myAccount5token6domain7sessionAA02MyC0_pSS_SSSo12NSURLSessionCtF"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/myAccount(token:domain:session:)":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/myAccount(token:domain:session:)","role":"symbol","abstract":[{"text":"Auth0 My Account API client for managing the current user’s account.","type":"text"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"myAccount","kind":"identifier"},{"text":"(","kind":"text"},{"text":"token","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"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"},{"text":"URLSession","kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSURLSession"},{"text":") -> ","kind":"text"},{"text":"MyAccount","kind":"typeIdentifier","preciseIdentifier":"s:5Auth09MyAccountP"}],"kind":"symbol","title":"myAccount(token:domain:session:)","url":"\/documentation\/auth0\/myaccount(token:domain:session:)"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccount":{"fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccount","kind":"identifier"}],"type":"topic","kind":"symbol","url":"\/documentation\/auth0\/myaccount","navigatorTitle":[{"text":"MyAccount","kind":"identifier"}],"abstract":[{"type":"text","text":"My Account API client for managing the current user’s account."}],"title":"MyAccount","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccount"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManager","kind":"identifier"}],"navigatorTitle":[{"text":"CredentialsManager","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","abstract":[{"type":"text","text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain."}],"kind":"symbol","title":"CredentialsManager","url":"\/documentation\/auth0\/credentialsmanager","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/renew(withRefreshToken:audience:scope:)":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/renew(withRefreshToken:audience:scope:)","role":"symbol","abstract":[{"type":"text","text":"Renews the user’s credentials using a refresh token."}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"renew","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withRefreshToken","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?) -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"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"}],"kind":"symbol","title":"renew(withRefreshToken:audience:scope:)","url":"\/documentation\/auth0\/authentication\/renew(withrefreshtoken:audience:scope:)","defaultImplementations":1,"required":true},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/apiCredentials(forAudience:scope:minTTL:parameters:headers:callback:)":{"url":"\/documentation\/auth0\/credentialsmanager\/apicredentials(foraudience:scope:minttl:parameters:headers:callback:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"apiCredentials","kind":"identifier"},{"text":"(","kind":"text"},{"text":"forAudience","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"text":"minTTL","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"text":", ","kind":"text"},{"text":"parameters","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","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"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"], ","kind":"text"},{"text":"callback","kind":"externalParam"},{"text":": (","kind":"text"},{"text":"CredentialsManagerResult","kind":"typeIdentifier","preciseIdentifier":"s:5Auth024CredentialsManagerResulta"},{"text":"<","kind":"text"},{"text":"APICredentials","kind":"typeIdentifier","preciseIdentifier":"s:5Auth014APICredentialsV"},{"text":">) -> ","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":")","kind":"text"}],"type":"topic","title":"apiCredentials(forAudience:scope:minTTL:parameters:headers:callback:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/apiCredentials(forAudience:scope:minTTL:parameters:headers:callback:)","kind":"symbol","role":"symbol","abstract":[{"text":"Retrieves API credentials from the Keychain and automatically renews them using the refresh token if the access","type":"text"},{"text":" ","type":"text"},{"text":"token is expired. Otherwise, the retrieved API credentials will be returned via the success case as they are","type":"text"},{"text":" ","type":"text"},{"text":"still valid.","type":"text"}]},"https://github.com/auth0/Auth0.swift/blob/master/EXAMPLES.md#get-a-refresh-token":{"titleInlineContent":[{"type":"text","text":"Get a refresh token"}],"identifier":"https:\/\/github.com\/auth0\/Auth0.swift\/blob\/master\/EXAMPLES.md#get-a-refresh-token","type":"link","title":"Get a refresh token","url":"https:\/\/github.com\/auth0\/Auth0.swift\/blob\/master\/EXAMPLES.md#get-a-refresh-token"}}} \ No newline at end of file +{"abstract":[{"text":"Auth0 My Account API client for managing the current user’s account.","type":"text"}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"myAccount","kind":"identifier"},{"text":"(","kind":"text"},{"text":"token","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"domain","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"session","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"URLSession","preciseIdentifier":"c:objc(cs)NSURLSession","kind":"typeIdentifier"},{"text":" = .shared) -> ","kind":"text"},{"text":"MyAccount","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccount","kind":"typeIdentifier","preciseIdentifier":"s:5Auth09MyAccountP"}],"platforms":["iOS"]}],"kind":"declarations"},{"parameters":[{"content":[{"inlineContent":[{"type":"text","text":"Access token for the My Account API with the correct scopes to perform the desired action."}],"type":"paragraph"}],"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":[{"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":"."}],"type":"paragraph"}],"name":"session"}],"kind":"parameters"},{"content":[{"level":2,"text":"Return Value","type":"heading","anchor":"return-value"},{"inlineContent":[{"text":"My Account API client.","type":"text"}],"type":"paragraph"}],"kind":"content"},{"content":[{"level":2,"text":"Usage","type":"heading","anchor":"Usage"},{"syntax":"swift","type":"codeListing","code":["Auth0.myAccount(token: apiCredentials.accessToken, domain: \"samples.us.auth0.com\")"]},{"inlineContent":[{"text":"You can use the refresh token to get an access token for the My Account API. Refer to","type":"text"},{"text":" ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/apiCredentials(forAudience:scope:minTTL:parameters:headers:callback:)","isActive":true,"type":"reference"},{"text":",","type":"text"},{"text":" ","type":"text"},{"text":"or alternatively ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/renew(withRefreshToken:audience:scope:)","isActive":true,"type":"reference"},{"text":" if you are not using the","type":"text"},{"text":" ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","isActive":true,"type":"reference"},{"text":".","type":"text"}],"type":"paragraph"},{"style":"note","content":[{"inlineContent":[{"type":"text","text":"See "},{"type":"reference","identifier":"https:\/\/github.com\/auth0\/Auth0.swift\/blob\/master\/EXAMPLES.md#get-a-refresh-token","isActive":true},{"type":"text","text":" "},{"type":"text","text":"to learn how to obtain a refresh token."}],"type":"paragraph"}],"type":"aside","name":"Note"}],"kind":"content"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/myaccount(token:domain:session:)"]}],"schemaVersion":{"minor":3,"major":0,"patch":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"metadata":{"modules":[{"name":"Auth0"}],"symbolKind":"func","title":"myAccount(token:domain:session:)","roleHeading":"Function","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"myAccount","kind":"identifier"},{"text":"(","kind":"text"},{"text":"token","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"domain","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"session","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"URLSession","preciseIdentifier":"c:objc(cs)NSURLSession","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"MyAccount","preciseIdentifier":"s:5Auth09MyAccountP","kind":"typeIdentifier"}],"externalID":"s:5Auth09myAccount5token6domain7sessionAA02MyC0_pSS_SSSo12NSURLSessionCtF"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/myAccount(token:domain:session:)"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/apiCredentials(forAudience:scope:minTTL:parameters:headers:callback:)":{"kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"apiCredentials"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forAudience"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"minTTL"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"},{"kind":"text","text":", "},{"kind":"externalParam","text":"parameters"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" : "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"callback"},{"kind":"text","text":": ("},{"preciseIdentifier":"s:5Auth024CredentialsManagerResulta","kind":"typeIdentifier","text":"CredentialsManagerResult"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:5Auth014APICredentialsV","kind":"typeIdentifier","text":"APICredentials"},{"kind":"text","text":">) -> "},{"preciseIdentifier":"s:s4Voida","kind":"typeIdentifier","text":"Void"},{"kind":"text","text":")"}],"title":"apiCredentials(forAudience:scope:minTTL:parameters:headers:callback:)","type":"topic","role":"symbol","abstract":[{"text":"Retrieves API credentials from the Keychain and automatically renews them using the refresh token if the access","type":"text"},{"text":" ","type":"text"},{"text":"token is expired. Otherwise, the retrieved API credentials will be returned via the success case as they are","type":"text"},{"text":" ","type":"text"},{"text":"still valid.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/apiCredentials(forAudience:scope:minTTL:parameters:headers:callback:)","url":"\/documentation\/auth0\/credentialsmanager\/apicredentials(foraudience:scope:minttl:parameters:headers:callback:)"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/renew(withRefreshToken:audience:scope:)":{"kind":"symbol","required":true,"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"renew"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withRefreshToken"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","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","kind":"typeIdentifier","text":"AuthenticationError"},{"kind":"text","text":">"}],"title":"renew(withRefreshToken:audience:scope:)","type":"topic","defaultImplementations":1,"role":"symbol","abstract":[{"text":"Renews the user’s credentials using a refresh token.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/renew(withRefreshToken:audience:scope:)","url":"\/documentation\/auth0\/authentication\/renew(withrefreshtoken:audience:scope:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccount":{"url":"\/documentation\/auth0\/myaccount","abstract":[{"type":"text","text":"My Account API client for managing the current user’s account."}],"title":"MyAccount","navigatorTitle":[{"text":"MyAccount","kind":"identifier"}],"fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccount"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccount","role":"symbol","kind":"symbol","type":"topic"},"https://github.com/auth0/Auth0.swift/blob/master/EXAMPLES.md#get-a-refresh-token":{"title":"Get a refresh token","url":"https:\/\/github.com\/auth0\/Auth0.swift\/blob\/master\/EXAMPLES.md#get-a-refresh-token","type":"link","identifier":"https:\/\/github.com\/auth0\/Auth0.swift\/blob\/master\/EXAMPLES.md#get-a-refresh-token","titleInlineContent":[{"text":"Get a refresh token","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/myAccount(token:domain:session:)":{"title":"myAccount(token:domain:session:)","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/myAccount(token:domain:session:)","role":"symbol","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"myAccount","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"token"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"domain"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"text":"session","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSURLSession","text":"URLSession"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth09MyAccountP","text":"MyAccount"}],"abstract":[{"text":"Auth0 My Account API client for managing the current user’s account.","type":"text"}],"url":"\/documentation\/auth0\/myaccount(token:domain:session:)"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"title":"CredentialsManager","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManager"}],"abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanager","navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/myaccount(token:session:bundle:).json b/docs/data/documentation/auth0/myaccount(token:session:bundle:).json index 7c921cf81..c13a0b5c3 100644 --- a/docs/data/documentation/auth0/myaccount(token:session:bundle:).json +++ b/docs/data/documentation/auth0/myaccount(token:session:bundle:).json @@ -1 +1 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/myAccount(token:session:bundle:)","interfaceLanguage":"swift"},"kind":"symbol","sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/myaccount(token:session:bundle:)"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"myAccount"},{"kind":"text","text":"("},{"text":"token","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"session","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"URLSession","preciseIdentifier":"c:objc(cs)NSURLSession","kind":"typeIdentifier"},{"text":" = .shared, ","kind":"text"},{"text":"bundle","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Bundle","preciseIdentifier":"c:objc(cs)NSBundle","kind":"typeIdentifier"},{"text":" = .main) -> ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccount","text":"MyAccount","preciseIdentifier":"s:5Auth09MyAccountP","kind":"typeIdentifier"}],"platforms":["iOS"],"languages":["swift"]}]},{"parameters":[{"name":"token","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Access token for the My Account API with the correct scopes to perform the desired action."}]}]},{"name":"session","content":[{"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":"."}],"type":"paragraph"}]},{"name":"bundle","content":[{"inlineContent":[{"type":"text","text":"Bundle used to locate the "},{"code":"Auth0.plist","type":"codeVoice"},{"type":"text","text":" file. Defaults to "},{"code":"Bundle.main","type":"codeVoice"}],"type":"paragraph"}]}],"kind":"parameters"},{"content":[{"type":"heading","level":2,"text":"Return Value","anchor":"return-value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"My Account API client."}]}],"kind":"content"},{"content":[{"text":"Usage","type":"heading","level":2,"anchor":"Usage"},{"type":"codeListing","code":["Auth0.myAccount(token: apiCredentials.accessToken)"],"syntax":"swift"},{"inlineContent":[{"type":"text","text":"You can use the refresh token to get an access token for the My Account API. Refer to"},{"type":"text","text":" "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/apiCredentials(forAudience:scope:minTTL:parameters:headers:callback:)","isActive":true},{"type":"text","text":","},{"type":"text","text":" "},{"type":"text","text":"or alternatively "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/renew(withRefreshToken:audience:scope:)","isActive":true},{"type":"text","text":" if you are not using the"},{"type":"text","text":" "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","isActive":true},{"type":"text","text":"."}],"type":"paragraph"},{"name":"Note","style":"note","type":"aside","content":[{"type":"paragraph","inlineContent":[{"text":"See ","type":"text"},{"isActive":true,"identifier":"https:\/\/github.com\/auth0\/Auth0.swift\/blob\/master\/EXAMPLES.md#get-a-refresh-token","type":"reference"},{"text":" ","type":"text"},{"text":"to learn how to obtain a refresh token.","type":"text"}]}]},{"inlineContent":[{"text":"The Auth0 Domain is loaded from the ","type":"text"},{"type":"codeVoice","code":"Auth0.plist"},{"text":" file in your main bundle. It should have the following content:","type":"text"}],"type":"paragraph"},{"type":"codeListing","code":["","","",""," ClientId<\/key>"," YOUR_AUTH0_CLIENT_ID<\/string>"," Domain<\/key>"," YOUR_AUTH0_DOMAIN<\/string>","<\/dict>","<\/plist>"],"syntax":"xml"}],"kind":"content"}],"schemaVersion":{"minor":3,"patch":0,"major":0},"metadata":{"roleHeading":"Function","symbolKind":"func","modules":[{"name":"Auth0"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"myAccount","kind":"identifier"},{"text":"(","kind":"text"},{"text":"token","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"session","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"URLSession","kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSURLSession"},{"text":", ","kind":"text"},{"text":"bundle","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Bundle","kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSBundle"},{"text":") -> ","kind":"text"},{"text":"MyAccount","kind":"typeIdentifier","preciseIdentifier":"s:5Auth09MyAccountP"}],"externalID":"s:5Auth09myAccount5token7session6bundleAA02MyC0_pSS_So12NSURLSessionCSo8NSBundleCtF","role":"symbol","title":"myAccount(token:session:bundle:)"},"abstract":[{"type":"text","text":"Auth0 My Account API client for managing the current user’s account."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/MyAccount":{"fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccount","kind":"identifier"}],"type":"topic","kind":"symbol","url":"\/documentation\/auth0\/myaccount","navigatorTitle":[{"text":"MyAccount","kind":"identifier"}],"abstract":[{"type":"text","text":"My Account API client for managing the current user’s account."}],"title":"MyAccount","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccount"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsManager","kind":"identifier"}],"navigatorTitle":[{"text":"CredentialsManager","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","abstract":[{"type":"text","text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain."}],"kind":"symbol","title":"CredentialsManager","url":"\/documentation\/auth0\/credentialsmanager","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/renew(withRefreshToken:audience:scope:)":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/renew(withRefreshToken:audience:scope:)","role":"symbol","abstract":[{"type":"text","text":"Renews the user’s credentials using a refresh token."}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"renew","kind":"identifier"},{"text":"(","kind":"text"},{"text":"withRefreshToken","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"audience","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?) -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"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"}],"kind":"symbol","title":"renew(withRefreshToken:audience:scope:)","url":"\/documentation\/auth0\/authentication\/renew(withrefreshtoken:audience:scope:)","defaultImplementations":1,"required":true},"doc://com.auth0.Auth0/documentation/Auth0/myAccount(token:session:bundle:)":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"myAccount","kind":"identifier"},{"text":"(","kind":"text"},{"text":"token","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"session","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"URLSession","preciseIdentifier":"c:objc(cs)NSURLSession","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"bundle","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Bundle","preciseIdentifier":"c:objc(cs)NSBundle","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"MyAccount","preciseIdentifier":"s:5Auth09MyAccountP","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/myAccount(token:session:bundle:)","title":"myAccount(token:session:bundle:)","role":"symbol","type":"topic","url":"\/documentation\/auth0\/myaccount(token:session:bundle:)","abstract":[{"type":"text","text":"Auth0 My Account API client for managing the current user’s account."}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/apiCredentials(forAudience:scope:minTTL:parameters:headers:callback:)":{"url":"\/documentation\/auth0\/credentialsmanager\/apicredentials(foraudience:scope:minttl:parameters:headers:callback:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"apiCredentials","kind":"identifier"},{"text":"(","kind":"text"},{"text":"forAudience","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"scope","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"text":"minTTL","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"text":", ","kind":"text"},{"text":"parameters","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","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"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"], ","kind":"text"},{"text":"callback","kind":"externalParam"},{"text":": (","kind":"text"},{"text":"CredentialsManagerResult","kind":"typeIdentifier","preciseIdentifier":"s:5Auth024CredentialsManagerResulta"},{"text":"<","kind":"text"},{"text":"APICredentials","kind":"typeIdentifier","preciseIdentifier":"s:5Auth014APICredentialsV"},{"text":">) -> ","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":")","kind":"text"}],"type":"topic","title":"apiCredentials(forAudience:scope:minTTL:parameters:headers:callback:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/apiCredentials(forAudience:scope:minTTL:parameters:headers:callback:)","kind":"symbol","role":"symbol","abstract":[{"text":"Retrieves API credentials from the Keychain and automatically renews them using the refresh token if the access","type":"text"},{"text":" ","type":"text"},{"text":"token is expired. Otherwise, the retrieved API credentials will be returned via the success case as they are","type":"text"},{"text":" ","type":"text"},{"text":"still valid.","type":"text"}]},"https://github.com/auth0/Auth0.swift/blob/master/EXAMPLES.md#get-a-refresh-token":{"identifier":"https:\/\/github.com\/auth0\/Auth0.swift\/blob\/master\/EXAMPLES.md#get-a-refresh-token","type":"link","title":"Get a refresh token","titleInlineContent":[{"text":"Get a refresh token","type":"text"}],"url":"https:\/\/github.com\/auth0\/Auth0.swift\/blob\/master\/EXAMPLES.md#get-a-refresh-token"}}} \ No newline at end of file +{"metadata":{"symbolKind":"func","roleHeading":"Function","externalID":"s:5Auth09myAccount5token7session6bundleAA02MyC0_pSS_So12NSURLSessionCSo8NSBundleCtF","title":"myAccount(token:session:bundle:)","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"myAccount"},{"kind":"text","text":"("},{"kind":"externalParam","text":"token"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"session"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSURLSession","text":"URLSession"},{"kind":"text","text":", "},{"kind":"externalParam","text":"bundle"},{"kind":"text","text":": "},{"preciseIdentifier":"c:objc(cs)NSBundle","kind":"typeIdentifier","text":"Bundle"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth09MyAccountP","kind":"typeIdentifier","text":"MyAccount"}],"role":"symbol"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/myaccount(token:session:bundle:)"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/myAccount(token:session:bundle:)","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"type":"text","text":"Auth0 My Account API client for managing the current user’s account."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"myAccount"},{"text":"(","kind":"text"},{"text":"token","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"session"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:objc(cs)NSURLSession","text":"URLSession","kind":"typeIdentifier"},{"kind":"text","text":" = .shared, "},{"text":"bundle","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"c:objc(cs)NSBundle","text":"Bundle","kind":"typeIdentifier"},{"text":" = .main) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth09MyAccountP","text":"MyAccount","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccount"}],"platforms":["iOS"],"languages":["swift"]}]},{"parameters":[{"name":"token","content":[{"inlineContent":[{"text":"Access token for the My Account API with the correct scopes to perform the desired action.","type":"text"}],"type":"paragraph"}]},{"name":"session","content":[{"inlineContent":[{"text":"","type":"text"},{"code":"URLSession","type":"codeVoice"},{"text":" instance used for networking. Defaults to ","type":"text"},{"code":"URLSession.shared","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"}]},{"name":"bundle","content":[{"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":"paragraph"}]}],"kind":"parameters"},{"kind":"content","content":[{"type":"heading","text":"Return Value","anchor":"return-value","level":2},{"type":"paragraph","inlineContent":[{"text":"My Account API client.","type":"text"}]}]},{"kind":"content","content":[{"type":"heading","text":"Usage","anchor":"Usage","level":2},{"type":"codeListing","code":["Auth0.myAccount(token: apiCredentials.accessToken)"],"syntax":"swift"},{"type":"paragraph","inlineContent":[{"text":"You can use the refresh token to get an access token for the My Account API. Refer to","type":"text"},{"text":" ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/apiCredentials(forAudience:scope:minTTL:parameters:headers:callback:)","type":"reference"},{"text":",","type":"text"},{"text":" ","type":"text"},{"text":"or alternatively ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/renew(withRefreshToken:audience:scope:)","type":"reference"},{"text":" if you are not using the","type":"text"},{"text":" ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","type":"reference"},{"text":".","type":"text"}]},{"type":"aside","name":"Note","style":"note","content":[{"inlineContent":[{"text":"See ","type":"text"},{"isActive":true,"identifier":"https:\/\/github.com\/auth0\/Auth0.swift\/blob\/master\/EXAMPLES.md#get-a-refresh-token","type":"reference"},{"text":" ","type":"text"},{"text":"to learn how to obtain a refresh token.","type":"text"}],"type":"paragraph"}]},{"type":"paragraph","inlineContent":[{"text":"The Auth0 Domain is loaded from the ","type":"text"},{"code":"Auth0.plist","type":"codeVoice"},{"text":" file in your main bundle. It should have the following content:","type":"text"}]},{"type":"codeListing","code":["","","",""," ClientId<\/key>"," YOUR_AUTH0_CLIENT_ID<\/string>"," Domain<\/key>"," YOUR_AUTH0_DOMAIN<\/string>","<\/dict>","<\/plist>"],"syntax":"xml"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/apiCredentials(forAudience:scope:minTTL:parameters:headers:callback:)":{"kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"apiCredentials"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forAudience"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"minTTL"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"},{"kind":"text","text":", "},{"kind":"externalParam","text":"parameters"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" : "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"callback"},{"kind":"text","text":": ("},{"preciseIdentifier":"s:5Auth024CredentialsManagerResulta","kind":"typeIdentifier","text":"CredentialsManagerResult"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:5Auth014APICredentialsV","kind":"typeIdentifier","text":"APICredentials"},{"kind":"text","text":">) -> "},{"preciseIdentifier":"s:s4Voida","kind":"typeIdentifier","text":"Void"},{"kind":"text","text":")"}],"title":"apiCredentials(forAudience:scope:minTTL:parameters:headers:callback:)","type":"topic","role":"symbol","abstract":[{"text":"Retrieves API credentials from the Keychain and automatically renews them using the refresh token if the access","type":"text"},{"text":" ","type":"text"},{"text":"token is expired. Otherwise, the retrieved API credentials will be returned via the success case as they are","type":"text"},{"text":" ","type":"text"},{"text":"still valid.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/apiCredentials(forAudience:scope:minTTL:parameters:headers:callback:)","url":"\/documentation\/auth0\/credentialsmanager\/apicredentials(foraudience:scope:minttl:parameters:headers:callback:)"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccount":{"url":"\/documentation\/auth0\/myaccount","abstract":[{"type":"text","text":"My Account API client for managing the current user’s account."}],"title":"MyAccount","navigatorTitle":[{"text":"MyAccount","kind":"identifier"}],"fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccount"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccount","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication/renew(withRefreshToken:audience:scope:)":{"kind":"symbol","required":true,"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"renew"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withRefreshToken"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"audience"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"scope"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","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","kind":"typeIdentifier","text":"AuthenticationError"},{"kind":"text","text":">"}],"title":"renew(withRefreshToken:audience:scope:)","type":"topic","defaultImplementations":1,"role":"symbol","abstract":[{"text":"Renews the user’s credentials using a refresh token.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication\/renew(withRefreshToken:audience:scope:)","url":"\/documentation\/auth0\/authentication\/renew(withrefreshtoken:audience:scope:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/myAccount(token:session:bundle:)":{"title":"myAccount(token:session:bundle:)","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/myAccount(token:session:bundle:)","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"myAccount"},{"kind":"text","text":"("},{"kind":"externalParam","text":"token"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"session"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSURLSession","text":"URLSession"},{"kind":"text","text":", "},{"kind":"externalParam","text":"bundle"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSBundle","text":"Bundle"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth09MyAccountP","text":"MyAccount"}],"abstract":[{"text":"Auth0 My Account API client for managing the current user’s account.","type":"text"}],"url":"\/documentation\/auth0\/myaccount(token:session:bundle:)"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager":{"title":"CredentialsManager","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CredentialsManager"}],"abstract":[{"text":"Credentials management utility for securely storing and retrieving the user’s credentials from the Keychain.","type":"text"}],"url":"\/documentation\/auth0\/credentialsmanager","navigatorTitle":[{"kind":"identifier","text":"CredentialsManager"}]},"https://github.com/auth0/Auth0.swift/blob/master/EXAMPLES.md#get-a-refresh-token":{"title":"Get a refresh token","type":"link","identifier":"https:\/\/github.com\/auth0\/Auth0.swift\/blob\/master\/EXAMPLES.md#get-a-refresh-token","titleInlineContent":[{"type":"text","text":"Get a refresh token"}],"url":"https:\/\/github.com\/auth0\/Auth0.swift\/blob\/master\/EXAMPLES.md#get-a-refresh-token"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/myaccount.json b/docs/data/documentation/auth0/myaccount.json index 72ec6e878..105cb0f3b 100644 --- a/docs/data/documentation/auth0/myaccount.json +++ b/docs/data/documentation/auth0/myaccount.json @@ -1 +1 @@ -{"seeAlsoSections":[{"title":"Related Documentation","anchor":"Related-Documentation","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError"]}],"variants":[{"paths":["\/documentation\/auth0\/myaccount"],"traits":[{"interfaceLanguage":"swift"}]}],"topicSections":[{"title":"Instance Properties","anchor":"Instance-Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccount\/authenticationMethods"],"generated":true},{"title":"Type Properties","anchor":"Type-Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccount\/apiVersion"],"generated":true}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccount"},"sections":[],"kind":"symbol","primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccount","kind":"identifier"},{"text":" : ","kind":"text"},{"preciseIdentifier":"s:5Auth015MyAccountClientP","text":"MyAccountClient","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountClient"}]}],"kind":"declarations"}],"metadata":{"symbolKind":"protocol","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"MyAccount"}],"externalID":"s:5Auth09MyAccountP","modules":[{"name":"Auth0"}],"roleHeading":"Protocol","title":"MyAccount","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccount"}]},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"schemaVersion":{"patch":0,"minor":3,"major":0},"abstract":[{"type":"text","text":"My Account API client for managing the current user’s account."}],"relationshipsSections":[{"title":"Inherits From","type":"inheritsFrom","kind":"relationships","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountClient","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","type":"topic","kind":"symbol","abstract":[{"text":"Represents an error during a request to the Auth0 My Account API.","type":"text"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountError","kind":"identifier"}],"navigatorTitle":[{"text":"MyAccountError","kind":"identifier"}],"url":"\/documentation\/auth0\/myaccounterror","role":"symbol"},"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","url":"\/documentation\/auth0\/trackable","role":"symbol","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Trackable"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable","title":"Trackable","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Trackable"}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountClient":{"type":"topic","title":"MyAccountClient","kind":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountClient","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountClient","navigatorTitle":[{"text":"MyAccountClient","kind":"identifier"}],"role":"symbol","abstract":[{"type":"text","text":"A client for the My Account API."},{"type":"text","text":" "},{"type":"text","text":"Adopting types could be either the root client or a leaf sub-client."}],"url":"\/documentation\/auth0\/myaccountclient"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccount/apiVersion":{"title":"apiVersion","required":true,"role":"symbol","type":"topic","abstract":[{"text":"Currently supported version of the My Account API.","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/myaccount\/apiversion","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccount\/apiVersion","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"apiVersion"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccount":{"fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccount","kind":"identifier"}],"type":"topic","kind":"symbol","url":"\/documentation\/auth0\/myaccount","navigatorTitle":[{"text":"MyAccount","kind":"identifier"}],"abstract":[{"type":"text","text":"My Account API client for managing the current user’s account."}],"title":"MyAccount","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccount"},"doc://com.auth0.Auth0/documentation/Auth0/Loggable":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","abstract":[{"type":"text","text":"A type that can log statements for debugging purposes."}],"fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Loggable","kind":"identifier"}],"kind":"symbol","title":"Loggable","type":"topic","role":"symbol","navigatorTitle":[{"text":"Loggable","kind":"identifier"}],"url":"\/documentation\/auth0\/loggable"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccount/authenticationMethods":{"url":"\/documentation\/auth0\/myaccount\/authenticationmethods","type":"topic","abstract":[{"text":"My Account API sub-client for managing the current user’s authentication methods.","type":"text"}],"role":"symbol","kind":"symbol","title":"authenticationMethods","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticationMethods"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth030MyAccountAuthenticationMethodsP","text":"MyAccountAuthenticationMethods"}],"required":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccount\/authenticationMethods"}}} \ No newline at end of file +{"metadata":{"symbolKind":"protocol","title":"MyAccount","externalID":"s:5Auth09MyAccountP","roleHeading":"Protocol","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccount"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"MyAccount"}]},"sections":[],"variants":[{"paths":["\/documentation\/auth0\/myaccount"],"traits":[{"interfaceLanguage":"swift"}]}],"relationshipsSections":[{"title":"Inherits From","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountClient","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable"],"type":"inheritsFrom","kind":"relationships"}],"topicSections":[{"title":"Instance Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccount\/authenticationMethods"],"generated":true,"anchor":"Instance-Properties"},{"title":"Type Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccount\/apiVersion"],"generated":true,"anchor":"Type-Properties"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccount","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"type":"text","text":"My Account API client for managing the current user’s account."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"seeAlsoSections":[{"title":"Related Documentation","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError"],"anchor":"Related-Documentation"}],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccount"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015MyAccountClientP","text":"MyAccountClient","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountClient"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/MyAccount":{"url":"\/documentation\/auth0\/myaccount","abstract":[{"type":"text","text":"My Account API client for managing the current user’s account."}],"title":"MyAccount","navigatorTitle":[{"text":"MyAccount","kind":"identifier"}],"fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccount"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccount","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Loggable":{"role":"symbol","title":"Loggable","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Loggable"}],"navigatorTitle":[{"text":"Loggable","kind":"identifier"}],"abstract":[{"text":"A type that can log statements for debugging purposes.","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/loggable","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccount/authenticationMethods":{"url":"\/documentation\/auth0\/myaccount\/authenticationmethods","required":true,"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticationMethods"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth030MyAccountAuthenticationMethodsP","text":"MyAccountAuthenticationMethods"}],"title":"authenticationMethods","type":"topic","role":"symbol","abstract":[{"type":"text","text":"My Account API sub-client for managing the current user’s authentication methods."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccount\/authenticationMethods","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccountError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 My Account API."}],"url":"\/documentation\/auth0\/myaccounterror","navigatorTitle":[{"kind":"identifier","text":"MyAccountError"}]},"doc://com.auth0.Auth0/documentation/Auth0/Trackable":{"title":"Trackable","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Trackable"}],"abstract":[{"text":"A type that can send the ","type":"text"},{"code":"Auth0-Client","type":"codeVoice"},{"text":" header on every request to Auth0.","type":"text"}],"url":"\/documentation\/auth0\/trackable","navigatorTitle":[{"kind":"identifier","text":"Trackable"}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccount/apiVersion":{"type":"topic","title":"apiVersion","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccount\/apiVersion","url":"\/documentation\/auth0\/myaccount\/apiversion","abstract":[{"type":"text","text":"Currently supported version of the My Account API."}],"kind":"symbol","required":true,"role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"apiVersion","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountClient":{"title":"MyAccountClient","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountClient","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccountClient"}],"abstract":[{"text":"A client for the My Account API.","type":"text"},{"text":" ","type":"text"},{"text":"Adopting types could be either the root client or a leaf sub-client.","type":"text"}],"url":"\/documentation\/auth0\/myaccountclient","navigatorTitle":[{"kind":"identifier","text":"MyAccountClient"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/myaccount/apiversion.json b/docs/data/documentation/auth0/myaccount/apiversion.json index ce6b6a45b..6cdaaff40 100644 --- a/docs/data/documentation/auth0/myaccount/apiversion.json +++ b/docs/data/documentation/auth0/myaccount/apiversion.json @@ -1 +1 @@ -{"abstract":[{"text":"Currently supported version of the My Account API.","type":"text"}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"apiVersion","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"platforms":["iOS"]}],"kind":"declarations"}],"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccount\/apiVersion","interfaceLanguage":"swift"},"kind":"symbol","schemaVersion":{"patch":0,"minor":3,"major":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/myaccount\/apiversion"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccount"]]},"metadata":{"fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"apiVersion","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"title":"apiVersion","required":true,"symbolKind":"property","roleHeading":"Type Property","role":"symbol","externalID":"s:5Auth09MyAccountP10apiVersionSSvpZ","modules":[{"name":"Auth0"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/MyAccount":{"fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccount","kind":"identifier"}],"type":"topic","kind":"symbol","url":"\/documentation\/auth0\/myaccount","navigatorTitle":[{"text":"MyAccount","kind":"identifier"}],"abstract":[{"type":"text","text":"My Account API client for managing the current user’s account."}],"title":"MyAccount","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccount"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccount/apiVersion":{"title":"apiVersion","required":true,"role":"symbol","type":"topic","abstract":[{"text":"Currently supported version of the My Account API.","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/myaccount\/apiversion","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccount\/apiVersion","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"apiVersion"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccount"]]},"metadata":{"symbolKind":"property","modules":[{"name":"Auth0"}],"title":"apiVersion","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"apiVersion","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"externalID":"s:5Auth09MyAccountP10apiVersionSSvpZ","required":true,"role":"symbol","roleHeading":"Type Property"},"sections":[],"abstract":[{"type":"text","text":"Currently supported version of the My Account API."}],"variants":[{"paths":["\/documentation\/auth0\/myaccount\/apiversion"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccount\/apiVersion","interfaceLanguage":"swift"},"kind":"symbol","schemaVersion":{"minor":3,"patch":0,"major":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"apiVersion","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccount":{"url":"\/documentation\/auth0\/myaccount","abstract":[{"type":"text","text":"My Account API client for managing the current user’s account."}],"title":"MyAccount","navigatorTitle":[{"text":"MyAccount","kind":"identifier"}],"fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccount"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccount","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccount/apiVersion":{"type":"topic","title":"apiVersion","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccount\/apiVersion","url":"\/documentation\/auth0\/myaccount\/apiversion","abstract":[{"type":"text","text":"Currently supported version of the My Account API."}],"kind":"symbol","required":true,"role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"apiVersion","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/myaccount/authenticationmethods.json b/docs/data/documentation/auth0/myaccount/authenticationmethods.json index 3e085c006..aaac18f28 100644 --- a/docs/data/documentation/auth0/myaccount/authenticationmethods.json +++ b/docs/data/documentation/auth0/myaccount/authenticationmethods.json @@ -1 +1 @@ -{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/myaccount\/authenticationmethods"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccount\/authenticationMethods","interfaceLanguage":"swift"},"schemaVersion":{"minor":3,"major":0,"patch":0},"metadata":{"roleHeading":"Instance Property","required":true,"externalID":"s:5Auth09MyAccountP21authenticationMethodsAA0bc14AuthenticationE0_pvp","role":"symbol","title":"authenticationMethods","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticationMethods"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth030MyAccountAuthenticationMethodsP","text":"MyAccountAuthenticationMethods"}],"symbolKind":"property"},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccount"]]},"abstract":[{"text":"My Account API sub-client for managing the current user’s authentication methods.","type":"text"}],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticationMethods"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"MyAccountAuthenticationMethods","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods","preciseIdentifier":"s:5Auth030MyAccountAuthenticationMethodsP"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccount/authenticationMethods":{"url":"\/documentation\/auth0\/myaccount\/authenticationmethods","type":"topic","abstract":[{"text":"My Account API sub-client for managing the current user’s authentication methods.","type":"text"}],"role":"symbol","kind":"symbol","title":"authenticationMethods","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticationMethods"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth030MyAccountAuthenticationMethodsP","text":"MyAccountAuthenticationMethods"}],"required":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccount\/authenticationMethods"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods":{"url":"\/documentation\/auth0\/myaccountauthenticationmethods","kind":"symbol","type":"topic","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountAuthenticationMethods","kind":"identifier"}],"navigatorTitle":[{"text":"MyAccountAuthenticationMethods","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods","title":"MyAccountAuthenticationMethods","abstract":[{"type":"text","text":"My Account API sub-client for managing the current user’s authentication methods."}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccount":{"fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccount","kind":"identifier"}],"type":"topic","kind":"symbol","url":"\/documentation\/auth0\/myaccount","navigatorTitle":[{"text":"MyAccount","kind":"identifier"}],"abstract":[{"type":"text","text":"My Account API client for managing the current user’s account."}],"title":"MyAccount","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccount"}}} \ No newline at end of file +{"abstract":[{"type":"text","text":"My Account API sub-client for managing the current user’s authentication methods."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authenticationMethods","kind":"identifier"},{"text":": ","kind":"text"},{"text":"MyAccountAuthenticationMethods","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods","kind":"typeIdentifier","preciseIdentifier":"s:5Auth030MyAccountAuthenticationMethodsP"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/myaccount\/authenticationmethods"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccount"]]},"metadata":{"modules":[{"name":"Auth0"}],"title":"authenticationMethods","roleHeading":"Instance Property","symbolKind":"property","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authenticationMethods","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth030MyAccountAuthenticationMethodsP","text":"MyAccountAuthenticationMethods","kind":"typeIdentifier"}],"externalID":"s:5Auth09MyAccountP21authenticationMethodsAA0bc14AuthenticationE0_pvp","required":true},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccount\/authenticationMethods"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/MyAccount/authenticationMethods":{"url":"\/documentation\/auth0\/myaccount\/authenticationmethods","required":true,"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticationMethods"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth030MyAccountAuthenticationMethodsP","text":"MyAccountAuthenticationMethods"}],"title":"authenticationMethods","type":"topic","role":"symbol","abstract":[{"type":"text","text":"My Account API sub-client for managing the current user’s authentication methods."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccount\/authenticationMethods","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods":{"role":"symbol","title":"MyAccountAuthenticationMethods","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"MyAccountAuthenticationMethods"}],"navigatorTitle":[{"text":"MyAccountAuthenticationMethods","kind":"identifier"}],"abstract":[{"type":"text","text":"My Account API sub-client for managing the current user’s authentication methods."}],"kind":"symbol","url":"\/documentation\/auth0\/myaccountauthenticationmethods","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccount":{"url":"\/documentation\/auth0\/myaccount","abstract":[{"type":"text","text":"My Account API client for managing the current user’s account."}],"title":"MyAccount","navigatorTitle":[{"text":"MyAccount","kind":"identifier"}],"fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccount"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccount","role":"symbol","kind":"symbol","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/myaccountauthenticationmethods.json b/docs/data/documentation/auth0/myaccountauthenticationmethods.json index 88dba14ab..6d71c2dd3 100644 --- a/docs/data/documentation/auth0/myaccountauthenticationmethods.json +++ b/docs/data/documentation/auth0/myaccountauthenticationmethods.json @@ -1 +1 @@ -{"variants":[{"paths":["\/documentation\/auth0\/myaccountauthenticationmethods"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"roleHeading":"Protocol","title":"MyAccountAuthenticationMethods","symbolKind":"protocol","navigatorTitle":[{"text":"MyAccountAuthenticationMethods","kind":"identifier"}],"modules":[{"name":"Auth0"}],"fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountAuthenticationMethods","kind":"identifier"}],"externalID":"s:5Auth030MyAccountAuthenticationMethodsP","role":"symbol"},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountAuthenticationMethods","kind":"identifier"},{"text":" : ","kind":"text"},{"text":"MyAccountClient","preciseIdentifier":"s:5Auth015MyAccountClientP","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountClient","kind":"typeIdentifier"}],"languages":["swift"]}],"kind":"declarations"}],"seeAlsoSections":[{"anchor":"Related-Documentation","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccount","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError"],"title":"Related Documentation"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"relationshipsSections":[{"type":"inheritsFrom","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountClient","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable"],"title":"Inherits From","kind":"relationships"}],"sections":[],"kind":"symbol","abstract":[{"type":"text","text":"My Account API sub-client for managing the current user’s authentication methods."}],"topicSections":[{"anchor":"Instance-Methods","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/confirmEmailEnrollment(id:authSession:otpCode:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/confirmPhoneEnrollment(id:authSession:otpCode:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/confirmPushNotificationEnrollment(id:authSession:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/confirmRecoveryCodeEnrollment(id:authSession:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/confirmTOTPEnrollment(id:authSession:otpCode:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/deleteAuthenticationMethod(by:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/enroll(passkey:challenge:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/enrollEmail(emailAddress:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/enrollPhone(phoneNumber:preferredAuthenticationMethod:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/enrollPushNotification()","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/enrollRecoveryCode()","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/enrollTOTP()","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/getAuthenticationMethod(by:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/getAuthenticationMethods()","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/getFactors()","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/passkeyEnrollmentChallenge(userIdentityId:connection:)"],"title":"Instance Methods","generated":true}],"schemaVersion":{"minor":3,"patch":0,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods/enrollPhone(phoneNumber:preferredAuthenticationMethod:)":{"defaultImplementations":1,"url":"\/documentation\/auth0\/myaccountauthenticationmethods\/enrollphone(phonenumber:preferredauthenticationmethod:)","title":"enrollPhone(phoneNumber:preferredAuthenticationMethod:)","type":"topic","required":true,"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"enrollPhone","kind":"identifier"},{"text":"(","kind":"text"},{"text":"phoneNumber","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"preferredAuthenticationMethod","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"PreferredAuthenticationMethod","preciseIdentifier":"s:5Auth029PreferredAuthenticationMethodO","kind":"typeIdentifier"},{"text":"?) -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"PhoneEnrollmentChallenge","preciseIdentifier":"s:5Auth024PhoneEnrollmentChallengeV","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"MyAccountError","preciseIdentifier":"s:5Auth014MyAccountErrorV"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/enrollPhone(phoneNumber:preferredAuthenticationMethod:)","kind":"symbol","abstract":[{"type":"text","text":"Requests a challenge for enrolling a Phone authentication method. This is the first part of the enrollment flow."}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods/passkeyEnrollmentChallenge(userIdentityId:connection:)":{"type":"topic","title":"passkeyEnrollmentChallenge(userIdentityId:connection:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/passkeyEnrollmentChallenge(userIdentityId:connection:)","required":true,"role":"symbol","abstract":[{"type":"text","text":"Requests a challenge for enrolling a new passkey. This is the first part of the enrollment flow."}],"defaultImplementations":1,"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"passkeyEnrollmentChallenge"},{"kind":"text","text":"("},{"kind":"externalParam","text":"userIdentityId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth026PasskeyEnrollmentChallengeV","text":"PasskeyEnrollmentChallenge"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth014MyAccountErrorV","text":"MyAccountError"},{"kind":"text","text":">"}],"url":"\/documentation\/auth0\/myaccountauthenticationmethods\/passkeyenrollmentchallenge(useridentityid:connection:)"},"doc://com.auth0.Auth0/documentation/Auth0/Loggable":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","abstract":[{"type":"text","text":"A type that can log statements for debugging purposes."}],"fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Loggable","kind":"identifier"}],"kind":"symbol","title":"Loggable","type":"topic","role":"symbol","navigatorTitle":[{"text":"Loggable","kind":"identifier"}],"url":"\/documentation\/auth0\/loggable"},"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","url":"\/documentation\/auth0\/trackable","role":"symbol","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Trackable"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable","title":"Trackable","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Trackable"}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods/enroll(passkey:challenge:)":{"type":"topic","title":"enroll(passkey:challenge:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/enroll(passkey:challenge:)","required":true,"role":"symbol","abstract":[{"text":"Enrolls a new passkey credential. This is the last part of the enrollment flow.","type":"text"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"enroll","kind":"identifier"},{"text":"(","kind":"text"},{"text":"passkey","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"NewPasskey","kind":"typeIdentifier","preciseIdentifier":"s:5Auth010NewPasskeyP"},{"text":", ","kind":"text"},{"text":"challenge","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"PasskeyEnrollmentChallenge","kind":"typeIdentifier","preciseIdentifier":"s:5Auth026PasskeyEnrollmentChallengeV"},{"text":") -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"PasskeyAuthenticationMethod","kind":"typeIdentifier","preciseIdentifier":"s:5Auth027PasskeyAuthenticationMethodV"},{"text":", ","kind":"text"},{"text":"MyAccountError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth014MyAccountErrorV"},{"text":">","kind":"text"}],"url":"\/documentation\/auth0\/myaccountauthenticationmethods\/enroll(passkey:challenge:)"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods/confirmTOTPEnrollment(id:authSession:otpCode:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/confirmTOTPEnrollment(id:authSession:otpCode:)","title":"confirmTOTPEnrollment(id:authSession:otpCode:)","kind":"symbol","abstract":[{"type":"text","text":"Enrolls a new ToTP authentication method. This is the last part of the enrollment flow."}],"required":true,"url":"\/documentation\/auth0\/myaccountauthenticationmethods\/confirmtotpenrollment(id:authsession:otpcode:)","type":"topic","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"confirmTOTPEnrollment","kind":"identifier"},{"text":"(","kind":"text"},{"text":"id","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"authSession","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"otpCode","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth020AuthenticationMethodV","text":"AuthenticationMethod","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth014MyAccountErrorV","text":"MyAccountError","kind":"typeIdentifier"},{"text":">","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods/confirmEmailEnrollment(id:authSession:otpCode:)":{"title":"confirmEmailEnrollment(id:authSession:otpCode:)","required":true,"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"confirmEmailEnrollment"},{"kind":"text","text":"("},{"kind":"externalParam","text":"id"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"authSession"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"otpCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"AuthenticationMethod","preciseIdentifier":"s:5Auth020AuthenticationMethodV"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"MyAccountError","preciseIdentifier":"s:5Auth014MyAccountErrorV"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/confirmEmailEnrollment(id:authSession:otpCode:)","type":"topic","url":"\/documentation\/auth0\/myaccountauthenticationmethods\/confirmemailenrollment(id:authsession:otpcode:)","kind":"symbol","abstract":[{"type":"text","text":"Enrolls a new Email authentication method. This is the last part of the enrollment flow."}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods/enrollTOTP()":{"required":true,"role":"symbol","abstract":[{"type":"text","text":"Requests a challenge for enrolling a TOTP authentication method. This is the first part of the enrollment flow."}],"url":"\/documentation\/auth0\/myaccountauthenticationmethods\/enrolltotp()","title":"enrollTOTP()","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"enrollTOTP","kind":"identifier"},{"text":"() -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"TOTPEnrollmentChallenge","kind":"typeIdentifier","preciseIdentifier":"s:5Auth023TOTPEnrollmentChallengeV"},{"text":", ","kind":"text"},{"text":"MyAccountError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth014MyAccountErrorV"},{"text":">","kind":"text"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/enrollTOTP()","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods/enrollEmail(emailAddress:)":{"title":"enrollEmail(emailAddress:)","abstract":[{"text":"Requests a challenge for enrolling a Email authentication method. This is the first part of the enrollment flow.","type":"text"}],"role":"symbol","kind":"symbol","type":"topic","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"enrollEmail","kind":"identifier"},{"text":"(","kind":"text"},{"text":"emailAddress","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"EmailEnrollmentChallenge","kind":"typeIdentifier","preciseIdentifier":"s:5Auth024EmailEnrollmentChallengeV"},{"text":", ","kind":"text"},{"text":"MyAccountError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth014MyAccountErrorV"},{"text":">","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/enrollEmail(emailAddress:)","required":true,"url":"\/documentation\/auth0\/myaccountauthenticationmethods\/enrollemail(emailaddress:)"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods":{"url":"\/documentation\/auth0\/myaccountauthenticationmethods","kind":"symbol","type":"topic","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountAuthenticationMethods","kind":"identifier"}],"navigatorTitle":[{"text":"MyAccountAuthenticationMethods","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods","title":"MyAccountAuthenticationMethods","abstract":[{"type":"text","text":"My Account API sub-client for managing the current user’s authentication methods."}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods/getFactors()":{"url":"\/documentation\/auth0\/myaccountauthenticationmethods\/getfactors()","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/getFactors()","type":"topic","required":true,"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getFactors","kind":"identifier"},{"text":"() -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<[","kind":"text"},{"text":"Factor","kind":"typeIdentifier","preciseIdentifier":"s:5Auth06FactorV"},{"text":"], ","kind":"text"},{"text":"MyAccountError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth014MyAccountErrorV"},{"text":">","kind":"text"}],"title":"getFactors()","abstract":[{"type":"text","text":"List of factors enabled for the Auth0 tenant and available for enrollment by this user."}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountClient":{"type":"topic","title":"MyAccountClient","kind":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountClient","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountClient","navigatorTitle":[{"text":"MyAccountClient","kind":"identifier"}],"role":"symbol","abstract":[{"type":"text","text":"A client for the My Account API."},{"type":"text","text":" "},{"type":"text","text":"Adopting types could be either the root client or a leaf sub-client."}],"url":"\/documentation\/auth0\/myaccountclient"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods/enrollPushNotification()":{"title":"enrollPushNotification()","kind":"symbol","type":"topic","url":"\/documentation\/auth0\/myaccountauthenticationmethods\/enrollpushnotification()","abstract":[{"text":"Requests a challenge for enrolling a push notification authentication method. This is the first part of the enrollment flow.","type":"text"}],"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"enrollPushNotification","kind":"identifier"},{"text":"() -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"PushEnrollmentChallenge","preciseIdentifier":"s:5Auth023PushEnrollmentChallengeV","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"MyAccountError","preciseIdentifier":"s:5Auth014MyAccountErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/enrollPushNotification()","required":true},"doc://com.auth0.Auth0/documentation/Auth0/MyAccount":{"fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccount","kind":"identifier"}],"type":"topic","kind":"symbol","url":"\/documentation\/auth0\/myaccount","navigatorTitle":[{"text":"MyAccount","kind":"identifier"}],"abstract":[{"type":"text","text":"My Account API client for managing the current user’s account."}],"title":"MyAccount","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccount"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods/getAuthenticationMethod(by:)":{"url":"\/documentation\/auth0\/myaccountauthenticationmethods\/getauthenticationmethod(by:)","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/getAuthenticationMethod(by:)","role":"symbol","abstract":[{"type":"text","text":"Fetch details of an authentication method associated with an id"}],"title":"getAuthenticationMethod(by:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getAuthenticationMethod","kind":"identifier"},{"text":"(","kind":"text"},{"text":"by","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"AuthenticationMethod","kind":"typeIdentifier","preciseIdentifier":"s:5Auth020AuthenticationMethodV"},{"text":", ","kind":"text"},{"text":"MyAccountError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth014MyAccountErrorV"},{"text":">","kind":"text"}],"required":true,"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods/deleteAuthenticationMethod(by:)":{"url":"\/documentation\/auth0\/myaccountauthenticationmethods\/deleteauthenticationmethod(by:)","kind":"symbol","abstract":[{"text":"Delete an authentication method associated with an id","type":"text"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/deleteAuthenticationMethod(by:)","required":true,"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"deleteAuthenticationMethod","kind":"identifier"},{"text":"(","kind":"text"},{"text":"by","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":", ","kind":"text"},{"text":"MyAccountError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth014MyAccountErrorV"},{"text":">","kind":"text"}],"title":"deleteAuthenticationMethod(by:)"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods/confirmRecoveryCodeEnrollment(id:authSession:)":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/confirmRecoveryCodeEnrollment(id:authSession:)","role":"symbol","url":"\/documentation\/auth0\/myaccountauthenticationmethods\/confirmrecoverycodeenrollment(id:authsession:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"confirmRecoveryCodeEnrollment","kind":"identifier"},{"text":"(","kind":"text"},{"text":"id","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"authSession","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth020AuthenticationMethodV","text":"AuthenticationMethod","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth014MyAccountErrorV","text":"MyAccountError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"type":"topic","title":"confirmRecoveryCodeEnrollment(id:authSession:)","abstract":[{"text":"Enrolls a new Recovery code credential. This is the last part of the enrollment flow.","type":"text"}],"required":true},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods/confirmPushNotificationEnrollment(id:authSession:)":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/confirmPushNotificationEnrollment(id:authSession:)","type":"topic","abstract":[{"text":"Enrolls a new Push Notification authentication method. This is the last part of the enrollment flow.","type":"text"}],"url":"\/documentation\/auth0\/myaccountauthenticationmethods\/confirmpushnotificationenrollment(id:authsession:)","required":true,"title":"confirmPushNotificationEnrollment(id:authSession:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"confirmPushNotificationEnrollment","kind":"identifier"},{"text":"(","kind":"text"},{"text":"id","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"authSession","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"AuthenticationMethod","kind":"typeIdentifier","preciseIdentifier":"s:5Auth020AuthenticationMethodV"},{"text":", ","kind":"text"},{"text":"MyAccountError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth014MyAccountErrorV"},{"text":">","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods/confirmPhoneEnrollment(id:authSession:otpCode:)":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"confirmPhoneEnrollment","kind":"identifier"},{"text":"(","kind":"text"},{"text":"id","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"authSession","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"otpCode","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"AuthenticationMethod","preciseIdentifier":"s:5Auth020AuthenticationMethodV","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"MyAccountError","preciseIdentifier":"s:5Auth014MyAccountErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"role":"symbol","url":"\/documentation\/auth0\/myaccountauthenticationmethods\/confirmphoneenrollment(id:authsession:otpcode:)","type":"topic","kind":"symbol","required":true,"title":"confirmPhoneEnrollment(id:authSession:otpCode:)","abstract":[{"text":"Enrolls a new Phone authentication method. This is the last part of the enrollment flow.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/confirmPhoneEnrollment(id:authSession:otpCode:)"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","type":"topic","kind":"symbol","abstract":[{"text":"Represents an error during a request to the Auth0 My Account API.","type":"text"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountError","kind":"identifier"}],"navigatorTitle":[{"text":"MyAccountError","kind":"identifier"}],"url":"\/documentation\/auth0\/myaccounterror","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods/getAuthenticationMethods()":{"type":"topic","url":"\/documentation\/auth0\/myaccountauthenticationmethods\/getauthenticationmethods()","required":true,"abstract":[{"text":"Retrieve detailed list of authentication methods belonging to the authenticated user.","type":"text"}],"title":"getAuthenticationMethods()","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getAuthenticationMethods","kind":"identifier"},{"text":"() -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<[","kind":"text"},{"preciseIdentifier":"s:5Auth020AuthenticationMethodV","text":"AuthenticationMethod","kind":"typeIdentifier"},{"text":"], ","kind":"text"},{"preciseIdentifier":"s:5Auth014MyAccountErrorV","text":"MyAccountError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/getAuthenticationMethods()","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods/enrollRecoveryCode()":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/enrollRecoveryCode()","required":true,"type":"topic","role":"symbol","abstract":[{"type":"text","text":"Requests a challenge for enrolling a recovery code authentication method. This is the first part of the enrollment flow."}],"url":"\/documentation\/auth0\/myaccountauthenticationmethods\/enrollrecoverycode()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"enrollRecoveryCode"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth031RecoveryCodeEnrollmentChallengeV","text":"RecoveryCodeEnrollmentChallenge"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth014MyAccountErrorV","text":"MyAccountError"},{"kind":"text","text":">"}],"kind":"symbol","title":"enrollRecoveryCode()"}}} \ No newline at end of file +{"metadata":{"symbolKind":"protocol","roleHeading":"Protocol","externalID":"s:5Auth030MyAccountAuthenticationMethodsP","title":"MyAccountAuthenticationMethods","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccountAuthenticationMethods"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"MyAccountAuthenticationMethods"}]},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/myaccountauthenticationmethods"]}],"relationshipsSections":[{"title":"Inherits From","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountClient","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable"],"kind":"relationships","type":"inheritsFrom"}],"topicSections":[{"title":"Instance Methods","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/confirmEmailEnrollment(id:authSession:otpCode:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/confirmPhoneEnrollment(id:authSession:otpCode:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/confirmPushNotificationEnrollment(id:authSession:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/confirmRecoveryCodeEnrollment(id:authSession:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/confirmTOTPEnrollment(id:authSession:otpCode:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/deleteAuthenticationMethod(by:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/enroll(passkey:challenge:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/enrollEmail(emailAddress:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/enrollPhone(phoneNumber:preferredAuthenticationMethod:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/enrollPushNotification()","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/enrollRecoveryCode()","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/enrollTOTP()","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/getAuthenticationMethod(by:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/getAuthenticationMethods()","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/getFactors()","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/passkeyEnrollmentChallenge(userIdentityId:connection:)"],"anchor":"Instance-Methods","generated":true}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"type":"text","text":"My Account API sub-client for managing the current user’s authentication methods."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"seeAlsoSections":[{"title":"Related Documentation","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccount","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError"],"anchor":"Related-Documentation"}],"primaryContentSections":[{"declarations":[{"tokens":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"text":"MyAccountAuthenticationMethods","kind":"identifier"},{"kind":"text","text":" : "},{"preciseIdentifier":"s:5Auth015MyAccountClientP","text":"MyAccountClient","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountClient"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/MyAccount":{"url":"\/documentation\/auth0\/myaccount","abstract":[{"type":"text","text":"My Account API client for managing the current user’s account."}],"title":"MyAccount","navigatorTitle":[{"text":"MyAccount","kind":"identifier"}],"fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccount"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccount","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods/confirmPushNotificationEnrollment(id:authSession:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/confirmPushNotificationEnrollment(id:authSession:)","kind":"symbol","title":"confirmPushNotificationEnrollment(id:authSession:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"confirmPushNotificationEnrollment","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"id"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"authSession","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":"<"},{"text":"AuthenticationMethod","preciseIdentifier":"s:5Auth020AuthenticationMethodV","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth014MyAccountErrorV","text":"MyAccountError"},{"text":">","kind":"text"}],"role":"symbol","required":true,"url":"\/documentation\/auth0\/myaccountauthenticationmethods\/confirmpushnotificationenrollment(id:authsession:)","abstract":[{"type":"text","text":"Enrolls a new Push Notification authentication method. This is the last part of the enrollment flow."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Trackable":{"title":"Trackable","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Trackable"}],"abstract":[{"text":"A type that can send the ","type":"text"},{"code":"Auth0-Client","type":"codeVoice"},{"text":" header on every request to Auth0.","type":"text"}],"url":"\/documentation\/auth0\/trackable","navigatorTitle":[{"kind":"identifier","text":"Trackable"}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods":{"role":"symbol","title":"MyAccountAuthenticationMethods","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"MyAccountAuthenticationMethods"}],"navigatorTitle":[{"text":"MyAccountAuthenticationMethods","kind":"identifier"}],"abstract":[{"type":"text","text":"My Account API sub-client for managing the current user’s authentication methods."}],"kind":"symbol","url":"\/documentation\/auth0\/myaccountauthenticationmethods","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Loggable":{"role":"symbol","title":"Loggable","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Loggable"}],"navigatorTitle":[{"text":"Loggable","kind":"identifier"}],"abstract":[{"text":"A type that can log statements for debugging purposes.","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/loggable","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods/getAuthenticationMethods()":{"type":"topic","title":"getAuthenticationMethods()","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/getAuthenticationMethods()","url":"\/documentation\/auth0\/myaccountauthenticationmethods\/getauthenticationmethods()","abstract":[{"type":"text","text":"Retrieve detailed list of authentication methods belonging to the authenticated user."}],"kind":"symbol","required":true,"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getAuthenticationMethods","kind":"identifier"},{"text":"() -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<[","kind":"text"},{"text":"AuthenticationMethod","kind":"typeIdentifier","preciseIdentifier":"s:5Auth020AuthenticationMethodV"},{"text":"], ","kind":"text"},{"text":"MyAccountError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth014MyAccountErrorV"},{"text":">","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods/enrollEmail(emailAddress:)":{"url":"\/documentation\/auth0\/myaccountauthenticationmethods\/enrollemail(emailaddress:)","title":"enrollEmail(emailAddress:)","abstract":[{"type":"text","text":"Requests a challenge for enrolling a Email authentication method. This is the first part of the enrollment flow."}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"enrollEmail"},{"kind":"text","text":"("},{"kind":"externalParam","text":"emailAddress"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:5Auth024EmailEnrollmentChallengeV","kind":"typeIdentifier","text":"EmailEnrollmentChallenge"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth014MyAccountErrorV","kind":"typeIdentifier","text":"MyAccountError"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/enrollEmail(emailAddress:)","required":true,"kind":"symbol","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods/confirmRecoveryCodeEnrollment(id:authSession:)":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/confirmRecoveryCodeEnrollment(id:authSession:)","title":"confirmRecoveryCodeEnrollment(id:authSession:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"confirmRecoveryCodeEnrollment","kind":"identifier"},{"text":"(","kind":"text"},{"text":"id","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"authSession"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth020AuthenticationMethodV","text":"AuthenticationMethod"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth014MyAccountErrorV","text":"MyAccountError"},{"kind":"text","text":">"}],"role":"symbol","required":true,"url":"\/documentation\/auth0\/myaccountauthenticationmethods\/confirmrecoverycodeenrollment(id:authsession:)","abstract":[{"type":"text","text":"Enrolls a new Recovery code credential. This is the last part of the enrollment flow."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods/enroll(passkey:challenge:)":{"kind":"symbol","title":"enroll(passkey:challenge:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"enroll","kind":"identifier"},{"text":"(","kind":"text"},{"text":"passkey","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"NewPasskey","preciseIdentifier":"s:5Auth010NewPasskeyP","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"challenge","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth026PasskeyEnrollmentChallengeV","kind":"typeIdentifier","text":"PasskeyEnrollmentChallenge"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth027PasskeyAuthenticationMethodV","text":"PasskeyAuthenticationMethod"},{"kind":"text","text":", "},{"text":"MyAccountError","preciseIdentifier":"s:5Auth014MyAccountErrorV","kind":"typeIdentifier"},{"kind":"text","text":">"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/enroll(passkey:challenge:)","required":true,"abstract":[{"type":"text","text":"Enrolls a new passkey credential. This is the last part of the enrollment flow."}],"url":"\/documentation\/auth0\/myaccountauthenticationmethods\/enroll(passkey:challenge:)"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods/deleteAuthenticationMethod(by:)":{"kind":"symbol","title":"deleteAuthenticationMethod(by:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"deleteAuthenticationMethod","kind":"identifier"},{"text":"(","kind":"text"},{"text":"by","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth014MyAccountErrorV","text":"MyAccountError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/deleteAuthenticationMethod(by:)","required":true,"abstract":[{"text":"Delete an authentication method associated with an id","type":"text"}],"url":"\/documentation\/auth0\/myaccountauthenticationmethods\/deleteauthenticationmethod(by:)"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods/enrollPushNotification()":{"type":"topic","title":"enrollPushNotification()","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/enrollPushNotification()","kind":"symbol","url":"\/documentation\/auth0\/myaccountauthenticationmethods\/enrollpushnotification()","abstract":[{"type":"text","text":"Requests a challenge for enrolling a push notification authentication method. This is the first part of the enrollment flow."}],"required":true,"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"enrollPushNotification"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023PushEnrollmentChallengeV","text":"PushEnrollmentChallenge"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth014MyAccountErrorV","text":"MyAccountError"},{"kind":"text","text":">"}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods/getFactors()":{"url":"\/documentation\/auth0\/myaccountauthenticationmethods\/getfactors()","title":"getFactors()","abstract":[{"type":"text","text":"List of factors enabled for the Auth0 tenant and available for enrollment by this user."}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getFactors"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<["},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth06FactorV","text":"Factor"},{"kind":"text","text":"], "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth014MyAccountErrorV","text":"MyAccountError"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/getFactors()","required":true,"kind":"symbol","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods/confirmEmailEnrollment(id:authSession:otpCode:)":{"url":"\/documentation\/auth0\/myaccountauthenticationmethods\/confirmemailenrollment(id:authsession:otpcode:)","title":"confirmEmailEnrollment(id:authSession:otpCode:)","abstract":[{"type":"text","text":"Enrolls a new Email authentication method. This is the last part of the enrollment flow."}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"confirmEmailEnrollment"},{"kind":"text","text":"("},{"kind":"externalParam","text":"id"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"authSession"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"otpCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"AuthenticationMethod","preciseIdentifier":"s:5Auth020AuthenticationMethodV"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"MyAccountError","preciseIdentifier":"s:5Auth014MyAccountErrorV"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/confirmEmailEnrollment(id:authSession:otpCode:)","required":true,"kind":"symbol","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccountError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 My Account API."}],"url":"\/documentation\/auth0\/myaccounterror","navigatorTitle":[{"kind":"identifier","text":"MyAccountError"}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods/confirmPhoneEnrollment(id:authSession:otpCode:)":{"url":"\/documentation\/auth0\/myaccountauthenticationmethods\/confirmphoneenrollment(id:authsession:otpcode:)","required":true,"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"confirmPhoneEnrollment","kind":"identifier"},{"text":"(","kind":"text"},{"text":"id","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"authSession"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"otpCode"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth020AuthenticationMethodV","text":"AuthenticationMethod"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth014MyAccountErrorV","text":"MyAccountError"},{"kind":"text","text":">"}],"title":"confirmPhoneEnrollment(id:authSession:otpCode:)","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Enrolls a new Phone authentication method. This is the last part of the enrollment flow."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/confirmPhoneEnrollment(id:authSession:otpCode:)","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods/enrollTOTP()":{"kind":"symbol","required":true,"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"enrollTOTP"},{"kind":"text","text":"() -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:5Auth023TOTPEnrollmentChallengeV","kind":"typeIdentifier","text":"TOTPEnrollmentChallenge"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth014MyAccountErrorV","kind":"typeIdentifier","text":"MyAccountError"},{"kind":"text","text":">"}],"title":"enrollTOTP()","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Requests a challenge for enrolling a TOTP authentication method. This is the first part of the enrollment flow."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/enrollTOTP()","url":"\/documentation\/auth0\/myaccountauthenticationmethods\/enrolltotp()"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods/enrollRecoveryCode()":{"role":"symbol","title":"enrollRecoveryCode()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"enrollRecoveryCode"},{"text":"() -> ","kind":"text"},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"RecoveryCodeEnrollmentChallenge","preciseIdentifier":"s:5Auth031RecoveryCodeEnrollmentChallengeV"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"MyAccountError","preciseIdentifier":"s:5Auth014MyAccountErrorV"},{"kind":"text","text":">"}],"abstract":[{"type":"text","text":"Requests a challenge for enrolling a recovery code authentication method. This is the first part of the enrollment flow."}],"kind":"symbol","url":"\/documentation\/auth0\/myaccountauthenticationmethods\/enrollrecoverycode()","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/enrollRecoveryCode()","required":true,"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods/enrollPhone(phoneNumber:preferredAuthenticationMethod:)":{"url":"\/documentation\/auth0\/myaccountauthenticationmethods\/enrollphone(phonenumber:preferredauthenticationmethod:)","title":"enrollPhone(phoneNumber:preferredAuthenticationMethod:)","abstract":[{"text":"Requests a challenge for enrolling a Phone authentication method. This is the first part of the enrollment flow.","type":"text"}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"enrollPhone"},{"kind":"text","text":"("},{"kind":"externalParam","text":"phoneNumber"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"preferredAuthenticationMethod"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"PreferredAuthenticationMethod","preciseIdentifier":"s:5Auth029PreferredAuthenticationMethodO"},{"kind":"text","text":"?) -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"PhoneEnrollmentChallenge","preciseIdentifier":"s:5Auth024PhoneEnrollmentChallengeV"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"MyAccountError","preciseIdentifier":"s:5Auth014MyAccountErrorV"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/enrollPhone(phoneNumber:preferredAuthenticationMethod:)","required":true,"kind":"symbol","role":"symbol","defaultImplementations":1,"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods/confirmTOTPEnrollment(id:authSession:otpCode:)":{"role":"symbol","title":"confirmTOTPEnrollment(id:authSession:otpCode:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"confirmTOTPEnrollment"},{"kind":"text","text":"("},{"kind":"externalParam","text":"id"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"authSession"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"otpCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"AuthenticationMethod","preciseIdentifier":"s:5Auth020AuthenticationMethodV"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"MyAccountError","preciseIdentifier":"s:5Auth014MyAccountErrorV"},{"kind":"text","text":">"}],"abstract":[{"type":"text","text":"Enrolls a new ToTP authentication method. This is the last part of the enrollment flow."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/confirmTOTPEnrollment(id:authSession:otpCode:)","url":"\/documentation\/auth0\/myaccountauthenticationmethods\/confirmtotpenrollment(id:authsession:otpcode:)","required":true,"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods/getAuthenticationMethod(by:)":{"kind":"symbol","required":true,"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getAuthenticationMethod"},{"kind":"text","text":"("},{"kind":"externalParam","text":"by"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"AuthenticationMethod","preciseIdentifier":"s:5Auth020AuthenticationMethodV"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"MyAccountError","preciseIdentifier":"s:5Auth014MyAccountErrorV"},{"kind":"text","text":">"}],"title":"getAuthenticationMethod(by:)","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Fetch details of an authentication method associated with an id"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/getAuthenticationMethod(by:)","url":"\/documentation\/auth0\/myaccountauthenticationmethods\/getauthenticationmethod(by:)"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods/passkeyEnrollmentChallenge(userIdentityId:connection:)":{"url":"\/documentation\/auth0\/myaccountauthenticationmethods\/passkeyenrollmentchallenge(useridentityid:connection:)","abstract":[{"type":"text","text":"Requests a challenge for enrolling a new passkey. This is the first part of the enrollment flow."}],"title":"passkeyEnrollmentChallenge(userIdentityId:connection:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"passkeyEnrollmentChallenge","kind":"identifier"},{"text":"(","kind":"text"},{"text":"userIdentityId","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?) -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"PasskeyEnrollmentChallenge","preciseIdentifier":"s:5Auth026PasskeyEnrollmentChallengeV","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"MyAccountError","preciseIdentifier":"s:5Auth014MyAccountErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/passkeyEnrollmentChallenge(userIdentityId:connection:)","required":true,"kind":"symbol","role":"symbol","defaultImplementations":1,"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountClient":{"title":"MyAccountClient","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountClient","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccountClient"}],"abstract":[{"text":"A client for the My Account API.","type":"text"},{"text":" ","type":"text"},{"text":"Adopting types could be either the root client or a leaf sub-client.","type":"text"}],"url":"\/documentation\/auth0\/myaccountclient","navigatorTitle":[{"kind":"identifier","text":"MyAccountClient"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/myaccountauthenticationmethods/confirmemailenrollment(id:authsession:otpcode:).json b/docs/data/documentation/auth0/myaccountauthenticationmethods/confirmemailenrollment(id:authsession:otpcode:).json index abad14cda..1f3027c34 100644 --- a/docs/data/documentation/auth0/myaccountauthenticationmethods/confirmemailenrollment(id:authsession:otpcode:).json +++ b/docs/data/documentation/auth0/myaccountauthenticationmethods/confirmemailenrollment(id:authsession:otpcode:).json @@ -1 +1 @@ -{"kind":"symbol","abstract":[{"type":"text","text":"Enrolls a new Email authentication method. This is the last part of the enrollment flow."}],"schemaVersion":{"major":0,"patch":0,"minor":3},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods"]]},"metadata":{"role":"symbol","symbolKind":"method","externalID":"s:5Auth030MyAccountAuthenticationMethodsP22confirmEmailEnrollment2id11authSession7otpCodeAA7RequestVyAA0D6MethodVAA0bC5ErrorVGSS_S2StF","title":"confirmEmailEnrollment(id:authSession:otpCode:)","modules":[{"name":"Auth0"}],"required":true,"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"confirmEmailEnrollment"},{"kind":"text","text":"("},{"kind":"externalParam","text":"id"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"authSession"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"otpCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth020AuthenticationMethodV","text":"AuthenticationMethod","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth014MyAccountErrorV","text":"MyAccountError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"roleHeading":"Instance Method"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/confirmEmailEnrollment(id:authSession:otpCode:)","interfaceLanguage":"swift"},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"confirmEmailEnrollment"},{"kind":"text","text":"("},{"kind":"externalParam","text":"id"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"authSession"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"otpCode"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":") -> "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"kind":"text","text":"<"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod","preciseIdentifier":"s:5Auth020AuthenticationMethodV","kind":"typeIdentifier","text":"AuthenticationMethod"},{"kind":"text","text":", "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","preciseIdentifier":"s:5Auth014MyAccountErrorV","kind":"typeIdentifier","text":"MyAccountError"},{"kind":"text","text":">"}]}],"kind":"declarations"},{"parameters":[{"name":"id","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"This value is part of the Location header returned when creating an authentication method. It should be used as it is, without any modifications."}]}]},{"name":"authSession","content":[{"inlineContent":[{"text":"The unique session identifier for the enrollment as returned by POST \/authentication-methods","type":"text"}],"type":"paragraph"}]},{"name":"otpCode","content":[{"inlineContent":[{"text":"The one-time password code sent to the email address.","type":"text"}],"type":"paragraph"}]}],"kind":"parameters"},{"content":[{"level":2,"type":"heading","anchor":"return-value","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A request that will yield an enrolled email authentication method."}]}],"kind":"content"},{"content":[{"level":2,"text":"Availability","type":"heading","anchor":"Availability"},{"inlineContent":[{"type":"text","text":"This feature is currently available in"},{"type":"text","text":" "},{"isActive":true,"identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","type":"reference"},{"type":"text","text":"."},{"type":"text","text":" "},{"type":"text","text":"Please reach out to Auth0 support to get it enabled for your tenant."}],"type":"paragraph"},{"level":2,"text":"Scopes Required","type":"heading","anchor":"Scopes-Required"},{"inlineContent":[{"code":"create:me:authentication_methods","type":"codeVoice"}],"type":"paragraph"},{"level":2,"text":"Usage","type":"heading","anchor":"Usage"},{"syntax":"swift","type":"codeListing","code":["Auth0"," .myAccount(token: apiCredentials.accessToken)"," .authenticationMethods"," .confirmEmailEnrollment(id: id, authSession: authSession, otpCode: otpCode)"," .start { result in"," switch result {"," case .success(let authenticationMethod):"," print(\"Enrolled email: \\(authenticationMethod)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"]}],"kind":"content"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/myaccountauthenticationmethods\/confirmemailenrollment(id:authsession:otpcode:)"]}],"references":{"https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access":{"type":"link","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","titleInlineContent":[{"type":"text","text":"Early Access"}],"url":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","title":"Early Access"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods/confirmEmailEnrollment(id:authSession:otpCode:)":{"title":"confirmEmailEnrollment(id:authSession:otpCode:)","required":true,"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"confirmEmailEnrollment"},{"kind":"text","text":"("},{"kind":"externalParam","text":"id"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"authSession"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"otpCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"AuthenticationMethod","preciseIdentifier":"s:5Auth020AuthenticationMethodV"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"MyAccountError","preciseIdentifier":"s:5Auth014MyAccountErrorV"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/confirmEmailEnrollment(id:authSession:otpCode:)","type":"topic","url":"\/documentation\/auth0\/myaccountauthenticationmethods\/confirmemailenrollment(id:authsession:otpcode:)","kind":"symbol","abstract":[{"type":"text","text":"Enrolls a new Email authentication method. This is the last part of the enrollment flow."}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods":{"url":"\/documentation\/auth0\/myaccountauthenticationmethods","kind":"symbol","type":"topic","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountAuthenticationMethods","kind":"identifier"}],"navigatorTitle":[{"text":"MyAccountAuthenticationMethods","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods","title":"MyAccountAuthenticationMethods","abstract":[{"type":"text","text":"My Account API sub-client for managing the current user’s authentication methods."}]},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/request","kind":"symbol","abstract":[{"type":"text","text":"Auth0 API request."}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","type":"topic","kind":"symbol","abstract":[{"text":"Represents an error during a request to the Auth0 My Account API.","type":"text"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountError","kind":"identifier"}],"navigatorTitle":[{"text":"MyAccountError","kind":"identifier"}],"url":"\/documentation\/auth0\/myaccounterror","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationMethod","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod","navigatorTitle":[{"text":"AuthenticationMethod","kind":"identifier"}],"abstract":[],"title":"AuthenticationMethod","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/authenticationmethod"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods"]]},"metadata":{"symbolKind":"method","modules":[{"name":"Auth0"}],"title":"confirmEmailEnrollment(id:authSession:otpCode:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"confirmEmailEnrollment","kind":"identifier"},{"text":"(","kind":"text"},{"text":"id","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"authSession","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"otpCode","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"AuthenticationMethod","preciseIdentifier":"s:5Auth020AuthenticationMethodV","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"MyAccountError","preciseIdentifier":"s:5Auth014MyAccountErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"externalID":"s:5Auth030MyAccountAuthenticationMethodsP22confirmEmailEnrollment2id11authSession7otpCodeAA7RequestVyAA0D6MethodVAA0bC5ErrorVGSS_S2StF","role":"symbol","required":true,"roleHeading":"Instance Method"},"sections":[],"abstract":[{"text":"Enrolls a new Email authentication method. This is the last part of the enrollment flow.","type":"text"}],"variants":[{"paths":["\/documentation\/auth0\/myaccountauthenticationmethods\/confirmemailenrollment(id:authsession:otpcode:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/confirmEmailEnrollment(id:authSession:otpCode:)","interfaceLanguage":"swift"},"kind":"symbol","schemaVersion":{"minor":3,"patch":0,"major":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"confirmEmailEnrollment"},{"kind":"text","text":"("},{"kind":"externalParam","text":"id"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"authSession"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"otpCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth020AuthenticationMethodV","text":"AuthenticationMethod","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth014MyAccountErrorV","text":"MyAccountError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError"},{"kind":"text","text":">"}],"languages":["swift"],"platforms":["iOS"]}]},{"parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"This value is part of the Location header returned when creating an authentication method. It should be used as it is, without any modifications."}]}],"name":"id"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The unique session identifier for the enrollment as returned by POST \/authentication-methods"}]}],"name":"authSession"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The one-time password code sent to the email address."}]}],"name":"otpCode"}],"kind":"parameters"},{"content":[{"level":2,"anchor":"return-value","text":"Return Value","type":"heading"},{"type":"paragraph","inlineContent":[{"text":"A request that will yield an enrolled email authentication method.","type":"text"}]}],"kind":"content"},{"content":[{"level":2,"type":"heading","anchor":"Availability","text":"Availability"},{"type":"paragraph","inlineContent":[{"text":"This feature is currently available in","type":"text"},{"text":" ","type":"text"},{"isActive":true,"identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","type":"reference"},{"text":".","type":"text"},{"text":" ","type":"text"},{"text":"Please reach out to Auth0 support to get it enabled for your tenant.","type":"text"}]},{"level":2,"type":"heading","anchor":"Scopes-Required","text":"Scopes Required"},{"type":"paragraph","inlineContent":[{"code":"create:me:authentication_methods","type":"codeVoice"}]},{"level":2,"type":"heading","anchor":"Usage","text":"Usage"},{"type":"codeListing","syntax":"swift","code":["Auth0"," .myAccount(token: apiCredentials.accessToken)"," .authenticationMethods"," .confirmEmailEnrollment(id: id, authSession: authSession, otpCode: otpCode)"," .start { result in"," switch result {"," case .success(let authenticationMethod):"," print(\"Enrolled email: \\(authenticationMethod)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"]}],"kind":"content"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods/confirmEmailEnrollment(id:authSession:otpCode:)":{"url":"\/documentation\/auth0\/myaccountauthenticationmethods\/confirmemailenrollment(id:authsession:otpcode:)","title":"confirmEmailEnrollment(id:authSession:otpCode:)","abstract":[{"type":"text","text":"Enrolls a new Email authentication method. This is the last part of the enrollment flow."}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"confirmEmailEnrollment"},{"kind":"text","text":"("},{"kind":"externalParam","text":"id"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"authSession"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"otpCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"AuthenticationMethod","preciseIdentifier":"s:5Auth020AuthenticationMethodV"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"MyAccountError","preciseIdentifier":"s:5Auth014MyAccountErrorV"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/confirmEmailEnrollment(id:authSession:otpCode:)","required":true,"kind":"symbol","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccountError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 My Account API."}],"url":"\/documentation\/auth0\/myaccounterror","navigatorTitle":[{"kind":"identifier","text":"MyAccountError"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod":{"role":"symbol","title":"AuthenticationMethod","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationMethod"}],"navigatorTitle":[{"text":"AuthenticationMethod","kind":"identifier"}],"abstract":[],"kind":"symbol","url":"\/documentation\/auth0\/authenticationmethod","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods":{"role":"symbol","title":"MyAccountAuthenticationMethods","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"MyAccountAuthenticationMethods"}],"navigatorTitle":[{"text":"MyAccountAuthenticationMethods","kind":"identifier"}],"abstract":[{"type":"text","text":"My Account API sub-client for managing the current user’s authentication methods."}],"kind":"symbol","url":"\/documentation\/auth0\/myaccountauthenticationmethods","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"title":"Request","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"abstract":[{"text":"Auth0 API request.","type":"text"}],"url":"\/documentation\/auth0\/request","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access":{"title":"Early Access","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","titleInlineContent":[{"text":"Early Access","type":"text"}],"type":"link","url":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/myaccountauthenticationmethods/confirmphoneenrollment(id:authsession:otpcode:).json b/docs/data/documentation/auth0/myaccountauthenticationmethods/confirmphoneenrollment(id:authsession:otpcode:).json index 36271f295..05a263463 100644 --- a/docs/data/documentation/auth0/myaccountauthenticationmethods/confirmphoneenrollment(id:authsession:otpcode:).json +++ b/docs/data/documentation/auth0/myaccountauthenticationmethods/confirmphoneenrollment(id:authsession:otpcode:).json @@ -1 +1 @@ -{"metadata":{"roleHeading":"Instance Method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"confirmPhoneEnrollment","kind":"identifier"},{"text":"(","kind":"text"},{"text":"id","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"authSession","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"otpCode","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth020AuthenticationMethodV","text":"AuthenticationMethod","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth014MyAccountErrorV","text":"MyAccountError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"role":"symbol","modules":[{"name":"Auth0"}],"required":true,"symbolKind":"method","externalID":"s:5Auth030MyAccountAuthenticationMethodsP22confirmPhoneEnrollment2id11authSession7otpCodeAA7RequestVyAA0D6MethodVAA0bC5ErrorVGSS_S2StF","title":"confirmPhoneEnrollment(id:authSession:otpCode:)"},"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/confirmPhoneEnrollment(id:authSession:otpCode:)","interfaceLanguage":"swift"},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"confirmPhoneEnrollment"},{"kind":"text","text":"("},{"kind":"externalParam","text":"id"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"authSession"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"otpCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod","kind":"typeIdentifier","text":"AuthenticationMethod","preciseIdentifier":"s:5Auth020AuthenticationMethodV"},{"kind":"text","text":", "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","kind":"typeIdentifier","text":"MyAccountError","preciseIdentifier":"s:5Auth014MyAccountErrorV"},{"kind":"text","text":">"}],"languages":["swift"]}],"kind":"declarations"},{"parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"This value is part of the Location header returned when creating an authentication method. It should be used as it is, without any modifications."}]}],"name":"id"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The unique session identifier for the enrollment as returned by POST \/authentication-methods"}]}],"name":"authSession"},{"content":[{"inlineContent":[{"type":"text","text":"The one-time password code sent to the phone number."}],"type":"paragraph"}],"name":"otpCode"}],"kind":"parameters"},{"content":[{"type":"heading","anchor":"return-value","text":"Return Value","level":2},{"type":"paragraph","inlineContent":[{"type":"text","text":"A request that will yield an enrolled phone authentication method."}]}],"kind":"content"},{"content":[{"text":"Availability","level":2,"anchor":"Availability","type":"heading"},{"inlineContent":[{"type":"text","text":"This feature is currently available in"},{"type":"text","text":" "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","isActive":true},{"type":"text","text":"."},{"type":"text","text":" "},{"type":"text","text":"Please reach out to Auth0 support to get it enabled for your tenant."}],"type":"paragraph"},{"text":"Scopes Required","level":2,"anchor":"Scopes-Required","type":"heading"},{"inlineContent":[{"type":"codeVoice","code":"create:me:authentication_methods"}],"type":"paragraph"},{"text":"Usage","level":2,"anchor":"Usage","type":"heading"},{"syntax":"swift","type":"codeListing","code":["Auth0"," .myAccount(token: apiCredentials.accessToken)"," .authenticationMethods"," .confirmPhoneEnrollment(id: id, authSession: authSession, otpCode: otpCode)"," .start { result in"," switch result {"," case .success(let authenticationMethod):"," print(\"Enrolled phone: \\(authenticationMethod)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"]}],"kind":"content"}],"abstract":[{"text":"Enrolls a new Phone authentication method. This is the last part of the enrollment flow.","type":"text"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/myaccountauthenticationmethods\/confirmphoneenrollment(id:authsession:otpcode:)"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods"]]},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/Request":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/request","kind":"symbol","abstract":[{"type":"text","text":"Auth0 API request."}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationMethod","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod","navigatorTitle":[{"text":"AuthenticationMethod","kind":"identifier"}],"abstract":[],"title":"AuthenticationMethod","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/authenticationmethod"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods":{"url":"\/documentation\/auth0\/myaccountauthenticationmethods","kind":"symbol","type":"topic","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountAuthenticationMethods","kind":"identifier"}],"navigatorTitle":[{"text":"MyAccountAuthenticationMethods","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods","title":"MyAccountAuthenticationMethods","abstract":[{"type":"text","text":"My Account API sub-client for managing the current user’s authentication methods."}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access":{"type":"link","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","url":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","title":"Early Access","titleInlineContent":[{"type":"text","text":"Early Access"}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","type":"topic","kind":"symbol","abstract":[{"text":"Represents an error during a request to the Auth0 My Account API.","type":"text"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountError","kind":"identifier"}],"navigatorTitle":[{"text":"MyAccountError","kind":"identifier"}],"url":"\/documentation\/auth0\/myaccounterror","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods/confirmPhoneEnrollment(id:authSession:otpCode:)":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"confirmPhoneEnrollment","kind":"identifier"},{"text":"(","kind":"text"},{"text":"id","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"authSession","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"otpCode","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"AuthenticationMethod","preciseIdentifier":"s:5Auth020AuthenticationMethodV","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"MyAccountError","preciseIdentifier":"s:5Auth014MyAccountErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"role":"symbol","url":"\/documentation\/auth0\/myaccountauthenticationmethods\/confirmphoneenrollment(id:authsession:otpcode:)","type":"topic","kind":"symbol","required":true,"title":"confirmPhoneEnrollment(id:authSession:otpCode:)","abstract":[{"text":"Enrolls a new Phone authentication method. This is the last part of the enrollment flow.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/confirmPhoneEnrollment(id:authSession:otpCode:)"}}} \ No newline at end of file +{"schemaVersion":{"minor":3,"patch":0,"major":0},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"confirmPhoneEnrollment","kind":"identifier"},{"text":"(","kind":"text"},{"text":"id","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"authSession","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"otpCode"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod","text":"AuthenticationMethod","kind":"typeIdentifier","preciseIdentifier":"s:5Auth020AuthenticationMethodV"},{"kind":"text","text":", "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","text":"MyAccountError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth014MyAccountErrorV"},{"kind":"text","text":">"}]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"This value is part of the Location header returned when creating an authentication method. It should be used as it is, without any modifications."}]}],"name":"id"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The unique session identifier for the enrollment as returned by POST \/authentication-methods"}]}],"name":"authSession"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The one-time password code sent to the phone number."}]}],"name":"otpCode"}]},{"kind":"content","content":[{"type":"heading","text":"Return Value","anchor":"return-value","level":2},{"type":"paragraph","inlineContent":[{"type":"text","text":"A request that will yield an enrolled phone authentication method."}]}]},{"kind":"content","content":[{"type":"heading","text":"Availability","anchor":"Availability","level":2},{"type":"paragraph","inlineContent":[{"type":"text","text":"This feature is currently available in"},{"type":"text","text":" "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access"},{"type":"text","text":"."},{"type":"text","text":" "},{"type":"text","text":"Please reach out to Auth0 support to get it enabled for your tenant."}]},{"type":"heading","text":"Scopes Required","anchor":"Scopes-Required","level":2},{"type":"paragraph","inlineContent":[{"type":"codeVoice","code":"create:me:authentication_methods"}]},{"type":"heading","text":"Usage","anchor":"Usage","level":2},{"type":"codeListing","syntax":"swift","code":["Auth0"," .myAccount(token: apiCredentials.accessToken)"," .authenticationMethods"," .confirmPhoneEnrollment(id: id, authSession: authSession, otpCode: otpCode)"," .start { result in"," switch result {"," case .success(let authenticationMethod):"," print(\"Enrolled phone: \\(authenticationMethod)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"]}]}],"sections":[],"abstract":[{"text":"Enrolls a new Phone authentication method. This is the last part of the enrollment flow.","type":"text"}],"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/myaccountauthenticationmethods\/confirmphoneenrollment(id:authsession:otpcode:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/confirmPhoneEnrollment(id:authSession:otpCode:)","interfaceLanguage":"swift"},"metadata":{"role":"symbol","title":"confirmPhoneEnrollment(id:authSession:otpCode:)","modules":[{"name":"Auth0"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"confirmPhoneEnrollment","kind":"identifier"},{"text":"(","kind":"text"},{"text":"id","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"authSession","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"otpCode","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"AuthenticationMethod","preciseIdentifier":"s:5Auth020AuthenticationMethodV","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth014MyAccountErrorV","text":"MyAccountError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"externalID":"s:5Auth030MyAccountAuthenticationMethodsP22confirmPhoneEnrollment2id11authSession7otpCodeAA7RequestVyAA0D6MethodVAA0bC5ErrorVGSS_S2StF","roleHeading":"Instance Method","required":true,"symbolKind":"method"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Request":{"title":"Request","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"abstract":[{"text":"Auth0 API request.","type":"text"}],"url":"\/documentation\/auth0\/request","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods/confirmPhoneEnrollment(id:authSession:otpCode:)":{"url":"\/documentation\/auth0\/myaccountauthenticationmethods\/confirmphoneenrollment(id:authsession:otpcode:)","required":true,"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"confirmPhoneEnrollment","kind":"identifier"},{"text":"(","kind":"text"},{"text":"id","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"authSession"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"otpCode"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth020AuthenticationMethodV","text":"AuthenticationMethod"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth014MyAccountErrorV","text":"MyAccountError"},{"kind":"text","text":">"}],"title":"confirmPhoneEnrollment(id:authSession:otpCode:)","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Enrolls a new Phone authentication method. This is the last part of the enrollment flow."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/confirmPhoneEnrollment(id:authSession:otpCode:)","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccountError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 My Account API."}],"url":"\/documentation\/auth0\/myaccounterror","navigatorTitle":[{"kind":"identifier","text":"MyAccountError"}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods":{"role":"symbol","title":"MyAccountAuthenticationMethods","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"MyAccountAuthenticationMethods"}],"navigatorTitle":[{"text":"MyAccountAuthenticationMethods","kind":"identifier"}],"abstract":[{"type":"text","text":"My Account API sub-client for managing the current user’s authentication methods."}],"kind":"symbol","url":"\/documentation\/auth0\/myaccountauthenticationmethods","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod":{"role":"symbol","title":"AuthenticationMethod","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationMethod"}],"navigatorTitle":[{"text":"AuthenticationMethod","kind":"identifier"}],"abstract":[],"kind":"symbol","url":"\/documentation\/auth0\/authenticationmethod","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod","type":"topic"},"https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access":{"title":"Early Access","titleInlineContent":[{"type":"text","text":"Early Access"}],"type":"link","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","url":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/myaccountauthenticationmethods/confirmpushnotificationenrollment(id:authsession:).json b/docs/data/documentation/auth0/myaccountauthenticationmethods/confirmpushnotificationenrollment(id:authsession:).json index 5e37c9d3d..7c4514a6d 100644 --- a/docs/data/documentation/auth0/myaccountauthenticationmethods/confirmpushnotificationenrollment(id:authsession:).json +++ b/docs/data/documentation/auth0/myaccountauthenticationmethods/confirmpushnotificationenrollment(id:authsession:).json @@ -1 +1 @@ -{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/myaccountauthenticationmethods\/confirmpushnotificationenrollment(id:authsession:)"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"confirmPushNotificationEnrollment","kind":"identifier"},{"text":"(","kind":"text"},{"text":"id","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"authSession","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"AuthenticationMethod","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod","preciseIdentifier":"s:5Auth020AuthenticationMethodV"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"MyAccountError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","preciseIdentifier":"s:5Auth014MyAccountErrorV"},{"kind":"text","text":">"}]}]},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"text":"This value is part of the Location header returned when creating an authentication method. It should be used as it is, without any modifications.","type":"text"}],"type":"paragraph"}],"name":"id"},{"content":[{"inlineContent":[{"text":"The unique session identifier for the enrollment as returned by POST \/authentication-methods","type":"text"}],"type":"paragraph"}],"name":"authSession"}]},{"kind":"content","content":[{"type":"heading","level":2,"text":"Return Value","anchor":"return-value"},{"type":"paragraph","inlineContent":[{"text":"A request that will yield an enrolled Push Notification authentication method.","type":"text"}]}]},{"kind":"content","content":[{"type":"heading","text":"Availability","anchor":"Availability","level":2},{"type":"paragraph","inlineContent":[{"type":"text","text":"This feature is currently available in"},{"type":"text","text":" "},{"type":"reference","isActive":true,"identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access"},{"type":"text","text":"."},{"type":"text","text":" "},{"type":"text","text":"Please reach out to Auth0 support to get it enabled for your tenant."}]},{"type":"heading","text":"Scopes Required","anchor":"Scopes-Required","level":2},{"type":"paragraph","inlineContent":[{"type":"codeVoice","code":"create:me:authentication_methods"}]},{"type":"heading","text":"Usage","anchor":"Usage","level":2},{"type":"codeListing","syntax":"swift","code":["Auth0"," .myAccount(token: apiCredentials.accessToken)"," .authenticationMethods"," .confirmPushNotificationEnrollment(id: id, authSession: authSession)"," .start { result in"," switch result {"," case .success(let authenticationMethod):"," print(\"Enrolled push notification: \\(authenticationMethod)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"]}]}],"metadata":{"modules":[{"name":"Auth0"}],"externalID":"s:5Auth030MyAccountAuthenticationMethodsP33confirmPushNotificationEnrollment2id11authSessionAA7RequestVyAA0D6MethodVAA0bC5ErrorVGSS_SStF","role":"symbol","title":"confirmPushNotificationEnrollment(id:authSession:)","symbolKind":"method","required":true,"roleHeading":"Instance Method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"confirmPushNotificationEnrollment","kind":"identifier"},{"text":"(","kind":"text"},{"text":"id","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"authSession","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"AuthenticationMethod","kind":"typeIdentifier","preciseIdentifier":"s:5Auth020AuthenticationMethodV"},{"text":", ","kind":"text"},{"text":"MyAccountError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth014MyAccountErrorV"},{"text":">","kind":"text"}]},"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/confirmPushNotificationEnrollment(id:authSession:)","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods"]]},"abstract":[{"text":"Enrolls a new Push Notification authentication method. This is the last part of the enrollment flow.","type":"text"}],"kind":"symbol","schemaVersion":{"patch":0,"major":0,"minor":3},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Request":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/request","kind":"symbol","abstract":[{"type":"text","text":"Auth0 API request."}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods":{"url":"\/documentation\/auth0\/myaccountauthenticationmethods","kind":"symbol","type":"topic","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountAuthenticationMethods","kind":"identifier"}],"navigatorTitle":[{"text":"MyAccountAuthenticationMethods","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods","title":"MyAccountAuthenticationMethods","abstract":[{"type":"text","text":"My Account API sub-client for managing the current user’s authentication methods."}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods/confirmPushNotificationEnrollment(id:authSession:)":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/confirmPushNotificationEnrollment(id:authSession:)","type":"topic","abstract":[{"text":"Enrolls a new Push Notification authentication method. This is the last part of the enrollment flow.","type":"text"}],"url":"\/documentation\/auth0\/myaccountauthenticationmethods\/confirmpushnotificationenrollment(id:authsession:)","required":true,"title":"confirmPushNotificationEnrollment(id:authSession:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"confirmPushNotificationEnrollment","kind":"identifier"},{"text":"(","kind":"text"},{"text":"id","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"authSession","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"AuthenticationMethod","kind":"typeIdentifier","preciseIdentifier":"s:5Auth020AuthenticationMethodV"},{"text":", ","kind":"text"},{"text":"MyAccountError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth014MyAccountErrorV"},{"text":">","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access":{"url":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","title":"Early Access","titleInlineContent":[{"text":"Early Access","type":"text"}],"identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","type":"topic","kind":"symbol","abstract":[{"text":"Represents an error during a request to the Auth0 My Account API.","type":"text"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountError","kind":"identifier"}],"navigatorTitle":[{"text":"MyAccountError","kind":"identifier"}],"url":"\/documentation\/auth0\/myaccounterror","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationMethod","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod","navigatorTitle":[{"text":"AuthenticationMethod","kind":"identifier"}],"abstract":[],"title":"AuthenticationMethod","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/authenticationmethod"}}} \ No newline at end of file +{"abstract":[{"type":"text","text":"Enrolls a new Push Notification authentication method. This is the last part of the enrollment flow."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"confirmPushNotificationEnrollment"},{"kind":"text","text":"("},{"kind":"externalParam","text":"id"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"authSession"},{"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"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth020AuthenticationMethodV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod","text":"AuthenticationMethod"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth014MyAccountErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","text":"MyAccountError"},{"kind":"text","text":">"}]}]},{"parameters":[{"name":"id","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"This value is part of the Location header returned when creating an authentication method. It should be used as it is, without any modifications."}]}]},{"name":"authSession","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The unique session identifier for the enrollment as returned by POST \/authentication-methods"}]}]}],"kind":"parameters"},{"kind":"content","content":[{"level":2,"anchor":"return-value","type":"heading","text":"Return Value"},{"inlineContent":[{"type":"text","text":"A request that will yield an enrolled Push Notification authentication method."}],"type":"paragraph"}]},{"kind":"content","content":[{"level":2,"type":"heading","anchor":"Availability","text":"Availability"},{"type":"paragraph","inlineContent":[{"type":"text","text":"This feature is currently available in"},{"type":"text","text":" "},{"identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","type":"reference","isActive":true},{"type":"text","text":"."},{"type":"text","text":" "},{"type":"text","text":"Please reach out to Auth0 support to get it enabled for your tenant."}]},{"level":2,"type":"heading","anchor":"Scopes-Required","text":"Scopes Required"},{"type":"paragraph","inlineContent":[{"code":"create:me:authentication_methods","type":"codeVoice"}]},{"anchor":"Usage","type":"heading","level":2,"text":"Usage"},{"syntax":"swift","type":"codeListing","code":["Auth0"," .myAccount(token: apiCredentials.accessToken)"," .authenticationMethods"," .confirmPushNotificationEnrollment(id: id, authSession: authSession)"," .start { result in"," switch result {"," case .success(let authenticationMethod):"," print(\"Enrolled push notification: \\(authenticationMethod)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/myaccountauthenticationmethods\/confirmpushnotificationenrollment(id:authsession:)"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods"]]},"metadata":{"modules":[{"name":"Auth0"}],"title":"confirmPushNotificationEnrollment(id:authSession:)","roleHeading":"Instance Method","symbolKind":"method","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"confirmPushNotificationEnrollment","kind":"identifier"},{"text":"(","kind":"text"},{"text":"id","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"authSession","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"AuthenticationMethod","preciseIdentifier":"s:5Auth020AuthenticationMethodV","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"MyAccountError","preciseIdentifier":"s:5Auth014MyAccountErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"required":true,"externalID":"s:5Auth030MyAccountAuthenticationMethodsP33confirmPushNotificationEnrollment2id11authSessionAA7RequestVyAA0D6MethodVAA0bC5ErrorVGSS_SStF"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/confirmPushNotificationEnrollment(id:authSession:)"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods/confirmPushNotificationEnrollment(id:authSession:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/confirmPushNotificationEnrollment(id:authSession:)","kind":"symbol","title":"confirmPushNotificationEnrollment(id:authSession:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"confirmPushNotificationEnrollment","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"id"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"authSession","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":"<"},{"text":"AuthenticationMethod","preciseIdentifier":"s:5Auth020AuthenticationMethodV","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth014MyAccountErrorV","text":"MyAccountError"},{"text":">","kind":"text"}],"role":"symbol","required":true,"url":"\/documentation\/auth0\/myaccountauthenticationmethods\/confirmpushnotificationenrollment(id:authsession:)","abstract":[{"type":"text","text":"Enrolls a new Push Notification authentication method. This is the last part of the enrollment flow."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod":{"role":"symbol","title":"AuthenticationMethod","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationMethod"}],"navigatorTitle":[{"text":"AuthenticationMethod","kind":"identifier"}],"abstract":[],"kind":"symbol","url":"\/documentation\/auth0\/authenticationmethod","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccountError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 My Account API."}],"url":"\/documentation\/auth0\/myaccounterror","navigatorTitle":[{"kind":"identifier","text":"MyAccountError"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access":{"title":"Early Access","type":"link","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","titleInlineContent":[{"type":"text","text":"Early Access"}],"url":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"title":"Request","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"abstract":[{"text":"Auth0 API request.","type":"text"}],"url":"\/documentation\/auth0\/request","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods":{"role":"symbol","title":"MyAccountAuthenticationMethods","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"MyAccountAuthenticationMethods"}],"navigatorTitle":[{"text":"MyAccountAuthenticationMethods","kind":"identifier"}],"abstract":[{"type":"text","text":"My Account API sub-client for managing the current user’s authentication methods."}],"kind":"symbol","url":"\/documentation\/auth0\/myaccountauthenticationmethods","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/myaccountauthenticationmethods/confirmrecoverycodeenrollment(id:authsession:).json b/docs/data/documentation/auth0/myaccountauthenticationmethods/confirmrecoverycodeenrollment(id:authsession:).json index f1aae013a..7f1cc8037 100644 --- a/docs/data/documentation/auth0/myaccountauthenticationmethods/confirmrecoverycodeenrollment(id:authsession:).json +++ b/docs/data/documentation/auth0/myaccountauthenticationmethods/confirmrecoverycodeenrollment(id:authsession:).json @@ -1 +1 @@ -{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/confirmRecoveryCodeEnrollment(id:authSession:)"},"schemaVersion":{"major":0,"patch":0,"minor":3},"abstract":[{"type":"text","text":"Enrolls a new Recovery code credential. This is the last part of the enrollment flow."}],"sections":[],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"confirmRecoveryCodeEnrollment"},{"kind":"text","text":"("},{"kind":"externalParam","text":"id"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"authSession"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","text":"Request"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:5Auth020AuthenticationMethodV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod","text":"AuthenticationMethod"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth014MyAccountErrorV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","text":"MyAccountError"},{"kind":"text","text":">"}]}],"kind":"declarations"},{"parameters":[{"content":[{"type":"paragraph","inlineContent":[{"text":"This value is part of the Location header returned when creating an authentication method. It should be used as it is, without any modifications.","type":"text"}]}],"name":"id"},{"content":[{"type":"paragraph","inlineContent":[{"text":"The unique session identifier for the enrollment as returned by POST \/authentication-methods","type":"text"}]}],"name":"authSession"}],"kind":"parameters"},{"content":[{"type":"heading","text":"Return Value","level":2,"anchor":"return-value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A request that will yield an enrolled recovery code authentication method."}]}],"kind":"content"},{"content":[{"anchor":"Availability","level":2,"text":"Availability","type":"heading"},{"inlineContent":[{"type":"text","text":"This feature is currently available in"},{"type":"text","text":" "},{"identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","type":"reference","isActive":true},{"type":"text","text":"."},{"type":"text","text":" "},{"type":"text","text":"Please reach out to Auth0 support to get it enabled for your tenant."}],"type":"paragraph"},{"anchor":"Scopes-Required","level":2,"text":"Scopes Required","type":"heading"},{"inlineContent":[{"code":"create:me:authentication_methods","type":"codeVoice"}],"type":"paragraph"},{"anchor":"Usage","level":2,"text":"Usage","type":"heading"},{"code":["Auth0"," .myAccount(token: apiCredentials.accessToken)"," .authenticationMethods"," .confirmRecoveryCodeEnrollment(id: id, authSession: authSession)"," .start { result in"," switch result {"," case .success(let authenticationMethod):"," print(\"Enrolled recovery code: \\(authenticationMethod)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"],"syntax":"swift","type":"codeListing"}],"kind":"content"}],"variants":[{"paths":["\/documentation\/auth0\/myaccountauthenticationmethods\/confirmrecoverycodeenrollment(id:authsession:)"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods"]]},"metadata":{"externalID":"s:5Auth030MyAccountAuthenticationMethodsP29confirmRecoveryCodeEnrollment2id11authSessionAA7RequestVyAA0D6MethodVAA0bC5ErrorVGSS_SStF","symbolKind":"method","modules":[{"name":"Auth0"}],"role":"symbol","required":true,"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"confirmRecoveryCodeEnrollment","kind":"identifier"},{"text":"(","kind":"text"},{"text":"id","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"authSession","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"AuthenticationMethod","kind":"typeIdentifier","preciseIdentifier":"s:5Auth020AuthenticationMethodV"},{"text":", ","kind":"text"},{"text":"MyAccountError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth014MyAccountErrorV"},{"text":">","kind":"text"}],"title":"confirmRecoveryCodeEnrollment(id:authSession:)","roleHeading":"Instance Method"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","type":"topic","kind":"symbol","abstract":[{"text":"Represents an error during a request to the Auth0 My Account API.","type":"text"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountError","kind":"identifier"}],"navigatorTitle":[{"text":"MyAccountError","kind":"identifier"}],"url":"\/documentation\/auth0\/myaccounterror","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/request","kind":"symbol","abstract":[{"type":"text","text":"Auth0 API request."}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods/confirmRecoveryCodeEnrollment(id:authSession:)":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/confirmRecoveryCodeEnrollment(id:authSession:)","role":"symbol","url":"\/documentation\/auth0\/myaccountauthenticationmethods\/confirmrecoverycodeenrollment(id:authsession:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"confirmRecoveryCodeEnrollment","kind":"identifier"},{"text":"(","kind":"text"},{"text":"id","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"authSession","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth020AuthenticationMethodV","text":"AuthenticationMethod","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth014MyAccountErrorV","text":"MyAccountError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"type":"topic","title":"confirmRecoveryCodeEnrollment(id:authSession:)","abstract":[{"text":"Enrolls a new Recovery code credential. This is the last part of the enrollment flow.","type":"text"}],"required":true},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationMethod","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod","navigatorTitle":[{"text":"AuthenticationMethod","kind":"identifier"}],"abstract":[],"title":"AuthenticationMethod","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/authenticationmethod"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods":{"url":"\/documentation\/auth0\/myaccountauthenticationmethods","kind":"symbol","type":"topic","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountAuthenticationMethods","kind":"identifier"}],"navigatorTitle":[{"text":"MyAccountAuthenticationMethods","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods","title":"MyAccountAuthenticationMethods","abstract":[{"type":"text","text":"My Account API sub-client for managing the current user’s authentication methods."}]},"https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access":{"type":"link","title":"Early Access","titleInlineContent":[{"type":"text","text":"Early Access"}],"identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","url":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods"]]},"metadata":{"symbolKind":"method","modules":[{"name":"Auth0"}],"title":"confirmRecoveryCodeEnrollment(id:authSession:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"confirmRecoveryCodeEnrollment","kind":"identifier"},{"text":"(","kind":"text"},{"text":"id","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"authSession","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth020AuthenticationMethodV","text":"AuthenticationMethod","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth014MyAccountErrorV","text":"MyAccountError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"externalID":"s:5Auth030MyAccountAuthenticationMethodsP29confirmRecoveryCodeEnrollment2id11authSessionAA7RequestVyAA0D6MethodVAA0bC5ErrorVGSS_SStF","required":true,"role":"symbol","roleHeading":"Instance Method"},"sections":[],"abstract":[{"type":"text","text":"Enrolls a new Recovery code credential. This is the last part of the enrollment flow."}],"variants":[{"paths":["\/documentation\/auth0\/myaccountauthenticationmethods\/confirmrecoverycodeenrollment(id:authsession:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/confirmRecoveryCodeEnrollment(id:authSession:)","interfaceLanguage":"swift"},"kind":"symbol","schemaVersion":{"minor":3,"major":0,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"confirmRecoveryCodeEnrollment"},{"kind":"text","text":"("},{"kind":"externalParam","text":"id"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"authSession"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"AuthenticationMethod","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod","kind":"typeIdentifier","preciseIdentifier":"s:5Auth020AuthenticationMethodV"},{"text":", ","kind":"text"},{"text":"MyAccountError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth014MyAccountErrorV"},{"text":">","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}]},{"parameters":[{"name":"id","content":[{"inlineContent":[{"type":"text","text":"This value is part of the Location header returned when creating an authentication method. It should be used as it is, without any modifications."}],"type":"paragraph"}]},{"name":"authSession","content":[{"inlineContent":[{"type":"text","text":"The unique session identifier for the enrollment as returned by POST \/authentication-methods"}],"type":"paragraph"}]}],"kind":"parameters"},{"content":[{"type":"heading","level":2,"text":"Return Value","anchor":"return-value"},{"inlineContent":[{"text":"A request that will yield an enrolled recovery code authentication method.","type":"text"}],"type":"paragraph"}],"kind":"content"},{"content":[{"type":"heading","level":2,"text":"Availability","anchor":"Availability"},{"inlineContent":[{"text":"This feature is currently available in","type":"text"},{"type":"text","text":" "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","isActive":true},{"type":"text","text":"."},{"type":"text","text":" "},{"type":"text","text":"Please reach out to Auth0 support to get it enabled for your tenant."}],"type":"paragraph"},{"level":2,"type":"heading","anchor":"Scopes-Required","text":"Scopes Required"},{"inlineContent":[{"type":"codeVoice","code":"create:me:authentication_methods"}],"type":"paragraph"},{"type":"heading","text":"Usage","anchor":"Usage","level":2},{"type":"codeListing","syntax":"swift","code":["Auth0"," .myAccount(token: apiCredentials.accessToken)"," .authenticationMethods"," .confirmRecoveryCodeEnrollment(id: id, authSession: authSession)"," .start { result in"," switch result {"," case .success(let authenticationMethod):"," print(\"Enrolled recovery code: \\(authenticationMethod)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"]}],"kind":"content"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Request":{"title":"Request","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"abstract":[{"text":"Auth0 API request.","type":"text"}],"url":"\/documentation\/auth0\/request","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods":{"role":"symbol","title":"MyAccountAuthenticationMethods","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"MyAccountAuthenticationMethods"}],"navigatorTitle":[{"text":"MyAccountAuthenticationMethods","kind":"identifier"}],"abstract":[{"type":"text","text":"My Account API sub-client for managing the current user’s authentication methods."}],"kind":"symbol","url":"\/documentation\/auth0\/myaccountauthenticationmethods","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod":{"role":"symbol","title":"AuthenticationMethod","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationMethod"}],"navigatorTitle":[{"text":"AuthenticationMethod","kind":"identifier"}],"abstract":[],"kind":"symbol","url":"\/documentation\/auth0\/authenticationmethod","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods/confirmRecoveryCodeEnrollment(id:authSession:)":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/confirmRecoveryCodeEnrollment(id:authSession:)","title":"confirmRecoveryCodeEnrollment(id:authSession:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"confirmRecoveryCodeEnrollment","kind":"identifier"},{"text":"(","kind":"text"},{"text":"id","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"authSession"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth020AuthenticationMethodV","text":"AuthenticationMethod"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth014MyAccountErrorV","text":"MyAccountError"},{"kind":"text","text":">"}],"role":"symbol","required":true,"url":"\/documentation\/auth0\/myaccountauthenticationmethods\/confirmrecoverycodeenrollment(id:authsession:)","abstract":[{"type":"text","text":"Enrolls a new Recovery code credential. This is the last part of the enrollment flow."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccountError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 My Account API."}],"url":"\/documentation\/auth0\/myaccounterror","navigatorTitle":[{"kind":"identifier","text":"MyAccountError"}]},"https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access":{"title":"Early Access","type":"link","titleInlineContent":[{"type":"text","text":"Early Access"}],"identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","url":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/myaccountauthenticationmethods/confirmtotpenrollment(id:authsession:otpcode:).json b/docs/data/documentation/auth0/myaccountauthenticationmethods/confirmtotpenrollment(id:authsession:otpcode:).json index 6511f90df..e06747fc9 100644 --- a/docs/data/documentation/auth0/myaccountauthenticationmethods/confirmtotpenrollment(id:authsession:otpcode:).json +++ b/docs/data/documentation/auth0/myaccountauthenticationmethods/confirmtotpenrollment(id:authsession:otpcode:).json @@ -1 +1 @@ -{"kind":"symbol","sections":[],"metadata":{"role":"symbol","required":true,"modules":[{"name":"Auth0"}],"title":"confirmTOTPEnrollment(id:authSession:otpCode:)","roleHeading":"Instance Method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"confirmTOTPEnrollment","kind":"identifier"},{"text":"(","kind":"text"},{"text":"id","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"authSession","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"otpCode","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"AuthenticationMethod","kind":"typeIdentifier","preciseIdentifier":"s:5Auth020AuthenticationMethodV"},{"text":", ","kind":"text"},{"text":"MyAccountError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth014MyAccountErrorV"},{"text":">","kind":"text"}],"externalID":"s:5Auth030MyAccountAuthenticationMethodsP21confirmTOTPEnrollment2id11authSession7otpCodeAA7RequestVyAA0D6MethodVAA0bC5ErrorVGSS_S2StF","symbolKind":"method"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/confirmTOTPEnrollment(id:authSession:otpCode:)"},"schemaVersion":{"patch":0,"major":0,"minor":3},"abstract":[{"text":"Enrolls a new ToTP authentication method. This is the last part of the enrollment flow.","type":"text"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/myaccountauthenticationmethods\/confirmtotpenrollment(id:authsession:otpcode:)"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"confirmTOTPEnrollment","kind":"identifier"},{"text":"(","kind":"text"},{"text":"id","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"authSession","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"otpCode","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth020AuthenticationMethodV","text":"AuthenticationMethod","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth014MyAccountErrorV","text":"MyAccountError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","kind":"typeIdentifier"},{"text":">","kind":"text"}]}]},{"parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"This value is part of the Location header returned when creating an authentication method. It should be used as it is, without any modifications."}]}],"name":"id"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The unique session identifier for the enrollment as returned by POST \/authentication-methods"}]}],"name":"authSession"},{"content":[{"inlineContent":[{"text":"The one-time password code retrieved from the TOTP application.","type":"text"}],"type":"paragraph"}],"name":"otpCode"}],"kind":"parameters"},{"content":[{"type":"heading","text":"Return Value","level":2,"anchor":"return-value"},{"type":"paragraph","inlineContent":[{"text":"A request that will yield an enrolled TOTP authentication method.","type":"text"}]}],"kind":"content"},{"content":[{"anchor":"Availability","type":"heading","level":2,"text":"Availability"},{"inlineContent":[{"type":"text","text":"This feature is currently available in"},{"type":"text","text":" "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access"},{"type":"text","text":"."},{"type":"text","text":" "},{"type":"text","text":"Please reach out to Auth0 support to get it enabled for your tenant."}],"type":"paragraph"},{"anchor":"Scopes-Required","type":"heading","level":2,"text":"Scopes Required"},{"inlineContent":[{"type":"codeVoice","code":"create:me:authentication_methods"}],"type":"paragraph"},{"anchor":"Usage","type":"heading","level":2,"text":"Usage"},{"syntax":"swift","code":["Auth0"," .myAccount(token: apiCredentials.accessToken)"," .authenticationMethods"," .confirmTOTPEnrollment(id: id, authSession: authSession, otpCode: otpCode)"," .start { result in"," switch result {"," case .success(let authenticationMethod):"," print(\"Enrolled TOTP: \\(authenticationMethod)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"],"type":"codeListing"}],"kind":"content"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods":{"url":"\/documentation\/auth0\/myaccountauthenticationmethods","kind":"symbol","type":"topic","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountAuthenticationMethods","kind":"identifier"}],"navigatorTitle":[{"text":"MyAccountAuthenticationMethods","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods","title":"MyAccountAuthenticationMethods","abstract":[{"type":"text","text":"My Account API sub-client for managing the current user’s authentication methods."}]},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/request","kind":"symbol","abstract":[{"type":"text","text":"Auth0 API request."}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","type":"topic","kind":"symbol","abstract":[{"text":"Represents an error during a request to the Auth0 My Account API.","type":"text"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountError","kind":"identifier"}],"navigatorTitle":[{"text":"MyAccountError","kind":"identifier"}],"url":"\/documentation\/auth0\/myaccounterror","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods/confirmTOTPEnrollment(id:authSession:otpCode:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/confirmTOTPEnrollment(id:authSession:otpCode:)","title":"confirmTOTPEnrollment(id:authSession:otpCode:)","kind":"symbol","abstract":[{"type":"text","text":"Enrolls a new ToTP authentication method. This is the last part of the enrollment flow."}],"required":true,"url":"\/documentation\/auth0\/myaccountauthenticationmethods\/confirmtotpenrollment(id:authsession:otpcode:)","type":"topic","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"confirmTOTPEnrollment","kind":"identifier"},{"text":"(","kind":"text"},{"text":"id","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"authSession","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"otpCode","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth020AuthenticationMethodV","text":"AuthenticationMethod","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth014MyAccountErrorV","text":"MyAccountError","kind":"typeIdentifier"},{"text":">","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationMethod","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod","navigatorTitle":[{"text":"AuthenticationMethod","kind":"identifier"}],"abstract":[],"title":"AuthenticationMethod","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/authenticationmethod"},"https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access":{"url":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","type":"link","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","title":"Early Access","titleInlineContent":[{"text":"Early Access","type":"text"}]}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/myaccountauthenticationmethods\/confirmtotpenrollment(id:authsession:otpcode:)"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods"]]},"abstract":[{"type":"text","text":"Enrolls a new ToTP authentication method. This is the last part of the enrollment flow."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"confirmTOTPEnrollment","kind":"identifier"},{"text":"(","kind":"text"},{"text":"id","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"authSession","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"otpCode","kind":"externalParam"},{"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\/AuthenticationMethod","text":"AuthenticationMethod","kind":"typeIdentifier","preciseIdentifier":"s:5Auth020AuthenticationMethodV"},{"text":", ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","text":"MyAccountError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth014MyAccountErrorV"},{"text":">","kind":"text"}]}]},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"This value is part of the Location header returned when creating an authentication method. It should be used as it is, without any modifications."}]}],"name":"id"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The unique session identifier for the enrollment as returned by POST \/authentication-methods"}]}],"name":"authSession"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The one-time password code retrieved from the TOTP application."}]}],"name":"otpCode"}]},{"content":[{"type":"heading","anchor":"return-value","level":2,"text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A request that will yield an enrolled TOTP authentication method."}]}],"kind":"content"},{"content":[{"type":"heading","anchor":"Availability","level":2,"text":"Availability"},{"type":"paragraph","inlineContent":[{"type":"text","text":"This feature is currently available in"},{"type":"text","text":" "},{"identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","type":"reference","isActive":true},{"type":"text","text":"."},{"type":"text","text":" "},{"type":"text","text":"Please reach out to Auth0 support to get it enabled for your tenant."}]},{"type":"heading","anchor":"Scopes-Required","level":2,"text":"Scopes Required"},{"type":"paragraph","inlineContent":[{"type":"codeVoice","code":"create:me:authentication_methods"}]},{"type":"heading","anchor":"Usage","level":2,"text":"Usage"},{"type":"codeListing","syntax":"swift","code":["Auth0"," .myAccount(token: apiCredentials.accessToken)"," .authenticationMethods"," .confirmTOTPEnrollment(id: id, authSession: authSession, otpCode: otpCode)"," .start { result in"," switch result {"," case .success(let authenticationMethod):"," print(\"Enrolled TOTP: \\(authenticationMethod)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"]}],"kind":"content"}],"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"metadata":{"externalID":"s:5Auth030MyAccountAuthenticationMethodsP21confirmTOTPEnrollment2id11authSession7otpCodeAA7RequestVyAA0D6MethodVAA0bC5ErrorVGSS_S2StF","symbolKind":"method","title":"confirmTOTPEnrollment(id:authSession:otpCode:)","roleHeading":"Instance Method","required":true,"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"confirmTOTPEnrollment","kind":"identifier"},{"text":"(","kind":"text"},{"text":"id","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"authSession","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"otpCode","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth020AuthenticationMethodV","text":"AuthenticationMethod","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth014MyAccountErrorV","text":"MyAccountError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"modules":[{"name":"Auth0"}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/confirmTOTPEnrollment(id:authSession:otpCode:)"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Request":{"title":"Request","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"abstract":[{"text":"Auth0 API request.","type":"text"}],"url":"\/documentation\/auth0\/request","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods":{"role":"symbol","title":"MyAccountAuthenticationMethods","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"MyAccountAuthenticationMethods"}],"navigatorTitle":[{"text":"MyAccountAuthenticationMethods","kind":"identifier"}],"abstract":[{"type":"text","text":"My Account API sub-client for managing the current user’s authentication methods."}],"kind":"symbol","url":"\/documentation\/auth0\/myaccountauthenticationmethods","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods/confirmTOTPEnrollment(id:authSession:otpCode:)":{"role":"symbol","title":"confirmTOTPEnrollment(id:authSession:otpCode:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"confirmTOTPEnrollment"},{"kind":"text","text":"("},{"kind":"externalParam","text":"id"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"authSession"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"otpCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"AuthenticationMethod","preciseIdentifier":"s:5Auth020AuthenticationMethodV"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"MyAccountError","preciseIdentifier":"s:5Auth014MyAccountErrorV"},{"kind":"text","text":">"}],"abstract":[{"type":"text","text":"Enrolls a new ToTP authentication method. This is the last part of the enrollment flow."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/confirmTOTPEnrollment(id:authSession:otpCode:)","url":"\/documentation\/auth0\/myaccountauthenticationmethods\/confirmtotpenrollment(id:authsession:otpcode:)","required":true,"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod":{"role":"symbol","title":"AuthenticationMethod","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationMethod"}],"navigatorTitle":[{"text":"AuthenticationMethod","kind":"identifier"}],"abstract":[],"kind":"symbol","url":"\/documentation\/auth0\/authenticationmethod","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccountError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 My Account API."}],"url":"\/documentation\/auth0\/myaccounterror","navigatorTitle":[{"kind":"identifier","text":"MyAccountError"}]},"https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access":{"url":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","title":"Early Access","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","titleInlineContent":[{"type":"text","text":"Early Access"}],"type":"link"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/myaccountauthenticationmethods/deleteauthenticationmethod(by:).json b/docs/data/documentation/auth0/myaccountauthenticationmethods/deleteauthenticationmethod(by:).json index 68ee6039e..3887a7b68 100644 --- a/docs/data/documentation/auth0/myaccountauthenticationmethods/deleteauthenticationmethod(by:).json +++ b/docs/data/documentation/auth0/myaccountauthenticationmethods/deleteauthenticationmethod(by:).json @@ -1 +1 @@ -{"kind":"symbol","abstract":[{"text":"Delete an authentication method associated with an id","type":"text"}],"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/deleteAuthenticationMethod(by:)"},"variants":[{"paths":["\/documentation\/auth0\/myaccountauthenticationmethods\/deleteauthenticationmethod(by:)"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"minor":3,"major":0,"patch":0},"metadata":{"symbolKind":"method","title":"deleteAuthenticationMethod(by:)","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"deleteAuthenticationMethod"},{"kind":"text","text":"("},{"kind":"externalParam","text":"by"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth014MyAccountErrorV","kind":"typeIdentifier","text":"MyAccountError"},{"kind":"text","text":">"}],"externalID":"s:5Auth030MyAccountAuthenticationMethodsP06deleteD6Method2byAA7RequestVyytAA0bC5ErrorVGSS_tF","required":true,"role":"symbol","modules":[{"name":"Auth0"}]},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods"]]},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"deleteAuthenticationMethod"},{"kind":"text","text":"("},{"kind":"externalParam","text":"by"},{"kind":"text","text":" "},{"kind":"internalParam","text":"id"},{"kind":"text","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":", "},{"kind":"typeIdentifier","text":"MyAccountError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","preciseIdentifier":"s:5Auth014MyAccountErrorV"},{"kind":"text","text":">"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"type":"text","text":"Id of the authentication method user wishes to delete"}],"type":"paragraph"}],"name":"id"}]},{"kind":"content","content":[{"type":"heading","level":2,"anchor":"return-value","text":"Return Value"},{"type":"paragraph","inlineContent":[{"text":"A request that will delete an authentication method associated with an id","type":"text"}]}]},{"kind":"content","content":[{"type":"heading","level":2,"text":"Availability","anchor":"Availability"},{"inlineContent":[{"type":"text","text":"This feature is currently available in"},{"type":"text","text":" "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","isActive":true},{"type":"text","text":"."},{"type":"text","text":" "},{"type":"text","text":"Please reach out to Auth0 support to get it enabled for your tenant."}],"type":"paragraph"},{"type":"heading","level":2,"text":"Scopes Required","anchor":"Scopes-Required"},{"inlineContent":[{"code":"delete:me:authentication_methods","type":"codeVoice"}],"type":"paragraph"},{"type":"heading","level":2,"text":"Usage","anchor":"Usage"},{"type":"codeListing","syntax":"swift","code":["Auth0"," .myAccount(token: apiCredentials.accessToken)"," .authenticationMethods"," .deleteAuthenticationMethod(by: id)"," .start { result in"," switch result {"," case .success:"," print(\"Authentication method is deleted\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"]}]}],"references":{"https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access":{"type":"link","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","url":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","title":"Early Access","titleInlineContent":[{"text":"Early Access","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","type":"topic","kind":"symbol","abstract":[{"text":"Represents an error during a request to the Auth0 My Account API.","type":"text"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountError","kind":"identifier"}],"navigatorTitle":[{"text":"MyAccountError","kind":"identifier"}],"url":"\/documentation\/auth0\/myaccounterror","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods":{"url":"\/documentation\/auth0\/myaccountauthenticationmethods","kind":"symbol","type":"topic","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountAuthenticationMethods","kind":"identifier"}],"navigatorTitle":[{"text":"MyAccountAuthenticationMethods","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods","title":"MyAccountAuthenticationMethods","abstract":[{"type":"text","text":"My Account API sub-client for managing the current user’s authentication methods."}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/request","kind":"symbol","abstract":[{"type":"text","text":"Auth0 API request."}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods/deleteAuthenticationMethod(by:)":{"url":"\/documentation\/auth0\/myaccountauthenticationmethods\/deleteauthenticationmethod(by:)","kind":"symbol","abstract":[{"text":"Delete an authentication method associated with an id","type":"text"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/deleteAuthenticationMethod(by:)","required":true,"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"deleteAuthenticationMethod","kind":"identifier"},{"text":"(","kind":"text"},{"text":"by","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":", ","kind":"text"},{"text":"MyAccountError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth014MyAccountErrorV"},{"text":">","kind":"text"}],"title":"deleteAuthenticationMethod(by:)"}}} \ No newline at end of file +{"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"deleteAuthenticationMethod"},{"kind":"text","text":"("},{"kind":"externalParam","text":"by"},{"kind":"text","text":" "},{"kind":"internalParam","text":"id"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth014MyAccountErrorV","text":"MyAccountError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError"},{"kind":"text","text":">"}],"platforms":["iOS"],"languages":["swift"]}]},{"parameters":[{"name":"id","content":[{"type":"paragraph","inlineContent":[{"text":"Id of the authentication method user wishes to delete","type":"text"}]}]}],"kind":"parameters"},{"content":[{"type":"heading","level":2,"text":"Return Value","anchor":"return-value"},{"inlineContent":[{"type":"text","text":"A request that will delete an authentication method associated with an id"}],"type":"paragraph"}],"kind":"content"},{"content":[{"type":"heading","level":2,"text":"Availability","anchor":"Availability"},{"inlineContent":[{"type":"text","text":"This feature is currently available in"},{"type":"text","text":" "},{"identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","type":"reference","isActive":true},{"type":"text","text":"."},{"type":"text","text":" "},{"type":"text","text":"Please reach out to Auth0 support to get it enabled for your tenant."}],"type":"paragraph"},{"anchor":"Scopes-Required","type":"heading","level":2,"text":"Scopes Required"},{"inlineContent":[{"code":"delete:me:authentication_methods","type":"codeVoice"}],"type":"paragraph"},{"anchor":"Usage","type":"heading","level":2,"text":"Usage"},{"type":"codeListing","code":["Auth0"," .myAccount(token: apiCredentials.accessToken)"," .authenticationMethods"," .deleteAuthenticationMethod(by: id)"," .start { result in"," switch result {"," case .success:"," print(\"Authentication method is deleted\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"],"syntax":"swift"}],"kind":"content"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/myaccountauthenticationmethods\/deleteauthenticationmethod(by:)"]}],"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/deleteAuthenticationMethod(by:)","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods"]]},"abstract":[{"type":"text","text":"Delete an authentication method associated with an id"}],"metadata":{"roleHeading":"Instance Method","symbolKind":"method","role":"symbol","title":"deleteAuthenticationMethod(by:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"deleteAuthenticationMethod"},{"kind":"text","text":"("},{"kind":"externalParam","text":"by"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:s4Voida","kind":"typeIdentifier","text":"Void"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth014MyAccountErrorV","kind":"typeIdentifier","text":"MyAccountError"},{"kind":"text","text":">"}],"required":true,"externalID":"s:5Auth030MyAccountAuthenticationMethodsP06deleteD6Method2byAA7RequestVyytAA0bC5ErrorVGSS_tF","modules":[{"name":"Auth0"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Request":{"title":"Request","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"abstract":[{"text":"Auth0 API request.","type":"text"}],"url":"\/documentation\/auth0\/request","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccountError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 My Account API."}],"url":"\/documentation\/auth0\/myaccounterror","navigatorTitle":[{"kind":"identifier","text":"MyAccountError"}]},"https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access":{"identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","type":"link","title":"Early Access","titleInlineContent":[{"text":"Early Access","type":"text"}],"url":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods":{"role":"symbol","title":"MyAccountAuthenticationMethods","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"MyAccountAuthenticationMethods"}],"navigatorTitle":[{"text":"MyAccountAuthenticationMethods","kind":"identifier"}],"abstract":[{"type":"text","text":"My Account API sub-client for managing the current user’s authentication methods."}],"kind":"symbol","url":"\/documentation\/auth0\/myaccountauthenticationmethods","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods/deleteAuthenticationMethod(by:)":{"kind":"symbol","title":"deleteAuthenticationMethod(by:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"deleteAuthenticationMethod","kind":"identifier"},{"text":"(","kind":"text"},{"text":"by","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth014MyAccountErrorV","text":"MyAccountError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/deleteAuthenticationMethod(by:)","required":true,"abstract":[{"text":"Delete an authentication method associated with an id","type":"text"}],"url":"\/documentation\/auth0\/myaccountauthenticationmethods\/deleteauthenticationmethod(by:)"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/myaccountauthenticationmethods/enroll(passkey:challenge:).json b/docs/data/documentation/auth0/myaccountauthenticationmethods/enroll(passkey:challenge:).json index eb40223cf..5b4cc49c1 100644 --- a/docs/data/documentation/auth0/myaccountauthenticationmethods/enroll(passkey:challenge:).json +++ b/docs/data/documentation/auth0/myaccountauthenticationmethods/enroll(passkey:challenge:).json @@ -1 +1 @@ -{"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/enroll(passkey:challenge:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Enrolls a new passkey credential. This is the last part of the enrollment flow."}],"seeAlsoSections":[{"title":"Related Documentation","anchor":"Related-Documentation","identifiers":["https:\/\/developer.apple.com\/documentation\/authenticationservices\/supporting-passkeys#Register-a-new-account-on-a-service"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"enroll","kind":"identifier"},{"text":"(","kind":"text"},{"text":"passkey","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"NewPasskey","preciseIdentifier":"s:5Auth010NewPasskeyP","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/NewPasskey","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"challenge","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"PasskeyEnrollmentChallenge","preciseIdentifier":"s:5Auth026PasskeyEnrollmentChallengeV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"kind":"text","text":"<"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod","preciseIdentifier":"s:5Auth027PasskeyAuthenticationMethodV","kind":"typeIdentifier","text":"PasskeyAuthenticationMethod"},{"kind":"text","text":", "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","preciseIdentifier":"s:5Auth014MyAccountErrorV","kind":"typeIdentifier","text":"MyAccountError"},{"kind":"text","text":">"}],"platforms":["iOS"],"languages":["swift"]}]},{"parameters":[{"name":"passkey","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The new passkey credential obtained from the "},{"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","isActive":true},{"type":"text","text":" delegate."}]}]},{"name":"challenge","content":[{"type":"paragraph","inlineContent":[{"text":"The passkey enrollment challenge obtained from ","type":"text"},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/passkeyEnrollmentChallenge(userIdentityId:connection:)","isActive":true},{"text":".","type":"text"}]}]}],"kind":"parameters"},{"kind":"content","content":[{"text":"Return Value","type":"heading","anchor":"return-value","level":2},{"inlineContent":[{"text":"A request that will yield an enrolled passkey authentication method.","type":"text"}],"type":"paragraph"}]},{"kind":"content","content":[{"level":2,"type":"heading","text":"Availability","anchor":"Availability"},{"type":"paragraph","inlineContent":[{"text":"This feature is currently available in","type":"text"},{"text":" ","type":"text"},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","isActive":true},{"text":".","type":"text"},{"text":" ","type":"text"},{"text":"Please reach out to Auth0 support to get it enabled for your tenant.","type":"text"}]},{"level":2,"type":"heading","text":"Scopes Required","anchor":"Scopes-Required"},{"type":"paragraph","inlineContent":[{"type":"codeVoice","code":"create:me:authentication_methods"}]},{"level":2,"type":"heading","text":"Usage","anchor":"Usage"},{"type":"codeListing","syntax":"swift","code":["Auth0"," .myAccount(token: apiCredentials.accessToken)"," .authenticationMethods"," .enroll(passkey: newPasskey, challenge: enrollmentChallenge)"," .start { result in"," switch result {"," case .success(let authenticationMethod):"," print(\"Enrolled passkey: \\(authenticationMethod)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"]}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods"]]},"metadata":{"required":true,"modules":[{"name":"Auth0"}],"externalID":"s:5Auth030MyAccountAuthenticationMethodsP6enroll7passkey9challengeAA7RequestVyAA07PasskeyD6MethodVAA0bC5ErrorVGAA03NewJ0_p_AA0J19EnrollmentChallengeVtF","role":"symbol","title":"enroll(passkey:challenge:)","roleHeading":"Instance Method","platforms":[{"beta":false,"unavailable":false,"name":"iOS","introducedAt":"16.6","deprecated":false},{"beta":false,"unavailable":false,"name":"iPadOS","introducedAt":"16.6","deprecated":false},{"beta":false,"unavailable":false,"name":"Mac Catalyst","introducedAt":"16.6","deprecated":false},{"beta":false,"unavailable":false,"name":"macOS","introducedAt":"13.5","deprecated":false},{"beta":false,"unavailable":false,"name":"visionOS","introducedAt":"1.0","deprecated":false}],"symbolKind":"method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"enroll"},{"kind":"text","text":"("},{"kind":"externalParam","text":"passkey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth010NewPasskeyP","text":"NewPasskey"},{"kind":"text","text":", "},{"kind":"externalParam","text":"challenge"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth026PasskeyEnrollmentChallengeV","text":"PasskeyEnrollmentChallenge"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth027PasskeyAuthenticationMethodV","text":"PasskeyAuthenticationMethod"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth014MyAccountErrorV","text":"MyAccountError"},{"kind":"text","text":">"}]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/myaccountauthenticationmethods\/enroll(passkey:challenge:)"]}],"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods":{"url":"\/documentation\/auth0\/myaccountauthenticationmethods","kind":"symbol","type":"topic","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountAuthenticationMethods","kind":"identifier"}],"navigatorTitle":[{"text":"MyAccountAuthenticationMethods","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods","title":"MyAccountAuthenticationMethods","abstract":[{"type":"text","text":"My Account API sub-client for managing the current user’s authentication methods."}]},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyAuthenticationMethod":{"role":"symbol","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod","type":"topic","navigatorTitle":[{"text":"PasskeyAuthenticationMethod","kind":"identifier"}],"title":"PasskeyAuthenticationMethod","url":"\/documentation\/auth0\/passkeyauthenticationmethod","abstract":[{"text":"A passkey authentication method.","type":"text"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyAuthenticationMethod","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/request","kind":"symbol","abstract":[{"type":"text","text":"Auth0 API request."}]},"https://developer.apple.com/documentation/authenticationservices/asauthorizationcontrollerdelegate":{"type":"link","title":"ASAuthorizationControllerDelegate","url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","titleInlineContent":[{"type":"codeVoice","code":"ASAuthorizationControllerDelegate"}]},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyEnrollmentChallenge":{"title":"PasskeyEnrollmentChallenge","role":"symbol","url":"\/documentation\/auth0\/passkeyenrollmentchallenge","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyEnrollmentChallenge","kind":"identifier"}],"type":"topic","navigatorTitle":[{"text":"PasskeyEnrollmentChallenge","kind":"identifier"}],"abstract":[{"type":"text","text":"A passkey enrollment challenge."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge","kind":"symbol"},"https://developer.apple.com/documentation/authenticationservices/asauthorizationplatformpublickeycredentialregistration":{"titleInlineContent":[{"code":"ASAuthorizationPlatformPublicKeyCredentialRegistration","type":"codeVoice"}],"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialregistration","title":"ASAuthorizationPlatformPublicKeyCredentialRegistration","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialregistration","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods/passkeyEnrollmentChallenge(userIdentityId:connection:)":{"type":"topic","title":"passkeyEnrollmentChallenge(userIdentityId:connection:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/passkeyEnrollmentChallenge(userIdentityId:connection:)","required":true,"role":"symbol","abstract":[{"type":"text","text":"Requests a challenge for enrolling a new passkey. This is the first part of the enrollment flow."}],"defaultImplementations":1,"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"passkeyEnrollmentChallenge"},{"kind":"text","text":"("},{"kind":"externalParam","text":"userIdentityId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth026PasskeyEnrollmentChallengeV","text":"PasskeyEnrollmentChallenge"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth014MyAccountErrorV","text":"MyAccountError"},{"kind":"text","text":">"}],"url":"\/documentation\/auth0\/myaccountauthenticationmethods\/passkeyenrollmentchallenge(useridentityid:connection:)"},"https://developer.apple.com/documentation/authenticationservices/supporting-passkeys#Register-a-new-account-on-a-service":{"titleInlineContent":[{"text":"Supporting passkeys","type":"text"}],"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/supporting-passkeys#Register-a-new-account-on-a-service","title":"Supporting passkeys","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/supporting-passkeys#Register-a-new-account-on-a-service","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","type":"topic","kind":"symbol","abstract":[{"text":"Represents an error during a request to the Auth0 My Account API.","type":"text"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountError","kind":"identifier"}],"navigatorTitle":[{"text":"MyAccountError","kind":"identifier"}],"url":"\/documentation\/auth0\/myaccounterror","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/NewPasskey":{"role":"symbol","title":"NewPasskey","abstract":[{"text":"The signup passkey credential obtained from the ","type":"text"},{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","isActive":true,"type":"reference"},{"text":" delegate.","type":"text"},{"text":" ","type":"text"},{"text":"Contains the subset of relevant properties from ","type":"text"},{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialregistration","isActive":true,"type":"reference"},{"text":".","type":"text"}],"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/newpasskey","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/NewPasskey","navigatorTitle":[{"text":"NewPasskey","kind":"identifier"}],"fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"NewPasskey","kind":"identifier"}]},"https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access":{"type":"link","title":"Early Access","url":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","titleInlineContent":[{"type":"text","text":"Early Access"}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods/enroll(passkey:challenge:)":{"type":"topic","title":"enroll(passkey:challenge:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/enroll(passkey:challenge:)","required":true,"role":"symbol","abstract":[{"text":"Enrolls a new passkey credential. This is the last part of the enrollment flow.","type":"text"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"enroll","kind":"identifier"},{"text":"(","kind":"text"},{"text":"passkey","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"NewPasskey","kind":"typeIdentifier","preciseIdentifier":"s:5Auth010NewPasskeyP"},{"text":", ","kind":"text"},{"text":"challenge","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"PasskeyEnrollmentChallenge","kind":"typeIdentifier","preciseIdentifier":"s:5Auth026PasskeyEnrollmentChallengeV"},{"text":") -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"PasskeyAuthenticationMethod","kind":"typeIdentifier","preciseIdentifier":"s:5Auth027PasskeyAuthenticationMethodV"},{"text":", ","kind":"text"},{"text":"MyAccountError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth014MyAccountErrorV"},{"text":">","kind":"text"}],"url":"\/documentation\/auth0\/myaccountauthenticationmethods\/enroll(passkey:challenge:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/myaccountauthenticationmethods\/enroll(passkey:challenge:)"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods"]]},"abstract":[{"text":"Enrolls a new passkey credential. This is the last part of the enrollment flow.","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"enroll"},{"kind":"text","text":"("},{"kind":"externalParam","text":"passkey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"NewPasskey","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/NewPasskey","preciseIdentifier":"s:5Auth010NewPasskeyP"},{"kind":"text","text":", "},{"kind":"externalParam","text":"challenge"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"PasskeyEnrollmentChallenge","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge","preciseIdentifier":"s:5Auth026PasskeyEnrollmentChallengeV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"PasskeyAuthenticationMethod","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod","preciseIdentifier":"s:5Auth027PasskeyAuthenticationMethodV"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"MyAccountError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","preciseIdentifier":"s:5Auth014MyAccountErrorV"},{"kind":"text","text":">"}],"platforms":["iOS"]}]},{"parameters":[{"content":[{"type":"paragraph","inlineContent":[{"text":"The new passkey credential obtained from the ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate"},{"text":" delegate.","type":"text"}]}],"name":"passkey"},{"content":[{"inlineContent":[{"type":"text","text":"The passkey enrollment challenge obtained from "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/passkeyEnrollmentChallenge(userIdentityId:connection:)"},{"type":"text","text":"."}],"type":"paragraph"}],"name":"challenge"}],"kind":"parameters"},{"kind":"content","content":[{"text":"Return Value","level":2,"anchor":"return-value","type":"heading"},{"inlineContent":[{"type":"text","text":"A request that will yield an enrolled passkey authentication method."}],"type":"paragraph"}]},{"kind":"content","content":[{"anchor":"Availability","type":"heading","level":2,"text":"Availability"},{"inlineContent":[{"type":"text","text":"This feature is currently available in"},{"type":"text","text":" "},{"type":"reference","isActive":true,"identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access"},{"type":"text","text":"."},{"type":"text","text":" "},{"type":"text","text":"Please reach out to Auth0 support to get it enabled for your tenant."}],"type":"paragraph"},{"anchor":"Scopes-Required","type":"heading","level":2,"text":"Scopes Required"},{"inlineContent":[{"type":"codeVoice","code":"create:me:authentication_methods"}],"type":"paragraph"},{"anchor":"Usage","type":"heading","level":2,"text":"Usage"},{"type":"codeListing","code":["Auth0"," .myAccount(token: apiCredentials.accessToken)"," .authenticationMethods"," .enroll(passkey: newPasskey, challenge: enrollmentChallenge)"," .start { result in"," switch result {"," case .success(let authenticationMethod):"," print(\"Enrolled passkey: \\(authenticationMethod)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"],"syntax":"swift"}]}],"kind":"symbol","sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"seeAlsoSections":[{"identifiers":["https:\/\/developer.apple.com\/documentation\/authenticationservices\/supporting-passkeys#Register-a-new-account-on-a-service"],"anchor":"Related-Documentation","title":"Related Documentation"}],"metadata":{"externalID":"s:5Auth030MyAccountAuthenticationMethodsP6enroll7passkey9challengeAA7RequestVyAA07PasskeyD6MethodVAA0bC5ErrorVGAA03NewJ0_p_AA0J19EnrollmentChallengeVtF","platforms":[{"introducedAt":"16.6","unavailable":false,"name":"iOS","beta":false,"deprecated":false},{"introducedAt":"16.6","unavailable":false,"name":"iPadOS","beta":false,"deprecated":false},{"introducedAt":"16.6","unavailable":false,"name":"Mac Catalyst","beta":false,"deprecated":false},{"introducedAt":"13.5","unavailable":false,"name":"macOS","beta":false,"deprecated":false},{"introducedAt":"1.0","unavailable":false,"name":"visionOS","beta":false,"deprecated":false}],"symbolKind":"method","title":"enroll(passkey:challenge:)","required":true,"role":"symbol","roleHeading":"Instance Method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"enroll","kind":"identifier"},{"text":"(","kind":"text"},{"text":"passkey","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"NewPasskey","preciseIdentifier":"s:5Auth010NewPasskeyP","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"challenge","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"PasskeyEnrollmentChallenge","preciseIdentifier":"s:5Auth026PasskeyEnrollmentChallengeV","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"PasskeyAuthenticationMethod","preciseIdentifier":"s:5Auth027PasskeyAuthenticationMethodV","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"MyAccountError","preciseIdentifier":"s:5Auth014MyAccountErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"modules":[{"name":"Auth0"}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/enroll(passkey:challenge:)"},"references":{"https://developer.apple.com/documentation/authenticationservices/asauthorizationplatformpublickeycredentialregistration":{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialregistration","type":"link","title":"ASAuthorizationPlatformPublicKeyCredentialRegistration","titleInlineContent":[{"type":"codeVoice","code":"ASAuthorizationPlatformPublicKeyCredentialRegistration"}],"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialregistration"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyAuthenticationMethod":{"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyAuthenticationMethod","kind":"identifier"}],"navigatorTitle":[{"text":"PasskeyAuthenticationMethod","kind":"identifier"}],"title":"PasskeyAuthenticationMethod","type":"topic","role":"symbol","abstract":[{"type":"text","text":"A passkey authentication method."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod","url":"\/documentation\/auth0\/passkeyauthenticationmethod"},"https://developer.apple.com/documentation/authenticationservices/asauthorizationcontrollerdelegate":{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","type":"link","title":"ASAuthorizationControllerDelegate","titleInlineContent":[{"code":"ASAuthorizationControllerDelegate","type":"codeVoice"}],"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"title":"Request","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"abstract":[{"text":"Auth0 API request.","type":"text"}],"url":"\/documentation\/auth0\/request","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccountError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 My Account API."}],"url":"\/documentation\/auth0\/myaccounterror","navigatorTitle":[{"kind":"identifier","text":"MyAccountError"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/NewPasskey":{"title":"NewPasskey","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/NewPasskey","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"NewPasskey"}],"abstract":[{"type":"text","text":"The signup passkey credential obtained from the "},{"isActive":true,"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate"},{"type":"text","text":" delegate."},{"type":"text","text":" "},{"type":"text","text":"Contains the subset of relevant properties from "},{"isActive":true,"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialregistration"},{"type":"text","text":"."}],"url":"\/documentation\/auth0\/newpasskey","navigatorTitle":[{"kind":"identifier","text":"NewPasskey"}]},"https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access":{"identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","url":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","titleInlineContent":[{"type":"text","text":"Early Access"}],"type":"link","title":"Early Access"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods/enroll(passkey:challenge:)":{"kind":"symbol","title":"enroll(passkey:challenge:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"enroll","kind":"identifier"},{"text":"(","kind":"text"},{"text":"passkey","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"NewPasskey","preciseIdentifier":"s:5Auth010NewPasskeyP","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"challenge","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth026PasskeyEnrollmentChallengeV","kind":"typeIdentifier","text":"PasskeyEnrollmentChallenge"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth027PasskeyAuthenticationMethodV","text":"PasskeyAuthenticationMethod"},{"kind":"text","text":", "},{"text":"MyAccountError","preciseIdentifier":"s:5Auth014MyAccountErrorV","kind":"typeIdentifier"},{"kind":"text","text":">"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/enroll(passkey:challenge:)","required":true,"abstract":[{"type":"text","text":"Enrolls a new passkey credential. This is the last part of the enrollment flow."}],"url":"\/documentation\/auth0\/myaccountauthenticationmethods\/enroll(passkey:challenge:)"},"https://developer.apple.com/documentation/authenticationservices/supporting-passkeys#Register-a-new-account-on-a-service":{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/supporting-passkeys#Register-a-new-account-on-a-service","url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/supporting-passkeys#Register-a-new-account-on-a-service","titleInlineContent":[{"type":"text","text":"Supporting passkeys"}],"type":"link","title":"Supporting passkeys"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods/passkeyEnrollmentChallenge(userIdentityId:connection:)":{"url":"\/documentation\/auth0\/myaccountauthenticationmethods\/passkeyenrollmentchallenge(useridentityid:connection:)","abstract":[{"type":"text","text":"Requests a challenge for enrolling a new passkey. This is the first part of the enrollment flow."}],"title":"passkeyEnrollmentChallenge(userIdentityId:connection:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"passkeyEnrollmentChallenge","kind":"identifier"},{"text":"(","kind":"text"},{"text":"userIdentityId","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?) -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"PasskeyEnrollmentChallenge","preciseIdentifier":"s:5Auth026PasskeyEnrollmentChallengeV","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"MyAccountError","preciseIdentifier":"s:5Auth014MyAccountErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/passkeyEnrollmentChallenge(userIdentityId:connection:)","required":true,"kind":"symbol","role":"symbol","defaultImplementations":1,"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods":{"role":"symbol","title":"MyAccountAuthenticationMethods","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"MyAccountAuthenticationMethods"}],"navigatorTitle":[{"text":"MyAccountAuthenticationMethods","kind":"identifier"}],"abstract":[{"type":"text","text":"My Account API sub-client for managing the current user’s authentication methods."}],"kind":"symbol","url":"\/documentation\/auth0\/myaccountauthenticationmethods","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyEnrollmentChallenge":{"role":"symbol","title":"PasskeyEnrollmentChallenge","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyEnrollmentChallenge","kind":"identifier"}],"navigatorTitle":[{"text":"PasskeyEnrollmentChallenge","kind":"identifier"}],"abstract":[{"type":"text","text":"A passkey enrollment challenge."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge","url":"\/documentation\/auth0\/passkeyenrollmentchallenge","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/myaccountauthenticationmethods/enrollemail(emailaddress:).json b/docs/data/documentation/auth0/myaccountauthenticationmethods/enrollemail(emailaddress:).json index 1cdcc2e88..72d83f901 100644 --- a/docs/data/documentation/auth0/myaccountauthenticationmethods/enrollemail(emailaddress:).json +++ b/docs/data/documentation/auth0/myaccountauthenticationmethods/enrollemail(emailaddress:).json @@ -1 +1 @@ -{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/enrollEmail(emailAddress:)"},"sections":[],"metadata":{"modules":[{"name":"Auth0"}],"title":"enrollEmail(emailAddress:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"enrollEmail","kind":"identifier"},{"text":"(","kind":"text"},{"text":"emailAddress","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"EmailEnrollmentChallenge","kind":"typeIdentifier","preciseIdentifier":"s:5Auth024EmailEnrollmentChallengeV"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth014MyAccountErrorV","text":"MyAccountError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"symbolKind":"method","externalID":"s:5Auth030MyAccountAuthenticationMethodsP11enrollEmail12emailAddressAA7RequestVyAA0G19EnrollmentChallengeVAA0bC5ErrorVGSS_tF","roleHeading":"Instance Method","required":true},"kind":"symbol","abstract":[{"type":"text","text":"Requests a challenge for enrolling a Email authentication method. This is the first part of the enrollment flow."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods"]]},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"enrollEmail"},{"kind":"text","text":"("},{"kind":"externalParam","text":"emailAddress"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier","text":"Request"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:5Auth024EmailEnrollmentChallengeV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/EmailEnrollmentChallenge","kind":"typeIdentifier","text":"EmailEnrollmentChallenge"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth014MyAccountErrorV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","text":"MyAccountError"},{"kind":"text","text":">"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"},{"parameters":[{"content":[{"type":"paragraph","inlineContent":[{"text":"The email address to use for sending one-time codes.","type":"text"}]}],"name":"emailAddress"}],"kind":"parameters"},{"kind":"content","content":[{"type":"heading","anchor":"return-value","text":"Return Value","level":2},{"type":"paragraph","inlineContent":[{"text":"A request that will yield a email enrolment challenge","type":"text"}]}]},{"kind":"content","content":[{"text":"Availability","type":"heading","level":2,"anchor":"Availability"},{"type":"paragraph","inlineContent":[{"text":"This feature is currently available in","type":"text"},{"text":" ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","isActive":true,"type":"reference"},{"text":".","type":"text"},{"text":" ","type":"text"},{"text":"Please reach out to Auth0 support to get it enabled for your tenant.","type":"text"}]},{"text":"Scopes Required","type":"heading","level":2,"anchor":"Scopes-Required"},{"type":"paragraph","inlineContent":[{"type":"codeVoice","code":"create:me:authentication_methods"}]},{"text":"Usage","type":"heading","level":2,"anchor":"Usage"},{"type":"codeListing","syntax":"swift","code":["Auth0"," .myAccount(token: apiCredentials.accessToken)"," .authenticationMethods"," .enrollEmail(emailAddress: emailAddress)"," .start { result in"," switch result {"," case .success(let enrollmentChallenge):"," print(\"Enrolled enrollment challenge: \\(enrollmentChallenge)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"]}]}],"schemaVersion":{"major":0,"patch":0,"minor":3},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/myaccountauthenticationmethods\/enrollemail(emailaddress:)"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","type":"topic","kind":"symbol","abstract":[{"text":"Represents an error during a request to the Auth0 My Account API.","type":"text"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountError","kind":"identifier"}],"navigatorTitle":[{"text":"MyAccountError","kind":"identifier"}],"url":"\/documentation\/auth0\/myaccounterror","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods/enrollEmail(emailAddress:)":{"title":"enrollEmail(emailAddress:)","abstract":[{"text":"Requests a challenge for enrolling a Email authentication method. This is the first part of the enrollment flow.","type":"text"}],"role":"symbol","kind":"symbol","type":"topic","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"enrollEmail","kind":"identifier"},{"text":"(","kind":"text"},{"text":"emailAddress","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"EmailEnrollmentChallenge","kind":"typeIdentifier","preciseIdentifier":"s:5Auth024EmailEnrollmentChallengeV"},{"text":", ","kind":"text"},{"text":"MyAccountError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth014MyAccountErrorV"},{"text":">","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/enrollEmail(emailAddress:)","required":true,"url":"\/documentation\/auth0\/myaccountauthenticationmethods\/enrollemail(emailaddress:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods":{"url":"\/documentation\/auth0\/myaccountauthenticationmethods","kind":"symbol","type":"topic","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountAuthenticationMethods","kind":"identifier"}],"navigatorTitle":[{"text":"MyAccountAuthenticationMethods","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods","title":"MyAccountAuthenticationMethods","abstract":[{"type":"text","text":"My Account API sub-client for managing the current user’s authentication methods."}]},"https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access":{"type":"link","title":"Early Access","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","url":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","titleInlineContent":[{"text":"Early Access","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/EmailEnrollmentChallenge":{"title":"EmailEnrollmentChallenge","navigatorTitle":[{"text":"EmailEnrollmentChallenge","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/EmailEnrollmentChallenge","role":"symbol","abstract":[{"text":"A Email enrollment challenge.","type":"text"}],"type":"topic","url":"\/documentation\/auth0\/emailenrollmentchallenge","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"EmailEnrollmentChallenge","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/request","kind":"symbol","abstract":[{"type":"text","text":"Auth0 API request."}]}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/myaccountauthenticationmethods\/enrollemail(emailaddress:)"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods"]]},"abstract":[{"type":"text","text":"Requests a challenge for enrolling a Email authentication method. This is the first part of the enrollment flow."}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"enrollEmail"},{"kind":"text","text":"("},{"kind":"externalParam","text":"emailAddress"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/EmailEnrollmentChallenge","kind":"typeIdentifier","text":"EmailEnrollmentChallenge","preciseIdentifier":"s:5Auth024EmailEnrollmentChallengeV"},{"kind":"text","text":", "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","kind":"typeIdentifier","text":"MyAccountError","preciseIdentifier":"s:5Auth014MyAccountErrorV"},{"kind":"text","text":">"}]}],"kind":"declarations"},{"parameters":[{"content":[{"inlineContent":[{"text":"The email address to use for sending one-time codes.","type":"text"}],"type":"paragraph"}],"name":"emailAddress"}],"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 email enrolment challenge"}]}],"kind":"content"},{"content":[{"level":2,"type":"heading","anchor":"Availability","text":"Availability"},{"type":"paragraph","inlineContent":[{"type":"text","text":"This feature is currently available in"},{"type":"text","text":" "},{"identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","type":"reference","isActive":true},{"type":"text","text":"."},{"type":"text","text":" "},{"type":"text","text":"Please reach out to Auth0 support to get it enabled for your tenant."}]},{"level":2,"type":"heading","anchor":"Scopes-Required","text":"Scopes Required"},{"type":"paragraph","inlineContent":[{"code":"create:me:authentication_methods","type":"codeVoice"}]},{"level":2,"type":"heading","anchor":"Usage","text":"Usage"},{"type":"codeListing","syntax":"swift","code":["Auth0"," .myAccount(token: apiCredentials.accessToken)"," .authenticationMethods"," .enrollEmail(emailAddress: emailAddress)"," .start { result in"," switch result {"," case .success(let enrollmentChallenge):"," print(\"Enrolled enrollment challenge: \\(enrollmentChallenge)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"]}],"kind":"content"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","sections":[],"metadata":{"externalID":"s:5Auth030MyAccountAuthenticationMethodsP11enrollEmail12emailAddressAA7RequestVyAA0G19EnrollmentChallengeVAA0bC5ErrorVGSS_tF","symbolKind":"method","title":"enrollEmail(emailAddress:)","required":true,"roleHeading":"Instance Method","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"enrollEmail"},{"kind":"text","text":"("},{"kind":"externalParam","text":"emailAddress"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth024EmailEnrollmentChallengeV","text":"EmailEnrollmentChallenge"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth014MyAccountErrorV","text":"MyAccountError"},{"kind":"text","text":">"}],"modules":[{"name":"Auth0"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/enrollEmail(emailAddress:)","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods/enrollEmail(emailAddress:)":{"url":"\/documentation\/auth0\/myaccountauthenticationmethods\/enrollemail(emailaddress:)","title":"enrollEmail(emailAddress:)","abstract":[{"type":"text","text":"Requests a challenge for enrolling a Email authentication method. This is the first part of the enrollment flow."}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"enrollEmail"},{"kind":"text","text":"("},{"kind":"externalParam","text":"emailAddress"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:5Auth024EmailEnrollmentChallengeV","kind":"typeIdentifier","text":"EmailEnrollmentChallenge"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth014MyAccountErrorV","kind":"typeIdentifier","text":"MyAccountError"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/enrollEmail(emailAddress:)","required":true,"kind":"symbol","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods":{"role":"symbol","title":"MyAccountAuthenticationMethods","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"MyAccountAuthenticationMethods"}],"navigatorTitle":[{"text":"MyAccountAuthenticationMethods","kind":"identifier"}],"abstract":[{"type":"text","text":"My Account API sub-client for managing the current user’s authentication methods."}],"kind":"symbol","url":"\/documentation\/auth0\/myaccountauthenticationmethods","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"title":"Request","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"abstract":[{"text":"Auth0 API request.","type":"text"}],"url":"\/documentation\/auth0\/request","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access":{"title":"Early Access","url":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","type":"link","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","titleInlineContent":[{"type":"text","text":"Early Access"}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccountError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 My Account API."}],"url":"\/documentation\/auth0\/myaccounterror","navigatorTitle":[{"kind":"identifier","text":"MyAccountError"}]},"doc://com.auth0.Auth0/documentation/Auth0/EmailEnrollmentChallenge":{"title":"EmailEnrollmentChallenge","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/EmailEnrollmentChallenge","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"EmailEnrollmentChallenge"}],"abstract":[{"text":"A Email enrollment challenge.","type":"text"}],"url":"\/documentation\/auth0\/emailenrollmentchallenge","navigatorTitle":[{"kind":"identifier","text":"EmailEnrollmentChallenge"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/myaccountauthenticationmethods/enrollphone(phonenumber:preferredauthenticationmethod:)-7jrdw.json b/docs/data/documentation/auth0/myaccountauthenticationmethods/enrollphone(phonenumber:preferredauthenticationmethod:)-7jrdw.json index 326109339..bab359fb1 100644 --- a/docs/data/documentation/auth0/myaccountauthenticationmethods/enrollphone(phonenumber:preferredauthenticationmethod:)-7jrdw.json +++ b/docs/data/documentation/auth0/myaccountauthenticationmethods/enrollphone(phonenumber:preferredauthenticationmethod:)-7jrdw.json @@ -1 +1 @@ -{"abstract":[{"text":"Requests a challenge for enrolling a Phone authentication method. This is the first part of the enrollment flow.","type":"text"}],"variants":[{"paths":["\/documentation\/auth0\/myaccountauthenticationmethods\/enrollphone(phonenumber:preferredauthenticationmethod:)-7jrdw"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"enrollPhone","kind":"identifier"},{"text":"(","kind":"text"},{"text":"phoneNumber","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"preferredAuthenticationMethod","kind":"externalParam"},{"text":": ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod","text":"PreferredAuthenticationMethod","preciseIdentifier":"s:5Auth029PreferredAuthenticationMethodO","kind":"typeIdentifier"},{"kind":"text","text":"? = nil) -> "},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PhoneEnrollmentChallenge","preciseIdentifier":"s:5Auth024PhoneEnrollmentChallengeV","text":"PhoneEnrollmentChallenge"},{"kind":"text","text":", "},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","preciseIdentifier":"s:5Auth014MyAccountErrorV","text":"MyAccountError"},{"kind":"text","text":">"}],"platforms":["iOS"],"languages":["swift"]}]},{"parameters":[{"name":"phoneNumber","content":[{"type":"paragraph","inlineContent":[{"text":"The destination phone number used to send verification codes via text and voice.","type":"text"}]}]},{"name":"preferredAuthenticationMethod","content":[{"type":"paragraph","inlineContent":[{"text":"The preferred communication method(sms). If no value is passed by default sms will be the preferred authentication method","type":"text"}]}]}],"kind":"parameters"},{"kind":"content","content":[{"level":2,"text":"Return Value","type":"heading","anchor":"return-value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A request that will yield a phone enrollment challenge"}]}]},{"kind":"content","content":[{"text":"Availability","level":2,"type":"heading","anchor":"Availability"},{"type":"paragraph","inlineContent":[{"text":"This feature is currently available in","type":"text"},{"text":" ","type":"text"},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","isActive":true},{"text":".","type":"text"},{"text":" ","type":"text"},{"text":"Please reach out to Auth0 support to get it enabled for your tenant.","type":"text"}]},{"text":"Scopes Required","level":2,"type":"heading","anchor":"Scopes-Required"},{"type":"paragraph","inlineContent":[{"code":"create:me:authentication_methods","type":"codeVoice"}]},{"text":"Usage","level":2,"type":"heading","anchor":"Usage"},{"syntax":"swift","type":"codeListing","code":["Auth0"," .myAccount(token: apiCredentials.accessToken)"," .authenticationMethods"," .enrollPhone(phoneNumber: phoneNumber, preferredAuthenticationMethod: preferredAuthenticationMethod)"," .start { result in"," switch result {"," case .success(let enrollmentChallenge):"," print(\"Obtained enrollment challenge: \\(enrollmentChallenge)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"]}]}],"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/enrollPhone(phoneNumber:preferredAuthenticationMethod:)-7jrdw","interfaceLanguage":"swift"},"sections":[],"metadata":{"extendedModule":"Auth0","externalID":"s:5Auth030MyAccountAuthenticationMethodsPAAE11enrollPhone11phoneNumber09preferredD6MethodAA7RequestVyAA0G19EnrollmentChallengeVAA0bC5ErrorVGSS_AA09PreferreddK0OSgtF","title":"enrollPhone(phoneNumber:preferredAuthenticationMethod:)","symbolKind":"method","modules":[{"name":"Auth0"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"enrollPhone","kind":"identifier"},{"text":"(","kind":"text"},{"text":"phoneNumber","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"preferredAuthenticationMethod","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth029PreferredAuthenticationMethodO","kind":"typeIdentifier","text":"PreferredAuthenticationMethod"},{"kind":"text","text":"?) -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:5Auth024PhoneEnrollmentChallengeV","kind":"typeIdentifier","text":"PhoneEnrollmentChallenge"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth014MyAccountErrorV","kind":"typeIdentifier","text":"MyAccountError"},{"kind":"text","text":">"}],"roleHeading":"Instance Method","role":"symbol"},"schemaVersion":{"minor":3,"patch":0,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","type":"topic","kind":"symbol","abstract":[{"text":"Represents an error during a request to the Auth0 My Account API.","type":"text"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountError","kind":"identifier"}],"navigatorTitle":[{"text":"MyAccountError","kind":"identifier"}],"url":"\/documentation\/auth0\/myaccounterror","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/PreferredAuthenticationMethod":{"abstract":[],"role":"symbol","url":"\/documentation\/auth0\/preferredauthenticationmethod","title":"PreferredAuthenticationMethod","navigatorTitle":[{"kind":"identifier","text":"PreferredAuthenticationMethod"}],"type":"topic","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PreferredAuthenticationMethod"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods/enrollPhone(phoneNumber:preferredAuthenticationMethod:)-7jrdw":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/enrollPhone(phoneNumber:preferredAuthenticationMethod:)-7jrdw","url":"\/documentation\/auth0\/myaccountauthenticationmethods\/enrollphone(phonenumber:preferredauthenticationmethod:)-7jrdw","role":"symbol","title":"enrollPhone(phoneNumber:preferredAuthenticationMethod:)","type":"topic","abstract":[{"type":"text","text":"Requests a challenge for enrolling a Phone authentication method. This is the first part of the enrollment flow."}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"enrollPhone","kind":"identifier"},{"text":"(","kind":"text"},{"text":"phoneNumber","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"preferredAuthenticationMethod","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth029PreferredAuthenticationMethodO","text":"PreferredAuthenticationMethod","kind":"typeIdentifier"},{"text":"?) -> ","kind":"text"},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"PhoneEnrollmentChallenge","preciseIdentifier":"s:5Auth024PhoneEnrollmentChallengeV"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"MyAccountError","preciseIdentifier":"s:5Auth014MyAccountErrorV"},{"kind":"text","text":">"}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods":{"url":"\/documentation\/auth0\/myaccountauthenticationmethods","kind":"symbol","type":"topic","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountAuthenticationMethods","kind":"identifier"}],"navigatorTitle":[{"text":"MyAccountAuthenticationMethods","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods","title":"MyAccountAuthenticationMethods","abstract":[{"type":"text","text":"My Account API sub-client for managing the current user’s authentication methods."}]},"doc://com.auth0.Auth0/documentation/Auth0/PhoneEnrollmentChallenge":{"navigatorTitle":[{"kind":"identifier","text":"PhoneEnrollmentChallenge"}],"type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"PhoneEnrollmentChallenge"}],"kind":"symbol","role":"symbol","abstract":[{"text":"A Phone enrollment challenge.","type":"text"}],"url":"\/documentation\/auth0\/phoneenrollmentchallenge","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PhoneEnrollmentChallenge","title":"PhoneEnrollmentChallenge"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/request","kind":"symbol","abstract":[{"type":"text","text":"Auth0 API request."}]},"https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access":{"url":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","type":"link","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","titleInlineContent":[{"text":"Early Access","type":"text"}],"title":"Early Access"}}} \ No newline at end of file +{"abstract":[{"type":"text","text":"Requests a challenge for enrolling a Phone authentication method. This is the first part of the enrollment flow."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"enrollPhone","kind":"identifier"},{"text":"(","kind":"text"},{"text":"phoneNumber","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"preferredAuthenticationMethod","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"PreferredAuthenticationMethod","preciseIdentifier":"s:5Auth029PreferredAuthenticationMethodO","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod"},{"text":"? = nil) -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"},{"text":"<","kind":"text"},{"text":"PhoneEnrollmentChallenge","preciseIdentifier":"s:5Auth024PhoneEnrollmentChallengeV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PhoneEnrollmentChallenge"},{"text":", ","kind":"text"},{"text":"MyAccountError","preciseIdentifier":"s:5Auth014MyAccountErrorV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError"},{"text":">","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]},{"parameters":[{"name":"phoneNumber","content":[{"inlineContent":[{"text":"The destination phone number used to send verification codes via text and voice.","type":"text"}],"type":"paragraph"}]},{"name":"preferredAuthenticationMethod","content":[{"inlineContent":[{"text":"The preferred communication method(sms). If no value is passed by default sms will be the preferred authentication method","type":"text"}],"type":"paragraph"}]}],"kind":"parameters"},{"kind":"content","content":[{"type":"heading","text":"Return Value","anchor":"return-value","level":2},{"type":"paragraph","inlineContent":[{"text":"A request that will yield a phone enrollment challenge","type":"text"}]}]},{"kind":"content","content":[{"type":"heading","text":"Availability","anchor":"Availability","level":2},{"type":"paragraph","inlineContent":[{"text":"This feature is currently available in","type":"text"},{"text":" ","type":"text"},{"isActive":true,"identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","type":"reference"},{"text":".","type":"text"},{"text":" ","type":"text"},{"text":"Please reach out to Auth0 support to get it enabled for your tenant.","type":"text"}]},{"type":"heading","text":"Scopes Required","anchor":"Scopes-Required","level":2},{"type":"paragraph","inlineContent":[{"code":"create:me:authentication_methods","type":"codeVoice"}]},{"type":"heading","text":"Usage","anchor":"Usage","level":2},{"type":"codeListing","code":["Auth0"," .myAccount(token: apiCredentials.accessToken)"," .authenticationMethods"," .enrollPhone(phoneNumber: phoneNumber, preferredAuthenticationMethod: preferredAuthenticationMethod)"," .start { result in"," switch result {"," case .success(let enrollmentChallenge):"," print(\"Obtained enrollment challenge: \\(enrollmentChallenge)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"],"syntax":"swift"}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/myaccountauthenticationmethods\/enrollphone(phonenumber:preferredauthenticationmethod:)-7jrdw"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods"]]},"metadata":{"modules":[{"name":"Auth0"}],"title":"enrollPhone(phoneNumber:preferredAuthenticationMethod:)","roleHeading":"Instance Method","symbolKind":"method","role":"symbol","extendedModule":"Auth0","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"enrollPhone","kind":"identifier"},{"text":"(","kind":"text"},{"text":"phoneNumber","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"preferredAuthenticationMethod","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth029PreferredAuthenticationMethodO","text":"PreferredAuthenticationMethod","kind":"typeIdentifier"},{"text":"?) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth024PhoneEnrollmentChallengeV","text":"PhoneEnrollmentChallenge","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth014MyAccountErrorV","text":"MyAccountError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"externalID":"s:5Auth030MyAccountAuthenticationMethodsPAAE11enrollPhone11phoneNumber09preferredD6MethodAA7RequestVyAA0G19EnrollmentChallengeVAA0bC5ErrorVGSS_AA09PreferreddK0OSgtF"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/enrollPhone(phoneNumber:preferredAuthenticationMethod:)-7jrdw"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/PhoneEnrollmentChallenge":{"url":"\/documentation\/auth0\/phoneenrollmentchallenge","title":"PhoneEnrollmentChallenge","abstract":[{"type":"text","text":"A Phone enrollment challenge."}],"navigatorTitle":[{"text":"PhoneEnrollmentChallenge","kind":"identifier"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"PhoneEnrollmentChallenge"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PhoneEnrollmentChallenge","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods":{"role":"symbol","title":"MyAccountAuthenticationMethods","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"MyAccountAuthenticationMethods"}],"navigatorTitle":[{"text":"MyAccountAuthenticationMethods","kind":"identifier"}],"abstract":[{"type":"text","text":"My Account API sub-client for managing the current user’s authentication methods."}],"kind":"symbol","url":"\/documentation\/auth0\/myaccountauthenticationmethods","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods","type":"topic"},"https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access":{"title":"Early Access","type":"link","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","titleInlineContent":[{"type":"text","text":"Early Access"}],"url":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PreferredAuthenticationMethod":{"url":"\/documentation\/auth0\/preferredauthenticationmethod","abstract":[],"title":"PreferredAuthenticationMethod","navigatorTitle":[{"text":"PreferredAuthenticationMethod","kind":"identifier"}],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PreferredAuthenticationMethod"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods/enrollPhone(phoneNumber:preferredAuthenticationMethod:)-7jrdw":{"url":"\/documentation\/auth0\/myaccountauthenticationmethods\/enrollphone(phonenumber:preferredauthenticationmethod:)-7jrdw","title":"enrollPhone(phoneNumber:preferredAuthenticationMethod:)","abstract":[{"text":"Requests a challenge for enrolling a Phone authentication method. This is the first part of the enrollment flow.","type":"text"}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"enrollPhone"},{"kind":"text","text":"("},{"kind":"externalParam","text":"phoneNumber"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"preferredAuthenticationMethod"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"PreferredAuthenticationMethod","preciseIdentifier":"s:5Auth029PreferredAuthenticationMethodO"},{"kind":"text","text":"?) -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"PhoneEnrollmentChallenge","preciseIdentifier":"s:5Auth024PhoneEnrollmentChallengeV"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"MyAccountError","preciseIdentifier":"s:5Auth014MyAccountErrorV"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/enrollPhone(phoneNumber:preferredAuthenticationMethod:)-7jrdw","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccountError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 My Account API."}],"url":"\/documentation\/auth0\/myaccounterror","navigatorTitle":[{"kind":"identifier","text":"MyAccountError"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"title":"Request","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"abstract":[{"text":"Auth0 API request.","type":"text"}],"url":"\/documentation\/auth0\/request","navigatorTitle":[{"kind":"identifier","text":"Request"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/myaccountauthenticationmethods/enrollphone(phonenumber:preferredauthenticationmethod:).json b/docs/data/documentation/auth0/myaccountauthenticationmethods/enrollphone(phonenumber:preferredauthenticationmethod:).json index 57a862ee8..2e101d63f 100644 --- a/docs/data/documentation/auth0/myaccountauthenticationmethods/enrollphone(phonenumber:preferredauthenticationmethod:).json +++ b/docs/data/documentation/auth0/myaccountauthenticationmethods/enrollphone(phonenumber:preferredauthenticationmethod:).json @@ -1 +1 @@ -{"sections":[],"defaultImplementationsSections":[{"title":"MyAccountAuthenticationMethods Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/enrollPhone(phoneNumber:preferredAuthenticationMethod:)-7jrdw"],"anchor":"MyAccountAuthenticationMethods-Implementations"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/myaccountauthenticationmethods\/enrollphone(phonenumber:preferredauthenticationmethod:)"]}],"metadata":{"externalID":"s:5Auth030MyAccountAuthenticationMethodsP11enrollPhone11phoneNumber09preferredD6MethodAA7RequestVyAA0G19EnrollmentChallengeVAA0bC5ErrorVGSS_AA09PreferreddK0OSgtF","required":true,"symbolKind":"method","modules":[{"name":"Auth0"}],"title":"enrollPhone(phoneNumber:preferredAuthenticationMethod:)","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"enrollPhone"},{"kind":"text","text":"("},{"kind":"externalParam","text":"phoneNumber"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"preferredAuthenticationMethod"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"PreferredAuthenticationMethod","preciseIdentifier":"s:5Auth029PreferredAuthenticationMethodO"},{"kind":"text","text":"?) -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"PhoneEnrollmentChallenge","preciseIdentifier":"s:5Auth024PhoneEnrollmentChallengeV"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"MyAccountError","preciseIdentifier":"s:5Auth014MyAccountErrorV"},{"kind":"text","text":">"}],"role":"symbol"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/enrollPhone(phoneNumber:preferredAuthenticationMethod:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Requests a challenge for enrolling a Phone authentication method. This is the first part of the enrollment flow."}],"primaryContentSections":[{"declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"enrollPhone","kind":"identifier"},{"text":"(","kind":"text"},{"text":"phoneNumber","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"preferredAuthenticationMethod","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"PreferredAuthenticationMethod","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod","preciseIdentifier":"s:5Auth029PreferredAuthenticationMethodO"},{"kind":"text","text":"?) -> "},{"kind":"typeIdentifier","text":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"PhoneEnrollmentChallenge","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PhoneEnrollmentChallenge","preciseIdentifier":"s:5Auth024PhoneEnrollmentChallengeV"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"MyAccountError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","preciseIdentifier":"s:5Auth014MyAccountErrorV"},{"kind":"text","text":">"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"},{"parameters":[{"content":[{"type":"paragraph","inlineContent":[{"text":"The destination phone number used to send verification codes via text and voice.","type":"text"}]}],"name":"phoneNumber"},{"content":[{"inlineContent":[{"type":"text","text":"The preferred communication method(sms). If no value is passed by default sms will be the preferred authentication method"}],"type":"paragraph"}],"name":"preferredAuthenticationMethod"}],"kind":"parameters"},{"kind":"content","content":[{"type":"heading","level":2,"text":"Return Value","anchor":"return-value"},{"type":"paragraph","inlineContent":[{"text":"A request that will yield a phone enrollment challenge","type":"text"}]}]},{"kind":"content","content":[{"text":"Availability","level":2,"type":"heading","anchor":"Availability"},{"inlineContent":[{"type":"text","text":"This feature is currently available in"},{"type":"text","text":" "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","isActive":true},{"type":"text","text":"."},{"type":"text","text":" "},{"type":"text","text":"Please reach out to Auth0 support to get it enabled for your tenant."}],"type":"paragraph"},{"text":"Scopes Required","level":2,"type":"heading","anchor":"Scopes-Required"},{"inlineContent":[{"type":"codeVoice","code":"create:me:authentication_methods"}],"type":"paragraph"},{"text":"Usage","level":2,"type":"heading","anchor":"Usage"},{"syntax":"swift","type":"codeListing","code":["Auth0"," .myAccount(token: apiCredentials.accessToken)"," .authenticationMethods"," .enrollPhone(phoneNumber: phoneNumber, preferredAuthenticationMethod: preferredAuthenticationMethod)"," .start { result in"," switch result {"," case .success(let enrollmentChallenge):"," print(\"Obtained enrollment challenge: \\(enrollmentChallenge)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"]}]}],"kind":"symbol","schemaVersion":{"patch":0,"minor":3,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PhoneEnrollmentChallenge":{"navigatorTitle":[{"kind":"identifier","text":"PhoneEnrollmentChallenge"}],"type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"PhoneEnrollmentChallenge"}],"kind":"symbol","role":"symbol","abstract":[{"text":"A Phone enrollment challenge.","type":"text"}],"url":"\/documentation\/auth0\/phoneenrollmentchallenge","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PhoneEnrollmentChallenge","title":"PhoneEnrollmentChallenge"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods":{"url":"\/documentation\/auth0\/myaccountauthenticationmethods","kind":"symbol","type":"topic","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountAuthenticationMethods","kind":"identifier"}],"navigatorTitle":[{"text":"MyAccountAuthenticationMethods","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods","title":"MyAccountAuthenticationMethods","abstract":[{"type":"text","text":"My Account API sub-client for managing the current user’s authentication methods."}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods/enrollPhone(phoneNumber:preferredAuthenticationMethod:)":{"defaultImplementations":1,"url":"\/documentation\/auth0\/myaccountauthenticationmethods\/enrollphone(phonenumber:preferredauthenticationmethod:)","title":"enrollPhone(phoneNumber:preferredAuthenticationMethod:)","type":"topic","required":true,"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"enrollPhone","kind":"identifier"},{"text":"(","kind":"text"},{"text":"phoneNumber","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"preferredAuthenticationMethod","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"PreferredAuthenticationMethod","preciseIdentifier":"s:5Auth029PreferredAuthenticationMethodO","kind":"typeIdentifier"},{"text":"?) -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"PhoneEnrollmentChallenge","preciseIdentifier":"s:5Auth024PhoneEnrollmentChallengeV","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"MyAccountError","preciseIdentifier":"s:5Auth014MyAccountErrorV"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/enrollPhone(phoneNumber:preferredAuthenticationMethod:)","kind":"symbol","abstract":[{"type":"text","text":"Requests a challenge for enrolling a Phone authentication method. This is the first part of the enrollment flow."}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/request","kind":"symbol","abstract":[{"type":"text","text":"Auth0 API request."}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","type":"topic","kind":"symbol","abstract":[{"text":"Represents an error during a request to the Auth0 My Account API.","type":"text"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountError","kind":"identifier"}],"navigatorTitle":[{"text":"MyAccountError","kind":"identifier"}],"url":"\/documentation\/auth0\/myaccounterror","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/PreferredAuthenticationMethod":{"abstract":[],"role":"symbol","url":"\/documentation\/auth0\/preferredauthenticationmethod","title":"PreferredAuthenticationMethod","navigatorTitle":[{"kind":"identifier","text":"PreferredAuthenticationMethod"}],"type":"topic","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PreferredAuthenticationMethod"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods/enrollPhone(phoneNumber:preferredAuthenticationMethod:)-7jrdw":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/enrollPhone(phoneNumber:preferredAuthenticationMethod:)-7jrdw","url":"\/documentation\/auth0\/myaccountauthenticationmethods\/enrollphone(phonenumber:preferredauthenticationmethod:)-7jrdw","role":"symbol","title":"enrollPhone(phoneNumber:preferredAuthenticationMethod:)","type":"topic","abstract":[{"type":"text","text":"Requests a challenge for enrolling a Phone authentication method. This is the first part of the enrollment flow."}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"enrollPhone","kind":"identifier"},{"text":"(","kind":"text"},{"text":"phoneNumber","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"preferredAuthenticationMethod","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth029PreferredAuthenticationMethodO","text":"PreferredAuthenticationMethod","kind":"typeIdentifier"},{"text":"?) -> ","kind":"text"},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"PhoneEnrollmentChallenge","preciseIdentifier":"s:5Auth024PhoneEnrollmentChallengeV"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"MyAccountError","preciseIdentifier":"s:5Auth014MyAccountErrorV"},{"kind":"text","text":">"}]},"https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access":{"identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","url":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","title":"Early Access","type":"link","titleInlineContent":[{"type":"text","text":"Early Access"}]}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods"]]},"metadata":{"symbolKind":"method","modules":[{"name":"Auth0"}],"title":"enrollPhone(phoneNumber:preferredAuthenticationMethod:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"enrollPhone","kind":"identifier"},{"text":"(","kind":"text"},{"text":"phoneNumber","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"preferredAuthenticationMethod","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"PreferredAuthenticationMethod","preciseIdentifier":"s:5Auth029PreferredAuthenticationMethodO","kind":"typeIdentifier"},{"text":"?) -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"PhoneEnrollmentChallenge","preciseIdentifier":"s:5Auth024PhoneEnrollmentChallengeV","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"MyAccountError","preciseIdentifier":"s:5Auth014MyAccountErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"externalID":"s:5Auth030MyAccountAuthenticationMethodsP11enrollPhone11phoneNumber09preferredD6MethodAA7RequestVyAA0G19EnrollmentChallengeVAA0bC5ErrorVGSS_AA09PreferreddK0OSgtF","required":true,"role":"symbol","roleHeading":"Instance Method"},"sections":[],"abstract":[{"text":"Requests a challenge for enrolling a Phone authentication method. This is the first part of the enrollment flow.","type":"text"}],"variants":[{"paths":["\/documentation\/auth0\/myaccountauthenticationmethods\/enrollphone(phonenumber:preferredauthenticationmethod:)"],"traits":[{"interfaceLanguage":"swift"}]}],"defaultImplementationsSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/enrollPhone(phoneNumber:preferredAuthenticationMethod:)-7jrdw"],"title":"MyAccountAuthenticationMethods Implementations","anchor":"MyAccountAuthenticationMethods-Implementations"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/enrollPhone(phoneNumber:preferredAuthenticationMethod:)","interfaceLanguage":"swift"},"kind":"symbol","schemaVersion":{"minor":3,"major":0,"patch":0},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"enrollPhone","kind":"identifier"},{"text":"(","kind":"text"},{"text":"phoneNumber","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"preferredAuthenticationMethod","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"PreferredAuthenticationMethod","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod","preciseIdentifier":"s:5Auth029PreferredAuthenticationMethodO","kind":"typeIdentifier"},{"text":"?) -> ","kind":"text"},{"text":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"PhoneEnrollmentChallenge","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PhoneEnrollmentChallenge","preciseIdentifier":"s:5Auth024PhoneEnrollmentChallengeV","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"MyAccountError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","preciseIdentifier":"s:5Auth014MyAccountErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"phoneNumber","content":[{"inlineContent":[{"type":"text","text":"The destination phone number used to send verification codes via text and voice."}],"type":"paragraph"}]},{"name":"preferredAuthenticationMethod","content":[{"inlineContent":[{"type":"text","text":"The preferred communication method(sms). If no value is passed by default sms will be the preferred authentication method"}],"type":"paragraph"}]}]},{"content":[{"level":2,"text":"Return Value","anchor":"return-value","type":"heading"},{"inlineContent":[{"text":"A request that will yield a phone enrollment challenge","type":"text"}],"type":"paragraph"}],"kind":"content"},{"content":[{"level":2,"text":"Availability","anchor":"Availability","type":"heading"},{"inlineContent":[{"text":"This feature is currently available in","type":"text"},{"text":" ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","isActive":true,"type":"reference"},{"text":".","type":"text"},{"text":" ","type":"text"},{"text":"Please reach out to Auth0 support to get it enabled for your tenant.","type":"text"}],"type":"paragraph"},{"level":2,"text":"Scopes Required","anchor":"Scopes-Required","type":"heading"},{"inlineContent":[{"code":"create:me:authentication_methods","type":"codeVoice"}],"type":"paragraph"},{"level":2,"text":"Usage","anchor":"Usage","type":"heading"},{"syntax":"swift","code":["Auth0"," .myAccount(token: apiCredentials.accessToken)"," .authenticationMethods"," .enrollPhone(phoneNumber: phoneNumber, preferredAuthenticationMethod: preferredAuthenticationMethod)"," .start { result in"," switch result {"," case .success(let enrollmentChallenge):"," print(\"Obtained enrollment challenge: \\(enrollmentChallenge)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"],"type":"codeListing"}],"kind":"content"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccountError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 My Account API."}],"url":"\/documentation\/auth0\/myaccounterror","navigatorTitle":[{"kind":"identifier","text":"MyAccountError"}]},"doc://com.auth0.Auth0/documentation/Auth0/PreferredAuthenticationMethod":{"url":"\/documentation\/auth0\/preferredauthenticationmethod","abstract":[],"title":"PreferredAuthenticationMethod","navigatorTitle":[{"text":"PreferredAuthenticationMethod","kind":"identifier"}],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PreferredAuthenticationMethod"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods/enrollPhone(phoneNumber:preferredAuthenticationMethod:)-7jrdw":{"url":"\/documentation\/auth0\/myaccountauthenticationmethods\/enrollphone(phonenumber:preferredauthenticationmethod:)-7jrdw","title":"enrollPhone(phoneNumber:preferredAuthenticationMethod:)","abstract":[{"text":"Requests a challenge for enrolling a Phone authentication method. This is the first part of the enrollment flow.","type":"text"}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"enrollPhone"},{"kind":"text","text":"("},{"kind":"externalParam","text":"phoneNumber"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"preferredAuthenticationMethod"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"PreferredAuthenticationMethod","preciseIdentifier":"s:5Auth029PreferredAuthenticationMethodO"},{"kind":"text","text":"?) -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"PhoneEnrollmentChallenge","preciseIdentifier":"s:5Auth024PhoneEnrollmentChallengeV"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"MyAccountError","preciseIdentifier":"s:5Auth014MyAccountErrorV"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/enrollPhone(phoneNumber:preferredAuthenticationMethod:)-7jrdw","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PhoneEnrollmentChallenge":{"url":"\/documentation\/auth0\/phoneenrollmentchallenge","title":"PhoneEnrollmentChallenge","abstract":[{"type":"text","text":"A Phone enrollment challenge."}],"navigatorTitle":[{"text":"PhoneEnrollmentChallenge","kind":"identifier"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"PhoneEnrollmentChallenge"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PhoneEnrollmentChallenge","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods":{"role":"symbol","title":"MyAccountAuthenticationMethods","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"MyAccountAuthenticationMethods"}],"navigatorTitle":[{"text":"MyAccountAuthenticationMethods","kind":"identifier"}],"abstract":[{"type":"text","text":"My Account API sub-client for managing the current user’s authentication methods."}],"kind":"symbol","url":"\/documentation\/auth0\/myaccountauthenticationmethods","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"title":"Request","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"abstract":[{"text":"Auth0 API request.","type":"text"}],"url":"\/documentation\/auth0\/request","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods/enrollPhone(phoneNumber:preferredAuthenticationMethod:)":{"url":"\/documentation\/auth0\/myaccountauthenticationmethods\/enrollphone(phonenumber:preferredauthenticationmethod:)","title":"enrollPhone(phoneNumber:preferredAuthenticationMethod:)","abstract":[{"text":"Requests a challenge for enrolling a Phone authentication method. This is the first part of the enrollment flow.","type":"text"}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"enrollPhone"},{"kind":"text","text":"("},{"kind":"externalParam","text":"phoneNumber"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"preferredAuthenticationMethod"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"PreferredAuthenticationMethod","preciseIdentifier":"s:5Auth029PreferredAuthenticationMethodO"},{"kind":"text","text":"?) -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"PhoneEnrollmentChallenge","preciseIdentifier":"s:5Auth024PhoneEnrollmentChallengeV"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"MyAccountError","preciseIdentifier":"s:5Auth014MyAccountErrorV"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/enrollPhone(phoneNumber:preferredAuthenticationMethod:)","required":true,"kind":"symbol","role":"symbol","defaultImplementations":1,"type":"topic"},"https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access":{"url":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","title":"Early Access","type":"link","titleInlineContent":[{"text":"Early Access","type":"text"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/myaccountauthenticationmethods/enrollpushnotification().json b/docs/data/documentation/auth0/myaccountauthenticationmethods/enrollpushnotification().json index ff0f8c548..2133221c3 100644 --- a/docs/data/documentation/auth0/myaccountauthenticationmethods/enrollpushnotification().json +++ b/docs/data/documentation/auth0/myaccountauthenticationmethods/enrollpushnotification().json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"enrollPushNotification"},{"kind":"text","text":"() -> "},{"preciseIdentifier":"s:5Auth07RequestV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier","text":"Request"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:5Auth023PushEnrollmentChallengeV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge","kind":"typeIdentifier","text":"PushEnrollmentChallenge"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth014MyAccountErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","kind":"typeIdentifier","text":"MyAccountError"},{"kind":"text","text":">"}],"platforms":["iOS"]}]},{"kind":"content","content":[{"level":2,"anchor":"return-value","text":"Return Value","type":"heading"},{"inlineContent":[{"type":"text","text":"A request that will yield a push notification enrolment challenge"}],"type":"paragraph"}]},{"kind":"content","content":[{"text":"Availability","anchor":"Availability","level":2,"type":"heading"},{"inlineContent":[{"type":"text","text":"This feature is currently available in"},{"type":"text","text":" "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","isActive":true},{"type":"text","text":"."},{"type":"text","text":" "},{"type":"text","text":"Please reach out to Auth0 support to get it enabled for your tenant."}],"type":"paragraph"},{"text":"Scopes Required","anchor":"Scopes-Required","level":2,"type":"heading"},{"inlineContent":[{"code":"create:me:authentication_methods","type":"codeVoice"}],"type":"paragraph"},{"text":"Usage","anchor":"Usage","level":2,"type":"heading"},{"syntax":"swift","code":["Auth0"," .myAccount(token: apiCredentials.accessToken)"," .authenticationMethods"," .enrollPushNotification()"," .start { result in"," switch result {"," case .success(let enrollmentChallenge):"," print(\"Obtained enrollment challenge \\(enrollmentChallenge)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"],"type":"codeListing"}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/myaccountauthenticationmethods\/enrollpushnotification()"]}],"sections":[],"schemaVersion":{"patch":0,"minor":3,"major":0},"kind":"symbol","metadata":{"roleHeading":"Instance Method","externalID":"s:5Auth030MyAccountAuthenticationMethodsP22enrollPushNotificationAA7RequestVyAA0G19EnrollmentChallengeVAA0bC5ErrorVGyF","symbolKind":"method","required":true,"modules":[{"name":"Auth0"}],"title":"enrollPushNotification()","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"enrollPushNotification","kind":"identifier"},{"text":"() -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"PushEnrollmentChallenge","preciseIdentifier":"s:5Auth023PushEnrollmentChallengeV","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"MyAccountError","preciseIdentifier":"s:5Auth014MyAccountErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/enrollPushNotification()"},"abstract":[{"type":"text","text":"Requests a challenge for enrolling a push notification authentication method. This is the first part of the enrollment flow."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Request":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/request","kind":"symbol","abstract":[{"type":"text","text":"Auth0 API request."}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods/enrollPushNotification()":{"title":"enrollPushNotification()","kind":"symbol","type":"topic","url":"\/documentation\/auth0\/myaccountauthenticationmethods\/enrollpushnotification()","abstract":[{"text":"Requests a challenge for enrolling a push notification authentication method. This is the first part of the enrollment flow.","type":"text"}],"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"enrollPushNotification","kind":"identifier"},{"text":"() -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"PushEnrollmentChallenge","preciseIdentifier":"s:5Auth023PushEnrollmentChallengeV","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"MyAccountError","preciseIdentifier":"s:5Auth014MyAccountErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/enrollPushNotification()","required":true},"doc://com.auth0.Auth0/documentation/Auth0/PushEnrollmentChallenge":{"title":"PushEnrollmentChallenge","abstract":[{"type":"text","text":"A Push enrollment challenge."}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PushEnrollmentChallenge","kind":"identifier"}],"navigatorTitle":[{"text":"PushEnrollmentChallenge","kind":"identifier"}],"url":"\/documentation\/auth0\/pushenrollmentchallenge","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","type":"topic","kind":"symbol","abstract":[{"text":"Represents an error during a request to the Auth0 My Account API.","type":"text"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountError","kind":"identifier"}],"navigatorTitle":[{"text":"MyAccountError","kind":"identifier"}],"url":"\/documentation\/auth0\/myaccounterror","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods":{"url":"\/documentation\/auth0\/myaccountauthenticationmethods","kind":"symbol","type":"topic","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountAuthenticationMethods","kind":"identifier"}],"navigatorTitle":[{"text":"MyAccountAuthenticationMethods","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods","title":"MyAccountAuthenticationMethods","abstract":[{"type":"text","text":"My Account API sub-client for managing the current user’s authentication methods."}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access":{"title":"Early Access","titleInlineContent":[{"type":"text","text":"Early Access"}],"url":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","type":"link"}}} \ No newline at end of file +{"abstract":[{"type":"text","text":"Requests a challenge for enrolling a push notification authentication method. This is the first part of the enrollment flow."}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"enrollPushNotification"},{"kind":"text","text":"() -> "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge","kind":"typeIdentifier","text":"PushEnrollmentChallenge","preciseIdentifier":"s:5Auth023PushEnrollmentChallengeV"},{"kind":"text","text":", "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","kind":"typeIdentifier","text":"MyAccountError","preciseIdentifier":"s:5Auth014MyAccountErrorV"},{"kind":"text","text":">"}]}],"kind":"declarations"},{"content":[{"level":2,"type":"heading","anchor":"return-value","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A request that will yield a push notification enrolment challenge"}]}],"kind":"content"},{"content":[{"level":2,"type":"heading","anchor":"Availability","text":"Availability"},{"type":"paragraph","inlineContent":[{"type":"text","text":"This feature is currently available in"},{"type":"text","text":" "},{"identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","type":"reference","isActive":true},{"type":"text","text":"."},{"type":"text","text":" "},{"type":"text","text":"Please reach out to Auth0 support to get it enabled for your tenant."}]},{"level":2,"type":"heading","anchor":"Scopes-Required","text":"Scopes Required"},{"type":"paragraph","inlineContent":[{"code":"create:me:authentication_methods","type":"codeVoice"}]},{"level":2,"type":"heading","anchor":"Usage","text":"Usage"},{"type":"codeListing","syntax":"swift","code":["Auth0"," .myAccount(token: apiCredentials.accessToken)"," .authenticationMethods"," .enrollPushNotification()"," .start { result in"," switch result {"," case .success(let enrollmentChallenge):"," print(\"Obtained enrollment challenge \\(enrollmentChallenge)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"]}],"kind":"content"}],"variants":[{"paths":["\/documentation\/auth0\/myaccountauthenticationmethods\/enrollpushnotification()"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods"]]},"metadata":{"modules":[{"name":"Auth0"}],"title":"enrollPushNotification()","roleHeading":"Instance Method","symbolKind":"method","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"enrollPushNotification"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023PushEnrollmentChallengeV","text":"PushEnrollmentChallenge"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth014MyAccountErrorV","text":"MyAccountError"},{"kind":"text","text":">"}],"externalID":"s:5Auth030MyAccountAuthenticationMethodsP22enrollPushNotificationAA7RequestVyAA0G19EnrollmentChallengeVAA0bC5ErrorVGyF","required":true},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/enrollPushNotification()","interfaceLanguage":"swift"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods":{"role":"symbol","title":"MyAccountAuthenticationMethods","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"MyAccountAuthenticationMethods"}],"navigatorTitle":[{"text":"MyAccountAuthenticationMethods","kind":"identifier"}],"abstract":[{"type":"text","text":"My Account API sub-client for managing the current user’s authentication methods."}],"kind":"symbol","url":"\/documentation\/auth0\/myaccountauthenticationmethods","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"title":"Request","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"abstract":[{"text":"Auth0 API request.","type":"text"}],"url":"\/documentation\/auth0\/request","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access":{"title":"Early Access","type":"link","titleInlineContent":[{"type":"text","text":"Early Access"}],"identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","url":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access"},"doc://com.auth0.Auth0/documentation/Auth0/PushEnrollmentChallenge":{"type":"topic","title":"PushEnrollmentChallenge","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge","kind":"symbol","abstract":[{"type":"text","text":"A Push enrollment challenge."}],"url":"\/documentation\/auth0\/pushenrollmentchallenge","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"PushEnrollmentChallenge"}],"navigatorTitle":[{"kind":"identifier","text":"PushEnrollmentChallenge"}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccountError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 My Account API."}],"url":"\/documentation\/auth0\/myaccounterror","navigatorTitle":[{"kind":"identifier","text":"MyAccountError"}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods/enrollPushNotification()":{"type":"topic","title":"enrollPushNotification()","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/enrollPushNotification()","kind":"symbol","url":"\/documentation\/auth0\/myaccountauthenticationmethods\/enrollpushnotification()","abstract":[{"type":"text","text":"Requests a challenge for enrolling a push notification authentication method. This is the first part of the enrollment flow."}],"required":true,"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"enrollPushNotification"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023PushEnrollmentChallengeV","text":"PushEnrollmentChallenge"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth014MyAccountErrorV","text":"MyAccountError"},{"kind":"text","text":">"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/myaccountauthenticationmethods/enrollrecoverycode().json b/docs/data/documentation/auth0/myaccountauthenticationmethods/enrollrecoverycode().json index 41716ba65..35b97985c 100644 --- a/docs/data/documentation/auth0/myaccountauthenticationmethods/enrollrecoverycode().json +++ b/docs/data/documentation/auth0/myaccountauthenticationmethods/enrollrecoverycode().json @@ -1 +1 @@ -{"schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"type":"text","text":"Requests a challenge for enrolling a recovery code authentication method. This is the first part of the enrollment flow."}],"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"enrollRecoveryCode","kind":"identifier"},{"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\/RecoveryCodeEnrollmentChallenge","text":"RecoveryCodeEnrollmentChallenge","kind":"typeIdentifier","preciseIdentifier":"s:5Auth031RecoveryCodeEnrollmentChallengeV"},{"text":", ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","text":"MyAccountError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth014MyAccountErrorV"},{"text":">","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}]},{"kind":"content","content":[{"level":2,"type":"heading","anchor":"return-value","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A request that will yield an recovery code challenge"}]}]},{"kind":"content","content":[{"text":"Availability","level":2,"type":"heading","anchor":"Availability"},{"inlineContent":[{"text":"This feature is currently available in","type":"text"},{"text":" ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","isActive":true,"type":"reference"},{"text":".","type":"text"},{"text":" ","type":"text"},{"text":"Please reach out to Auth0 support to get it enabled for your tenant.","type":"text"}],"type":"paragraph"},{"text":"Scopes Required","level":2,"type":"heading","anchor":"Scopes-Required"},{"inlineContent":[{"code":"create:me:authentication_methods","type":"codeVoice"}],"type":"paragraph"},{"text":"Usage","level":2,"type":"heading","anchor":"Usage"},{"code":["Auth0"," .myAccount(token: apiCredentials.accessToken)"," .authenticationMethods"," .enrollRecoveryCode()"," .start { result in"," switch result {"," case .success(let enrollmentChallenge):"," print(\"Obtained enrollment Challenge \\(enrollmentChallenge)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"],"syntax":"swift","type":"codeListing"}]}],"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/myaccountauthenticationmethods\/enrollrecoverycode()"]}],"metadata":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"enrollRecoveryCode","kind":"identifier"},{"text":"() -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"RecoveryCodeEnrollmentChallenge","kind":"typeIdentifier","preciseIdentifier":"s:5Auth031RecoveryCodeEnrollmentChallengeV"},{"text":", ","kind":"text"},{"text":"MyAccountError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth014MyAccountErrorV"},{"text":">","kind":"text"}],"title":"enrollRecoveryCode()","required":true,"role":"symbol","modules":[{"name":"Auth0"}],"roleHeading":"Instance Method","symbolKind":"method","externalID":"s:5Auth030MyAccountAuthenticationMethodsP18enrollRecoveryCodeAA7RequestVyAA0gH19EnrollmentChallengeVAA0bC5ErrorVGyF"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/enrollRecoveryCode()"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/RecoveryCodeEnrollmentChallenge":{"title":"RecoveryCodeEnrollmentChallenge","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RecoveryCodeEnrollmentChallenge","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"RecoveryCodeEnrollmentChallenge","kind":"identifier"}],"navigatorTitle":[{"text":"RecoveryCodeEnrollmentChallenge","kind":"identifier"}],"abstract":[{"type":"text","text":"A Recovery code enrollment challenge."}],"kind":"symbol","role":"symbol","url":"\/documentation\/auth0\/recoverycodeenrollmentchallenge"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","type":"topic","kind":"symbol","abstract":[{"text":"Represents an error during a request to the Auth0 My Account API.","type":"text"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountError","kind":"identifier"}],"navigatorTitle":[{"text":"MyAccountError","kind":"identifier"}],"url":"\/documentation\/auth0\/myaccounterror","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods/enrollRecoveryCode()":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/enrollRecoveryCode()","required":true,"type":"topic","role":"symbol","abstract":[{"type":"text","text":"Requests a challenge for enrolling a recovery code authentication method. This is the first part of the enrollment flow."}],"url":"\/documentation\/auth0\/myaccountauthenticationmethods\/enrollrecoverycode()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"enrollRecoveryCode"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth031RecoveryCodeEnrollmentChallengeV","text":"RecoveryCodeEnrollmentChallenge"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth014MyAccountErrorV","text":"MyAccountError"},{"kind":"text","text":">"}],"kind":"symbol","title":"enrollRecoveryCode()"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/request","kind":"symbol","abstract":[{"type":"text","text":"Auth0 API request."}]},"https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access":{"url":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","title":"Early Access","type":"link","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","titleInlineContent":[{"text":"Early Access","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods":{"url":"\/documentation\/auth0\/myaccountauthenticationmethods","kind":"symbol","type":"topic","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountAuthenticationMethods","kind":"identifier"}],"navigatorTitle":[{"text":"MyAccountAuthenticationMethods","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods","title":"MyAccountAuthenticationMethods","abstract":[{"type":"text","text":"My Account API sub-client for managing the current user’s authentication methods."}]}}} \ No newline at end of file +{"abstract":[{"text":"Requests a challenge for enrolling a recovery code authentication method. This is the first part of the enrollment flow.","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"enrollRecoveryCode"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","text":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"RecoveryCodeEnrollmentChallenge","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RecoveryCodeEnrollmentChallenge","preciseIdentifier":"s:5Auth031RecoveryCodeEnrollmentChallengeV"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"MyAccountError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","preciseIdentifier":"s:5Auth014MyAccountErrorV"},{"kind":"text","text":">"}],"platforms":["iOS"],"languages":["swift"]}]},{"kind":"content","content":[{"text":"Return Value","level":2,"type":"heading","anchor":"return-value"},{"inlineContent":[{"text":"A request that will yield an recovery code challenge","type":"text"}],"type":"paragraph"}]},{"kind":"content","content":[{"text":"Availability","level":2,"type":"heading","anchor":"Availability"},{"inlineContent":[{"text":"This feature is currently available in","type":"text"},{"text":" ","type":"text"},{"isActive":true,"identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","type":"reference"},{"text":".","type":"text"},{"text":" ","type":"text"},{"text":"Please reach out to Auth0 support to get it enabled for your tenant.","type":"text"}],"type":"paragraph"},{"text":"Scopes Required","level":2,"type":"heading","anchor":"Scopes-Required"},{"inlineContent":[{"type":"codeVoice","code":"create:me:authentication_methods"}],"type":"paragraph"},{"text":"Usage","level":2,"type":"heading","anchor":"Usage"},{"type":"codeListing","code":["Auth0"," .myAccount(token: apiCredentials.accessToken)"," .authenticationMethods"," .enrollRecoveryCode()"," .start { result in"," switch result {"," case .success(let enrollmentChallenge):"," print(\"Obtained enrollment Challenge \\(enrollmentChallenge)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"],"syntax":"swift"}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/myaccountauthenticationmethods\/enrollrecoverycode()"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods"]]},"metadata":{"modules":[{"name":"Auth0"}],"title":"enrollRecoveryCode()","roleHeading":"Instance Method","symbolKind":"method","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"enrollRecoveryCode"},{"kind":"text","text":"() -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:5Auth031RecoveryCodeEnrollmentChallengeV","text":"RecoveryCodeEnrollmentChallenge","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth014MyAccountErrorV","text":"MyAccountError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"required":true,"externalID":"s:5Auth030MyAccountAuthenticationMethodsP18enrollRecoveryCodeAA7RequestVyAA0gH19EnrollmentChallengeVAA0bC5ErrorVGyF"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/enrollRecoveryCode()"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/RecoveryCodeEnrollmentChallenge":{"title":"RecoveryCodeEnrollmentChallenge","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RecoveryCodeEnrollmentChallenge","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"RecoveryCodeEnrollmentChallenge"}],"abstract":[{"type":"text","text":"A Recovery code enrollment challenge."}],"url":"\/documentation\/auth0\/recoverycodeenrollmentchallenge","navigatorTitle":[{"text":"RecoveryCodeEnrollmentChallenge","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods/enrollRecoveryCode()":{"role":"symbol","title":"enrollRecoveryCode()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"enrollRecoveryCode"},{"text":"() -> ","kind":"text"},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"RecoveryCodeEnrollmentChallenge","preciseIdentifier":"s:5Auth031RecoveryCodeEnrollmentChallengeV"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"MyAccountError","preciseIdentifier":"s:5Auth014MyAccountErrorV"},{"kind":"text","text":">"}],"abstract":[{"type":"text","text":"Requests a challenge for enrolling a recovery code authentication method. This is the first part of the enrollment flow."}],"kind":"symbol","url":"\/documentation\/auth0\/myaccountauthenticationmethods\/enrollrecoverycode()","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/enrollRecoveryCode()","required":true,"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccountError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 My Account API."}],"url":"\/documentation\/auth0\/myaccounterror","navigatorTitle":[{"kind":"identifier","text":"MyAccountError"}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods":{"role":"symbol","title":"MyAccountAuthenticationMethods","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"MyAccountAuthenticationMethods"}],"navigatorTitle":[{"text":"MyAccountAuthenticationMethods","kind":"identifier"}],"abstract":[{"type":"text","text":"My Account API sub-client for managing the current user’s authentication methods."}],"kind":"symbol","url":"\/documentation\/auth0\/myaccountauthenticationmethods","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"title":"Request","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"abstract":[{"text":"Auth0 API request.","type":"text"}],"url":"\/documentation\/auth0\/request","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access":{"title":"Early Access","titleInlineContent":[{"type":"text","text":"Early Access"}],"type":"link","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","url":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/myaccountauthenticationmethods/enrolltotp().json b/docs/data/documentation/auth0/myaccountauthenticationmethods/enrolltotp().json index 8e739ad6a..1ee64c667 100644 --- a/docs/data/documentation/auth0/myaccountauthenticationmethods/enrolltotp().json +++ b/docs/data/documentation/auth0/myaccountauthenticationmethods/enrolltotp().json @@ -1 +1 @@ -{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/enrollTOTP()"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/myaccountauthenticationmethods\/enrolltotp()"]}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"enrollTOTP"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","text":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"TOTPEnrollmentChallenge","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge","preciseIdentifier":"s:5Auth023TOTPEnrollmentChallengeV"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"MyAccountError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","preciseIdentifier":"s:5Auth014MyAccountErrorV"},{"kind":"text","text":">"}]}],"kind":"declarations"},{"content":[{"text":"Return Value","type":"heading","level":2,"anchor":"return-value"},{"type":"paragraph","inlineContent":[{"text":"A request that will yield a totp enrollment challenge","type":"text"}]}],"kind":"content"},{"content":[{"level":2,"text":"Availability","anchor":"Availability","type":"heading"},{"inlineContent":[{"type":"text","text":"This feature is currently available in"},{"type":"text","text":" "},{"type":"reference","isActive":true,"identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access"},{"type":"text","text":"."},{"type":"text","text":" "},{"type":"text","text":"Please reach out to Auth0 support to get it enabled for your tenant."}],"type":"paragraph"},{"level":2,"text":"Scopes Required","anchor":"Scopes-Required","type":"heading"},{"inlineContent":[{"code":"create:me:authentication_methods","type":"codeVoice"}],"type":"paragraph"},{"level":2,"text":"Usage","anchor":"Usage","type":"heading"},{"syntax":"swift","type":"codeListing","code":["Auth0"," .myAccount(token: apiCredentials.accessToken)"," .authenticationMethods"," .enrollTOTP()"," .start { result in"," switch result {"," case .success(let enrollmentChallenge):"," print(\"Obtained enrollment challenge \\(enrollmentChallenge)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"]}],"kind":"content"}],"kind":"symbol","abstract":[{"type":"text","text":"Requests a challenge for enrolling a TOTP authentication method. This is the first part of the enrollment flow."}],"sections":[],"metadata":{"role":"symbol","roleHeading":"Instance Method","title":"enrollTOTP()","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"enrollTOTP","kind":"identifier"},{"text":"() -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth023TOTPEnrollmentChallengeV","text":"TOTPEnrollmentChallenge","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth014MyAccountErrorV","text":"MyAccountError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"externalID":"s:5Auth030MyAccountAuthenticationMethodsP10enrollTOTPAA7RequestVyAA23TOTPEnrollmentChallengeVAA0bC5ErrorVGyF","symbolKind":"method","required":true,"modules":[{"name":"Auth0"}]},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/TOTPEnrollmentChallenge":{"kind":"symbol","navigatorTitle":[{"text":"TOTPEnrollmentChallenge","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge","url":"\/documentation\/auth0\/totpenrollmentchallenge","title":"TOTPEnrollmentChallenge","type":"topic","abstract":[{"type":"text","text":"A TOTP enrollment challenge."}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"TOTPEnrollmentChallenge","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/request","kind":"symbol","abstract":[{"type":"text","text":"Auth0 API request."}]},"https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access":{"identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","url":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","title":"Early Access","type":"link","titleInlineContent":[{"type":"text","text":"Early Access"}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods/enrollTOTP()":{"required":true,"role":"symbol","abstract":[{"type":"text","text":"Requests a challenge for enrolling a TOTP authentication method. This is the first part of the enrollment flow."}],"url":"\/documentation\/auth0\/myaccountauthenticationmethods\/enrolltotp()","title":"enrollTOTP()","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"enrollTOTP","kind":"identifier"},{"text":"() -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"TOTPEnrollmentChallenge","kind":"typeIdentifier","preciseIdentifier":"s:5Auth023TOTPEnrollmentChallengeV"},{"text":", ","kind":"text"},{"text":"MyAccountError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth014MyAccountErrorV"},{"text":">","kind":"text"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/enrollTOTP()","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","type":"topic","kind":"symbol","abstract":[{"text":"Represents an error during a request to the Auth0 My Account API.","type":"text"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountError","kind":"identifier"}],"navigatorTitle":[{"text":"MyAccountError","kind":"identifier"}],"url":"\/documentation\/auth0\/myaccounterror","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods":{"url":"\/documentation\/auth0\/myaccountauthenticationmethods","kind":"symbol","type":"topic","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountAuthenticationMethods","kind":"identifier"}],"navigatorTitle":[{"text":"MyAccountAuthenticationMethods","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods","title":"MyAccountAuthenticationMethods","abstract":[{"type":"text","text":"My Account API sub-client for managing the current user’s authentication methods."}]}}} \ No newline at end of file +{"abstract":[{"type":"text","text":"Requests a challenge for enrolling a TOTP authentication method. This is the first part of the enrollment flow."}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"enrollTOTP"},{"kind":"text","text":"() -> "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge","kind":"typeIdentifier","text":"TOTPEnrollmentChallenge","preciseIdentifier":"s:5Auth023TOTPEnrollmentChallengeV"},{"kind":"text","text":", "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","kind":"typeIdentifier","text":"MyAccountError","preciseIdentifier":"s:5Auth014MyAccountErrorV"},{"kind":"text","text":">"}]}],"kind":"declarations"},{"content":[{"level":2,"type":"heading","anchor":"return-value","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A request that will yield a totp enrollment challenge"}]}],"kind":"content"},{"content":[{"level":2,"type":"heading","anchor":"Availability","text":"Availability"},{"type":"paragraph","inlineContent":[{"type":"text","text":"This feature is currently available in"},{"type":"text","text":" "},{"identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","type":"reference","isActive":true},{"type":"text","text":"."},{"type":"text","text":" "},{"type":"text","text":"Please reach out to Auth0 support to get it enabled for your tenant."}]},{"level":2,"type":"heading","anchor":"Scopes-Required","text":"Scopes Required"},{"type":"paragraph","inlineContent":[{"code":"create:me:authentication_methods","type":"codeVoice"}]},{"level":2,"type":"heading","anchor":"Usage","text":"Usage"},{"type":"codeListing","syntax":"swift","code":["Auth0"," .myAccount(token: apiCredentials.accessToken)"," .authenticationMethods"," .enrollTOTP()"," .start { result in"," switch result {"," case .success(let enrollmentChallenge):"," print(\"Obtained enrollment challenge \\(enrollmentChallenge)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"]}],"kind":"content"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/myaccountauthenticationmethods\/enrolltotp()"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods"]]},"metadata":{"modules":[{"name":"Auth0"}],"title":"enrollTOTP()","roleHeading":"Instance Method","symbolKind":"method","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"enrollTOTP"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth023TOTPEnrollmentChallengeV","text":"TOTPEnrollmentChallenge"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth014MyAccountErrorV","text":"MyAccountError"},{"kind":"text","text":">"}],"externalID":"s:5Auth030MyAccountAuthenticationMethodsP10enrollTOTPAA7RequestVyAA23TOTPEnrollmentChallengeVAA0bC5ErrorVGyF","required":true},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/enrollTOTP()","interfaceLanguage":"swift"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccountError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 My Account API."}],"url":"\/documentation\/auth0\/myaccounterror","navigatorTitle":[{"kind":"identifier","text":"MyAccountError"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/TOTPEnrollmentChallenge":{"title":"TOTPEnrollmentChallenge","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"TOTPEnrollmentChallenge"}],"abstract":[{"text":"A TOTP enrollment challenge.","type":"text"}],"url":"\/documentation\/auth0\/totpenrollmentchallenge","navigatorTitle":[{"kind":"identifier","text":"TOTPEnrollmentChallenge"}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods/enrollTOTP()":{"kind":"symbol","required":true,"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"enrollTOTP"},{"kind":"text","text":"() -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:5Auth023TOTPEnrollmentChallengeV","kind":"typeIdentifier","text":"TOTPEnrollmentChallenge"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth014MyAccountErrorV","kind":"typeIdentifier","text":"MyAccountError"},{"kind":"text","text":">"}],"title":"enrollTOTP()","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Requests a challenge for enrolling a TOTP authentication method. This is the first part of the enrollment flow."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/enrollTOTP()","url":"\/documentation\/auth0\/myaccountauthenticationmethods\/enrolltotp()"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"title":"Request","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"abstract":[{"text":"Auth0 API request.","type":"text"}],"url":"\/documentation\/auth0\/request","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access":{"title":"Early Access","url":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","type":"link","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","titleInlineContent":[{"type":"text","text":"Early Access"}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods":{"role":"symbol","title":"MyAccountAuthenticationMethods","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"MyAccountAuthenticationMethods"}],"navigatorTitle":[{"text":"MyAccountAuthenticationMethods","kind":"identifier"}],"abstract":[{"type":"text","text":"My Account API sub-client for managing the current user’s authentication methods."}],"kind":"symbol","url":"\/documentation\/auth0\/myaccountauthenticationmethods","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/myaccountauthenticationmethods/getauthenticationmethod(by:).json b/docs/data/documentation/auth0/myaccountauthenticationmethods/getauthenticationmethod(by:).json index 7855ff1d7..8cc92b435 100644 --- a/docs/data/documentation/auth0/myaccountauthenticationmethods/getauthenticationmethod(by:).json +++ b/docs/data/documentation/auth0/myaccountauthenticationmethods/getauthenticationmethod(by:).json @@ -1 +1 @@ -{"kind":"symbol","abstract":[{"type":"text","text":"Fetch details of an authentication method associated with an id"}],"metadata":{"roleHeading":"Instance Method","symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getAuthenticationMethod","kind":"identifier"},{"text":"(","kind":"text"},{"text":"by","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"AuthenticationMethod","preciseIdentifier":"s:5Auth020AuthenticationMethodV","kind":"typeIdentifier"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth014MyAccountErrorV","kind":"typeIdentifier","text":"MyAccountError"},{"kind":"text","text":">"}],"modules":[{"name":"Auth0"}],"role":"symbol","required":true,"title":"getAuthenticationMethod(by:)","externalID":"s:5Auth030MyAccountAuthenticationMethodsP03getD6Method2byAA7RequestVyAA0dG0VAA0bC5ErrorVGSS_tF"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/myaccountauthenticationmethods\/getauthenticationmethod(by:)"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/getAuthenticationMethod(by:)","interfaceLanguage":"swift"},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getAuthenticationMethod","kind":"identifier"},{"text":"(","kind":"text"},{"text":"by","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"id","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:5Auth020AuthenticationMethodV","kind":"typeIdentifier","text":"AuthenticationMethod","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth014MyAccountErrorV","kind":"typeIdentifier","text":"MyAccountError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError"},{"kind":"text","text":">"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"},{"parameters":[{"name":"id","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Id of the returned authentication method"}]}]}],"kind":"parameters"},{"content":[{"level":2,"type":"heading","anchor":"return-value","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A request to fetch authentication method associated with the id."}]}],"kind":"content"},{"content":[{"text":"Availability","type":"heading","level":2,"anchor":"Availability"},{"type":"paragraph","inlineContent":[{"text":"This feature is currently available in","type":"text"},{"text":" ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","isActive":true,"type":"reference"},{"text":".","type":"text"},{"text":" ","type":"text"},{"text":"Please reach out to Auth0 support to get it enabled for your tenant.","type":"text"}]},{"text":"Scopes Required","type":"heading","level":2,"anchor":"Scopes-Required"},{"type":"paragraph","inlineContent":[{"type":"codeVoice","code":"read:me:authentication_methods"}]},{"text":"Usage","type":"heading","level":2,"anchor":"Usage"},{"type":"codeListing","syntax":"swift","code":["Auth0"," .myAccount(token: apiCredentials.accessToken)"," .authenticationMethods"," .getAuthenticationMethod(by: id)"," .start { result in"," switch result {"," case .success(let authenticationMethod):"," print(\"Fetched authentication method: \\(authenticationMethod)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"]}],"kind":"content"}],"sections":[],"schemaVersion":{"major":0,"patch":0,"minor":3},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationMethod","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod","navigatorTitle":[{"text":"AuthenticationMethod","kind":"identifier"}],"abstract":[],"title":"AuthenticationMethod","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/authenticationmethod"},"https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access":{"type":"link","titleInlineContent":[{"type":"text","text":"Early Access"}],"url":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","title":"Early Access"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","type":"topic","kind":"symbol","abstract":[{"text":"Represents an error during a request to the Auth0 My Account API.","type":"text"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountError","kind":"identifier"}],"navigatorTitle":[{"text":"MyAccountError","kind":"identifier"}],"url":"\/documentation\/auth0\/myaccounterror","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods/getAuthenticationMethod(by:)":{"url":"\/documentation\/auth0\/myaccountauthenticationmethods\/getauthenticationmethod(by:)","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/getAuthenticationMethod(by:)","role":"symbol","abstract":[{"type":"text","text":"Fetch details of an authentication method associated with an id"}],"title":"getAuthenticationMethod(by:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getAuthenticationMethod","kind":"identifier"},{"text":"(","kind":"text"},{"text":"by","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"AuthenticationMethod","kind":"typeIdentifier","preciseIdentifier":"s:5Auth020AuthenticationMethodV"},{"text":", ","kind":"text"},{"text":"MyAccountError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth014MyAccountErrorV"},{"text":">","kind":"text"}],"required":true,"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods":{"url":"\/documentation\/auth0\/myaccountauthenticationmethods","kind":"symbol","type":"topic","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountAuthenticationMethods","kind":"identifier"}],"navigatorTitle":[{"text":"MyAccountAuthenticationMethods","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods","title":"MyAccountAuthenticationMethods","abstract":[{"type":"text","text":"My Account API sub-client for managing the current user’s authentication methods."}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/request","kind":"symbol","abstract":[{"type":"text","text":"Auth0 API request."}]}}} \ No newline at end of file +{"abstract":[{"type":"text","text":"Fetch details of an authentication method associated with an id"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getAuthenticationMethod","kind":"identifier"},{"text":"(","kind":"text"},{"text":"by","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"id","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"AuthenticationMethod","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod","kind":"typeIdentifier","preciseIdentifier":"s:5Auth020AuthenticationMethodV"},{"text":", ","kind":"text"},{"text":"MyAccountError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth014MyAccountErrorV"},{"text":">","kind":"text"}]}]},{"kind":"parameters","parameters":[{"name":"id","content":[{"inlineContent":[{"type":"text","text":"Id of the returned authentication method"}],"type":"paragraph"}]}]},{"content":[{"type":"heading","anchor":"return-value","level":2,"text":"Return Value"},{"type":"paragraph","inlineContent":[{"text":"A request to fetch authentication method associated with the id.","type":"text"}]}],"kind":"content"},{"content":[{"type":"heading","anchor":"Availability","level":2,"text":"Availability"},{"type":"paragraph","inlineContent":[{"text":"This feature is currently available in","type":"text"},{"text":" ","type":"text"},{"isActive":true,"identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","type":"reference"},{"text":".","type":"text"},{"text":" ","type":"text"},{"text":"Please reach out to Auth0 support to get it enabled for your tenant.","type":"text"}]},{"type":"heading","anchor":"Scopes-Required","level":2,"text":"Scopes Required"},{"type":"paragraph","inlineContent":[{"code":"read:me:authentication_methods","type":"codeVoice"}]},{"type":"heading","anchor":"Usage","level":2,"text":"Usage"},{"type":"codeListing","syntax":"swift","code":["Auth0"," .myAccount(token: apiCredentials.accessToken)"," .authenticationMethods"," .getAuthenticationMethod(by: id)"," .start { result in"," switch result {"," case .success(let authenticationMethod):"," print(\"Fetched authentication method: \\(authenticationMethod)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"]}],"kind":"content"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/myaccountauthenticationmethods\/getauthenticationmethod(by:)"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods"]]},"metadata":{"modules":[{"name":"Auth0"}],"title":"getAuthenticationMethod(by:)","roleHeading":"Instance Method","symbolKind":"method","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getAuthenticationMethod"},{"kind":"text","text":"("},{"kind":"externalParam","text":"by"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:5Auth020AuthenticationMethodV","kind":"typeIdentifier","text":"AuthenticationMethod"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth014MyAccountErrorV","kind":"typeIdentifier","text":"MyAccountError"},{"kind":"text","text":">"}],"externalID":"s:5Auth030MyAccountAuthenticationMethodsP03getD6Method2byAA7RequestVyAA0dG0VAA0bC5ErrorVGSS_tF","required":true},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/getAuthenticationMethod(by:)"},"kind":"symbol","references":{"https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access":{"title":"Early Access","titleInlineContent":[{"type":"text","text":"Early Access"}],"url":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod":{"role":"symbol","title":"AuthenticationMethod","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationMethod"}],"navigatorTitle":[{"text":"AuthenticationMethod","kind":"identifier"}],"abstract":[],"kind":"symbol","url":"\/documentation\/auth0\/authenticationmethod","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccountError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 My Account API."}],"url":"\/documentation\/auth0\/myaccounterror","navigatorTitle":[{"kind":"identifier","text":"MyAccountError"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods":{"role":"symbol","title":"MyAccountAuthenticationMethods","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"MyAccountAuthenticationMethods"}],"navigatorTitle":[{"text":"MyAccountAuthenticationMethods","kind":"identifier"}],"abstract":[{"type":"text","text":"My Account API sub-client for managing the current user’s authentication methods."}],"kind":"symbol","url":"\/documentation\/auth0\/myaccountauthenticationmethods","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"title":"Request","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"abstract":[{"text":"Auth0 API request.","type":"text"}],"url":"\/documentation\/auth0\/request","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods/getAuthenticationMethod(by:)":{"kind":"symbol","required":true,"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getAuthenticationMethod"},{"kind":"text","text":"("},{"kind":"externalParam","text":"by"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"AuthenticationMethod","preciseIdentifier":"s:5Auth020AuthenticationMethodV"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"MyAccountError","preciseIdentifier":"s:5Auth014MyAccountErrorV"},{"kind":"text","text":">"}],"title":"getAuthenticationMethod(by:)","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Fetch details of an authentication method associated with an id"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/getAuthenticationMethod(by:)","url":"\/documentation\/auth0\/myaccountauthenticationmethods\/getauthenticationmethod(by:)"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/myaccountauthenticationmethods/getauthenticationmethods().json b/docs/data/documentation/auth0/myaccountauthenticationmethods/getauthenticationmethods().json index cb67f2085..ebc10f735 100644 --- a/docs/data/documentation/auth0/myaccountauthenticationmethods/getauthenticationmethods().json +++ b/docs/data/documentation/auth0/myaccountauthenticationmethods/getauthenticationmethods().json @@ -1 +1 @@ -{"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods"]]},"schemaVersion":{"patch":0,"minor":3,"major":0},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getAuthenticationMethods","kind":"identifier"},{"text":"() -> ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<[","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod","preciseIdentifier":"s:5Auth020AuthenticationMethodV","text":"AuthenticationMethod","kind":"typeIdentifier"},{"text":"], ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","preciseIdentifier":"s:5Auth014MyAccountErrorV","text":"MyAccountError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"},{"kind":"content","content":[{"level":2,"type":"heading","text":"Return Value","anchor":"return-value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A request that will return list of authentication methods of an authenticated user"}]}]},{"kind":"content","content":[{"type":"heading","level":2,"text":"Availability","anchor":"Availability"},{"type":"paragraph","inlineContent":[{"text":"This feature is currently available in","type":"text"},{"text":" ","type":"text"},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","isActive":true},{"text":".","type":"text"},{"text":" ","type":"text"},{"text":"Please reach out to Auth0 support to get it enabled for your tenant.","type":"text"}]},{"type":"heading","level":2,"text":"Scopes Required","anchor":"Scopes-Required"},{"type":"paragraph","inlineContent":[{"code":"read:me:authentication_methods","type":"codeVoice"}]},{"type":"heading","level":2,"text":"Usage","anchor":"Usage"},{"type":"codeListing","syntax":"swift","code":["Auth0"," .myAccount(token: apiCredentials.accessToken)"," .authenticationMethods"," .getAuthenticationMethods()"," .start { result in"," switch result {"," case .success(let authenticationMethods):"," print(\"List of Authentication methods: \\(authenticationMethods)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"]}]}],"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/getAuthenticationMethods()","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Retrieve detailed list of authentication methods belonging to the authenticated user."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/myaccountauthenticationmethods\/getauthenticationmethods()"]}],"metadata":{"required":true,"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getAuthenticationMethods"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<["},{"kind":"typeIdentifier","text":"AuthenticationMethod","preciseIdentifier":"s:5Auth020AuthenticationMethodV"},{"kind":"text","text":"], "},{"kind":"typeIdentifier","text":"MyAccountError","preciseIdentifier":"s:5Auth014MyAccountErrorV"},{"kind":"text","text":">"}],"title":"getAuthenticationMethods()","modules":[{"name":"Auth0"}],"externalID":"s:5Auth030MyAccountAuthenticationMethodsP03getdE0AA7RequestVySayAA0D6MethodVGAA0bC5ErrorVGyF","roleHeading":"Instance Method","symbolKind":"method"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access":{"type":"link","url":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","title":"Early Access","titleInlineContent":[{"type":"text","text":"Early Access"}],"identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","type":"topic","kind":"symbol","abstract":[{"text":"Represents an error during a request to the Auth0 My Account API.","type":"text"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountError","kind":"identifier"}],"navigatorTitle":[{"text":"MyAccountError","kind":"identifier"}],"url":"\/documentation\/auth0\/myaccounterror","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods/getAuthenticationMethods()":{"type":"topic","url":"\/documentation\/auth0\/myaccountauthenticationmethods\/getauthenticationmethods()","required":true,"abstract":[{"text":"Retrieve detailed list of authentication methods belonging to the authenticated user.","type":"text"}],"title":"getAuthenticationMethods()","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getAuthenticationMethods","kind":"identifier"},{"text":"() -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<[","kind":"text"},{"preciseIdentifier":"s:5Auth020AuthenticationMethodV","text":"AuthenticationMethod","kind":"typeIdentifier"},{"text":"], ","kind":"text"},{"preciseIdentifier":"s:5Auth014MyAccountErrorV","text":"MyAccountError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/getAuthenticationMethods()","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/request","kind":"symbol","abstract":[{"type":"text","text":"Auth0 API request."}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods":{"url":"\/documentation\/auth0\/myaccountauthenticationmethods","kind":"symbol","type":"topic","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountAuthenticationMethods","kind":"identifier"}],"navigatorTitle":[{"text":"MyAccountAuthenticationMethods","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods","title":"MyAccountAuthenticationMethods","abstract":[{"type":"text","text":"My Account API sub-client for managing the current user’s authentication methods."}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthenticationMethod","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod","navigatorTitle":[{"text":"AuthenticationMethod","kind":"identifier"}],"abstract":[],"title":"AuthenticationMethod","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/authenticationmethod"}}} \ No newline at end of file +{"metadata":{"symbolKind":"method","roleHeading":"Instance Method","externalID":"s:5Auth030MyAccountAuthenticationMethodsP03getdE0AA7RequestVySayAA0D6MethodVGAA0bC5ErrorVGyF","title":"getAuthenticationMethods()","modules":[{"name":"Auth0"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getAuthenticationMethods","kind":"identifier"},{"text":"() -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<[","kind":"text"},{"preciseIdentifier":"s:5Auth020AuthenticationMethodV","text":"AuthenticationMethod","kind":"typeIdentifier"},{"text":"], ","kind":"text"},{"preciseIdentifier":"s:5Auth014MyAccountErrorV","text":"MyAccountError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"role":"symbol","required":true},"sections":[],"variants":[{"paths":["\/documentation\/auth0\/myaccountauthenticationmethods\/getauthenticationmethods()"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/getAuthenticationMethods()"},"kind":"symbol","abstract":[{"type":"text","text":"Retrieve detailed list of authentication methods belonging to the authenticated user."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods"]]},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getAuthenticationMethods"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"},{"kind":"text","text":"<["},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth020AuthenticationMethodV","text":"AuthenticationMethod","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod"},{"kind":"text","text":"], "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth014MyAccountErrorV","text":"MyAccountError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError"},{"kind":"text","text":">"}]}],"kind":"declarations"},{"content":[{"type":"heading","text":"Return Value","anchor":"return-value","level":2},{"type":"paragraph","inlineContent":[{"type":"text","text":"A request that will return list of authentication methods of an authenticated user"}]}],"kind":"content"},{"content":[{"type":"heading","text":"Availability","anchor":"Availability","level":2},{"type":"paragraph","inlineContent":[{"type":"text","text":"This feature is currently available in"},{"type":"text","text":" "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","isActive":true},{"type":"text","text":"."},{"type":"text","text":" "},{"type":"text","text":"Please reach out to Auth0 support to get it enabled for your tenant."}]},{"type":"heading","text":"Scopes Required","anchor":"Scopes-Required","level":2},{"type":"paragraph","inlineContent":[{"type":"codeVoice","code":"read:me:authentication_methods"}]},{"type":"heading","text":"Usage","anchor":"Usage","level":2},{"type":"codeListing","syntax":"swift","code":["Auth0"," .myAccount(token: apiCredentials.accessToken)"," .authenticationMethods"," .getAuthenticationMethods()"," .start { result in"," switch result {"," case .success(let authenticationMethods):"," print(\"List of Authentication methods: \\(authenticationMethods)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"]}],"kind":"content"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Request":{"title":"Request","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"abstract":[{"text":"Auth0 API request.","type":"text"}],"url":"\/documentation\/auth0\/request","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccountError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 My Account API."}],"url":"\/documentation\/auth0\/myaccounterror","navigatorTitle":[{"kind":"identifier","text":"MyAccountError"}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods":{"role":"symbol","title":"MyAccountAuthenticationMethods","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"MyAccountAuthenticationMethods"}],"navigatorTitle":[{"text":"MyAccountAuthenticationMethods","kind":"identifier"}],"abstract":[{"type":"text","text":"My Account API sub-client for managing the current user’s authentication methods."}],"kind":"symbol","url":"\/documentation\/auth0\/myaccountauthenticationmethods","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods/getAuthenticationMethods()":{"type":"topic","title":"getAuthenticationMethods()","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/getAuthenticationMethods()","url":"\/documentation\/auth0\/myaccountauthenticationmethods\/getauthenticationmethods()","abstract":[{"type":"text","text":"Retrieve detailed list of authentication methods belonging to the authenticated user."}],"kind":"symbol","required":true,"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getAuthenticationMethods","kind":"identifier"},{"text":"() -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<[","kind":"text"},{"text":"AuthenticationMethod","kind":"typeIdentifier","preciseIdentifier":"s:5Auth020AuthenticationMethodV"},{"text":"], ","kind":"text"},{"text":"MyAccountError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth014MyAccountErrorV"},{"text":">","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationMethod":{"role":"symbol","title":"AuthenticationMethod","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthenticationMethod"}],"navigatorTitle":[{"text":"AuthenticationMethod","kind":"identifier"}],"abstract":[],"kind":"symbol","url":"\/documentation\/auth0\/authenticationmethod","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationMethod","type":"topic"},"https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access":{"title":"Early Access","type":"link","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","titleInlineContent":[{"type":"text","text":"Early Access"}],"url":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/myaccountauthenticationmethods/getfactors().json b/docs/data/documentation/auth0/myaccountauthenticationmethods/getfactors().json index c90143d01..25beffecb 100644 --- a/docs/data/documentation/auth0/myaccountauthenticationmethods/getfactors().json +++ b/docs/data/documentation/auth0/myaccountauthenticationmethods/getfactors().json @@ -1 +1 @@ -{"abstract":[{"text":"List of factors enabled for the Auth0 tenant and available for enrollment by this user.","type":"text"}],"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getFactors","kind":"identifier"},{"text":"() -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<[","kind":"text"},{"text":"Factor","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factor","preciseIdentifier":"s:5Auth06FactorV"},{"text":"], ","kind":"text"},{"text":"MyAccountError","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","preciseIdentifier":"s:5Auth014MyAccountErrorV"},{"text":">","kind":"text"}]}]},{"content":[{"type":"heading","anchor":"return-value","level":2,"text":"Return Value"},{"type":"paragraph","inlineContent":[{"text":"A request to fetch factors enabled for the Auth0 tenant and available for enrollment","type":"text"}]}],"kind":"content"},{"content":[{"type":"heading","anchor":"Availability","text":"Availability","level":2},{"type":"paragraph","inlineContent":[{"type":"text","text":"This feature is currently available in"},{"type":"text","text":" "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","isActive":true},{"type":"text","text":"."},{"type":"text","text":" "},{"type":"text","text":"Please reach out to Auth0 support to get it enabled for your tenant."}]},{"type":"heading","anchor":"Scopes-Required","text":"Scopes Required","level":2},{"type":"paragraph","inlineContent":[{"code":"read:me:factors","type":"codeVoice"}]},{"type":"heading","anchor":"Usage","text":"Usage","level":2},{"syntax":"swift","type":"codeListing","code":["Auth0"," .myAccount(token: apiCredentials.accessToken)"," .authenticationMethods"," .getFactors()"," .start { result in"," switch result {"," case .success(let factors):"," print(\"List of factors enabled: \\(factors)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"]}],"kind":"content"}],"schemaVersion":{"minor":3,"patch":0,"major":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/myaccountauthenticationmethods\/getfactors()"]}],"metadata":{"modules":[{"name":"Auth0"}],"symbolKind":"method","title":"getFactors()","role":"symbol","externalID":"s:5Auth030MyAccountAuthenticationMethodsP10getFactorsAA7RequestVySayAA6FactorVGAA0bC5ErrorVGyF","required":true,"roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getFactors"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<["},{"kind":"typeIdentifier","text":"Factor","preciseIdentifier":"s:5Auth06FactorV"},{"kind":"text","text":"], "},{"kind":"typeIdentifier","text":"MyAccountError","preciseIdentifier":"s:5Auth014MyAccountErrorV"},{"kind":"text","text":">"}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/getFactors()"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods"]]},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/Request":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/request","kind":"symbol","abstract":[{"type":"text","text":"Auth0 API request."}]},"doc://com.auth0.Auth0/documentation/Auth0/Factor":{"url":"\/documentation\/auth0\/factor","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factor","kind":"symbol","abstract":[],"type":"topic","title":"Factor","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Factor"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Factor"}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods":{"url":"\/documentation\/auth0\/myaccountauthenticationmethods","kind":"symbol","type":"topic","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountAuthenticationMethods","kind":"identifier"}],"navigatorTitle":[{"text":"MyAccountAuthenticationMethods","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods","title":"MyAccountAuthenticationMethods","abstract":[{"type":"text","text":"My Account API sub-client for managing the current user’s authentication methods."}]},"https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access":{"type":"link","title":"Early Access","url":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","titleInlineContent":[{"type":"text","text":"Early Access"}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods/getFactors()":{"url":"\/documentation\/auth0\/myaccountauthenticationmethods\/getfactors()","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/getFactors()","type":"topic","required":true,"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getFactors","kind":"identifier"},{"text":"() -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<[","kind":"text"},{"text":"Factor","kind":"typeIdentifier","preciseIdentifier":"s:5Auth06FactorV"},{"text":"], ","kind":"text"},{"text":"MyAccountError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth014MyAccountErrorV"},{"text":">","kind":"text"}],"title":"getFactors()","abstract":[{"type":"text","text":"List of factors enabled for the Auth0 tenant and available for enrollment by this user."}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","type":"topic","kind":"symbol","abstract":[{"text":"Represents an error during a request to the Auth0 My Account API.","type":"text"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountError","kind":"identifier"}],"navigatorTitle":[{"text":"MyAccountError","kind":"identifier"}],"url":"\/documentation\/auth0\/myaccounterror","role":"symbol"}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/myaccountauthenticationmethods\/getfactors()"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods"]]},"abstract":[{"type":"text","text":"List of factors enabled for the Auth0 tenant and available for enrollment by this user."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getFactors"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<[","kind":"text"},{"text":"Factor","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factor","preciseIdentifier":"s:5Auth06FactorV","kind":"typeIdentifier"},{"kind":"text","text":"], "},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","preciseIdentifier":"s:5Auth014MyAccountErrorV","text":"MyAccountError"},{"kind":"text","text":">"}],"platforms":["iOS"],"languages":["swift"]}]},{"kind":"content","content":[{"level":2,"anchor":"return-value","text":"Return Value","type":"heading"},{"inlineContent":[{"type":"text","text":"A request to fetch factors enabled for the Auth0 tenant and available for enrollment"}],"type":"paragraph"}]},{"kind":"content","content":[{"type":"heading","level":2,"anchor":"Availability","text":"Availability"},{"inlineContent":[{"type":"text","text":"This feature is currently available in"},{"type":"text","text":" "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","isActive":true},{"type":"text","text":"."},{"type":"text","text":" "},{"type":"text","text":"Please reach out to Auth0 support to get it enabled for your tenant."}],"type":"paragraph"},{"level":2,"anchor":"Scopes-Required","text":"Scopes Required","type":"heading"},{"inlineContent":[{"type":"codeVoice","code":"read:me:factors"}],"type":"paragraph"},{"level":2,"anchor":"Usage","text":"Usage","type":"heading"},{"syntax":"swift","code":["Auth0"," .myAccount(token: apiCredentials.accessToken)"," .authenticationMethods"," .getFactors()"," .start { result in"," switch result {"," case .success(let factors):"," print(\"List of factors enabled: \\(factors)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"],"type":"codeListing"}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"sections":[],"kind":"symbol","metadata":{"externalID":"s:5Auth030MyAccountAuthenticationMethodsP10getFactorsAA7RequestVySayAA6FactorVGAA0bC5ErrorVGyF","symbolKind":"method","title":"getFactors()","required":true,"role":"symbol","roleHeading":"Instance Method","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"getFactors","kind":"identifier"},{"text":"() -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<[","kind":"text"},{"text":"Factor","kind":"typeIdentifier","preciseIdentifier":"s:5Auth06FactorV"},{"kind":"text","text":"], "},{"text":"MyAccountError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth014MyAccountErrorV"},{"text":">","kind":"text"}],"modules":[{"name":"Auth0"}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/getFactors()"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccountError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 My Account API."}],"url":"\/documentation\/auth0\/myaccounterror","navigatorTitle":[{"kind":"identifier","text":"MyAccountError"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Factor":{"title":"Factor","role":"symbol","navigatorTitle":[{"text":"Factor","kind":"identifier"}],"kind":"symbol","abstract":[],"url":"\/documentation\/auth0\/factor","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Factor","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Factor"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods/getFactors()":{"url":"\/documentation\/auth0\/myaccountauthenticationmethods\/getfactors()","title":"getFactors()","abstract":[{"type":"text","text":"List of factors enabled for the Auth0 tenant and available for enrollment by this user."}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getFactors"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<["},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth06FactorV","text":"Factor"},{"kind":"text","text":"], "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth014MyAccountErrorV","text":"MyAccountError"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/getFactors()","required":true,"kind":"symbol","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods":{"role":"symbol","title":"MyAccountAuthenticationMethods","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"MyAccountAuthenticationMethods"}],"navigatorTitle":[{"text":"MyAccountAuthenticationMethods","kind":"identifier"}],"abstract":[{"type":"text","text":"My Account API sub-client for managing the current user’s authentication methods."}],"kind":"symbol","url":"\/documentation\/auth0\/myaccountauthenticationmethods","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"title":"Request","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"abstract":[{"text":"Auth0 API request.","type":"text"}],"url":"\/documentation\/auth0\/request","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access":{"titleInlineContent":[{"text":"Early Access","type":"text"}],"url":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","type":"link","title":"Early Access","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/myaccountauthenticationmethods/passkeyenrollmentchallenge(useridentityid:connection:)-71dk8.json b/docs/data/documentation/auth0/myaccountauthenticationmethods/passkeyenrollmentchallenge(useridentityid:connection:)-71dk8.json index 5a1c807ec..f1d7810f3 100644 --- a/docs/data/documentation/auth0/myaccountauthenticationmethods/passkeyenrollmentchallenge(useridentityid:connection:)-71dk8.json +++ b/docs/data/documentation/auth0/myaccountauthenticationmethods/passkeyenrollmentchallenge(useridentityid:connection:)-71dk8.json @@ -1 +1 @@ -{"metadata":{"modules":[{"name":"Auth0"}],"roleHeading":"Instance Method","extendedModule":"Auth0","title":"passkeyEnrollmentChallenge(userIdentityId:connection:)","platforms":[{"introducedAt":"16.6","beta":false,"deprecated":false,"name":"iOS","unavailable":false},{"introducedAt":"16.6","beta":false,"deprecated":false,"name":"iPadOS","unavailable":false},{"introducedAt":"16.6","beta":false,"deprecated":false,"name":"Mac Catalyst","unavailable":false},{"introducedAt":"13.5","beta":false,"deprecated":false,"name":"macOS","unavailable":false},{"introducedAt":"1.0","beta":false,"deprecated":false,"name":"visionOS","unavailable":false}],"role":"symbol","externalID":"s:5Auth030MyAccountAuthenticationMethodsPAAE26passkeyEnrollmentChallenge14userIdentityId10connectionAA7RequestVyAA07PasskeygH0VAA0bC5ErrorVGSSSg_ANtF","symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"passkeyEnrollmentChallenge","kind":"identifier"},{"text":"(","kind":"text"},{"text":"userIdentityId","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth026PasskeyEnrollmentChallengeV","text":"PasskeyEnrollmentChallenge"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth014MyAccountErrorV","text":"MyAccountError"},{"kind":"text","text":">"}]},"abstract":[{"type":"text","text":"Requests a challenge for enrolling a new passkey. This is the first part of the enrollment flow."}],"sections":[],"variants":[{"paths":["\/documentation\/auth0\/myaccountauthenticationmethods\/passkeyenrollmentchallenge(useridentityid:connection:)-71dk8"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/passkeyEnrollmentChallenge(userIdentityId:connection:)-71dk8","interfaceLanguage":"swift"},"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"passkeyEnrollmentChallenge"},{"kind":"text","text":"("},{"kind":"externalParam","text":"userIdentityId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"? = nil, "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"? = nil) -> "},{"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\/PasskeyEnrollmentChallenge","kind":"typeIdentifier","text":"PasskeyEnrollmentChallenge","preciseIdentifier":"s:5Auth026PasskeyEnrollmentChallengeV"},{"kind":"text","text":", "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","kind":"typeIdentifier","text":"MyAccountError","preciseIdentifier":"s:5Auth014MyAccountErrorV"},{"kind":"text","text":">"}],"languages":["swift"]}]},{"kind":"parameters","parameters":[{"name":"userIdentityId","content":[{"type":"paragraph","inlineContent":[{"text":"Unique identifier of the current user’s identity. Needed if the user logged in with a ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/manage-users\/user-accounts\/user-account-linking","type":"reference","isActive":true},{"text":".","type":"text"},{"text":" ","type":"text"},{"text":"Defaults to ","type":"text"},{"type":"codeVoice","code":"nil"},{"text":".","type":"text"}]}]},{"name":"connection","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Name of the database connection where the user is stored. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}]}]}]},{"kind":"content","content":[{"anchor":"return-value","level":2,"type":"heading","text":"Return Value"},{"inlineContent":[{"text":"A request that will yield a passkey enrollment challenge.","type":"text"}],"type":"paragraph"}]},{"kind":"content","content":[{"text":"Discussion","level":2,"anchor":"discussion","type":"heading"},{"type":"paragraph","inlineContent":[{"text":"You can specify an optional user identity identifier and an optional database connection name. If a","type":"text"},{"text":" ","type":"text"},{"text":"connection name is not specified, your tenant’s default directory will be used.","type":"text"}]},{"text":"Availability","level":2,"anchor":"Availability","type":"heading"},{"type":"paragraph","inlineContent":[{"text":"This feature is currently available in","type":"text"},{"text":" ","type":"text"},{"isActive":true,"identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","type":"reference"},{"text":".","type":"text"},{"text":" ","type":"text"},{"text":"Please reach out to Auth0 support to get it enabled for your tenant.","type":"text"}]},{"text":"Scopes Required","level":2,"anchor":"Scopes-Required","type":"heading"},{"type":"paragraph","inlineContent":[{"code":"create:me:authentication_methods","type":"codeVoice"}]},{"text":"Usage","level":2,"anchor":"Usage","type":"heading"},{"syntax":"swift","type":"codeListing","code":["Auth0"," .myAccount(token: apiCredentials.accessToken)"," .authenticationMethods"," .passkeyEnrollmentChallenge()"," .start { result in"," switch result {"," case .success(let enrollmentChallenge):"," print(\"Obtained enrollment challenge: \\(enrollmentChallenge)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"]},{"type":"paragraph","inlineContent":[{"text":"Use the challenge with ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialprovider"},{"text":" ","type":"text"},{"text":"from the ","type":"text"},{"code":"AuthenticationServices","type":"codeVoice"},{"text":" framework to generate a new passkey credential. It will be delivered through the ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate"},{"text":" ","type":"text"},{"text":"delegate. Check out ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/supporting-passkeys#Register-a-new-account-on-a-service"},{"text":" ","type":"text"},{"text":"to learn more.","type":"text"}]},{"syntax":"swift","type":"codeListing","code":["let credentialProvider = ASAuthorizationPlatformPublicKeyCredentialProvider("," relyingPartyIdentifier: enrollmentChallenge.relyingPartyId",")","","let request = credentialProvider.createCredentialRegistrationRequest("," challenge: enrollmentChallenge.challengeData,"," name: enrollmentChallenge.userName,"," userID: enrollmentChallenge.userId",")","","let authController = ASAuthorizationController(authorizationRequests: [request])","authController.delegate = self \/\/ ASAuthorizationControllerDelegate","authController.presentationContextProvider = self","authController.performRequests()"]},{"type":"paragraph","inlineContent":[{"type":"text","text":"Then, call "},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/enroll(passkey:challenge:)"},{"type":"text","text":" with the created passkey credential and the challenge to complete the"},{"type":"text","text":" "},{"type":"text","text":"enrollment."}]}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods"]]},"kind":"symbol","seeAlsoSections":[{"identifiers":["https:\/\/developer.apple.com\/documentation\/authenticationservices\/supporting-passkeys#Register-a-new-account-on-a-service"],"title":"Related Documentation","anchor":"Related-Documentation"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods":{"url":"\/documentation\/auth0\/myaccountauthenticationmethods","kind":"symbol","type":"topic","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountAuthenticationMethods","kind":"identifier"}],"navigatorTitle":[{"text":"MyAccountAuthenticationMethods","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods","title":"MyAccountAuthenticationMethods","abstract":[{"type":"text","text":"My Account API sub-client for managing the current user’s authentication methods."}]},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/request","kind":"symbol","abstract":[{"type":"text","text":"Auth0 API request."}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods/enroll(passkey:challenge:)":{"type":"topic","title":"enroll(passkey:challenge:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/enroll(passkey:challenge:)","required":true,"role":"symbol","abstract":[{"text":"Enrolls a new passkey credential. This is the last part of the enrollment flow.","type":"text"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"enroll","kind":"identifier"},{"text":"(","kind":"text"},{"text":"passkey","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"NewPasskey","kind":"typeIdentifier","preciseIdentifier":"s:5Auth010NewPasskeyP"},{"text":", ","kind":"text"},{"text":"challenge","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"PasskeyEnrollmentChallenge","kind":"typeIdentifier","preciseIdentifier":"s:5Auth026PasskeyEnrollmentChallengeV"},{"text":") -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"PasskeyAuthenticationMethod","kind":"typeIdentifier","preciseIdentifier":"s:5Auth027PasskeyAuthenticationMethodV"},{"text":", ","kind":"text"},{"text":"MyAccountError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth014MyAccountErrorV"},{"text":">","kind":"text"}],"url":"\/documentation\/auth0\/myaccountauthenticationmethods\/enroll(passkey:challenge:)"},"https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access":{"identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","title":"Early Access","type":"link","titleInlineContent":[{"type":"text","text":"Early Access"}],"url":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access"},"https://developer.apple.com/documentation/authenticationservices/supporting-passkeys#Register-a-new-account-on-a-service":{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/supporting-passkeys#Register-a-new-account-on-a-service","title":"Supporting passkeys","type":"link","titleInlineContent":[{"type":"text","text":"Supporting passkeys"}],"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/supporting-passkeys#Register-a-new-account-on-a-service"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","type":"topic","kind":"symbol","abstract":[{"text":"Represents an error during a request to the Auth0 My Account API.","type":"text"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountError","kind":"identifier"}],"navigatorTitle":[{"text":"MyAccountError","kind":"identifier"}],"url":"\/documentation\/auth0\/myaccounterror","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods/passkeyEnrollmentChallenge(userIdentityId:connection:)-71dk8":{"title":"passkeyEnrollmentChallenge(userIdentityId:connection:)","abstract":[{"type":"text","text":"Requests a challenge for enrolling a new passkey. This is the first part of the enrollment flow."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/passkeyEnrollmentChallenge(userIdentityId:connection:)-71dk8","kind":"symbol","role":"symbol","url":"\/documentation\/auth0\/myaccountauthenticationmethods\/passkeyenrollmentchallenge(useridentityid:connection:)-71dk8","type":"topic","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"passkeyEnrollmentChallenge","kind":"identifier"},{"text":"(","kind":"text"},{"text":"userIdentityId","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?) -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"PasskeyEnrollmentChallenge","kind":"typeIdentifier","preciseIdentifier":"s:5Auth026PasskeyEnrollmentChallengeV"},{"text":", ","kind":"text"},{"text":"MyAccountError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth014MyAccountErrorV"},{"text":">","kind":"text"}]},"https://developer.apple.com/documentation/authenticationservices/asauthorizationplatformpublickeycredentialprovider":{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialprovider","title":"ASAuthorizationPlatformPublicKeyCredentialProvider","type":"link","titleInlineContent":[{"code":"ASAuthorizationPlatformPublicKeyCredentialProvider","type":"codeVoice"}],"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialprovider"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyEnrollmentChallenge":{"title":"PasskeyEnrollmentChallenge","role":"symbol","url":"\/documentation\/auth0\/passkeyenrollmentchallenge","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyEnrollmentChallenge","kind":"identifier"}],"type":"topic","navigatorTitle":[{"text":"PasskeyEnrollmentChallenge","kind":"identifier"}],"abstract":[{"type":"text","text":"A passkey enrollment challenge."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge","kind":"symbol"},"https://auth0.com/docs/manage-users/user-accounts/user-account-linking":{"identifier":"https:\/\/auth0.com\/docs\/manage-users\/user-accounts\/user-account-linking","title":"linked account","type":"link","titleInlineContent":[{"text":"linked account","type":"text"}],"url":"https:\/\/auth0.com\/docs\/manage-users\/user-accounts\/user-account-linking"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"https://developer.apple.com/documentation/authenticationservices/asauthorizationcontrollerdelegate":{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","title":"ASAuthorizationControllerDelegate","type":"link","titleInlineContent":[{"code":"ASAuthorizationControllerDelegate","type":"codeVoice"}],"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate"}}} \ No newline at end of file +{"metadata":{"platforms":[{"beta":false,"introducedAt":"16.6","deprecated":false,"name":"iOS","unavailable":false},{"beta":false,"introducedAt":"16.6","deprecated":false,"name":"iPadOS","unavailable":false},{"beta":false,"introducedAt":"16.6","deprecated":false,"name":"Mac Catalyst","unavailable":false},{"beta":false,"introducedAt":"13.5","deprecated":false,"name":"macOS","unavailable":false},{"beta":false,"introducedAt":"1.0","deprecated":false,"name":"visionOS","unavailable":false}],"symbolKind":"method","roleHeading":"Instance Method","title":"passkeyEnrollmentChallenge(userIdentityId:connection:)","extendedModule":"Auth0","externalID":"s:5Auth030MyAccountAuthenticationMethodsPAAE26passkeyEnrollmentChallenge14userIdentityId10connectionAA7RequestVyAA07PasskeygH0VAA0bC5ErrorVGSSSg_ANtF","modules":[{"name":"Auth0"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"passkeyEnrollmentChallenge","kind":"identifier"},{"text":"(","kind":"text"},{"text":"userIdentityId","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth026PasskeyEnrollmentChallengeV","text":"PasskeyEnrollmentChallenge","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth014MyAccountErrorV","text":"MyAccountError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"role":"symbol"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/myaccountauthenticationmethods\/passkeyenrollmentchallenge(useridentityid:connection:)-71dk8"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/passkeyEnrollmentChallenge(userIdentityId:connection:)-71dk8"},"kind":"symbol","abstract":[{"type":"text","text":"Requests a challenge for enrolling a new passkey. This is the first part of the enrollment flow."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods"]]},"seeAlsoSections":[{"title":"Related Documentation","anchor":"Related-Documentation","identifiers":["https:\/\/developer.apple.com\/documentation\/authenticationservices\/supporting-passkeys#Register-a-new-account-on-a-service"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"passkeyEnrollmentChallenge","kind":"identifier"},{"text":"(","kind":"text"},{"text":"userIdentityId","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"? = nil, ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"? = nil) -> ","kind":"text"},{"text":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"PasskeyEnrollmentChallenge","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge","kind":"typeIdentifier","preciseIdentifier":"s:5Auth026PasskeyEnrollmentChallengeV"},{"text":", ","kind":"text"},{"text":"MyAccountError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth014MyAccountErrorV"},{"text":">","kind":"text"}]}]},{"parameters":[{"content":[{"inlineContent":[{"type":"text","text":"Unique identifier of the current user’s identity. Needed if the user logged in with a "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/manage-users\/user-accounts\/user-account-linking","isActive":true},{"type":"text","text":"."},{"type":"text","text":" "},{"type":"text","text":"Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"type":"paragraph"}],"name":"userIdentityId"},{"content":[{"inlineContent":[{"type":"text","text":"Name of the database connection where the user is stored. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"type":"paragraph"}],"name":"connection"}],"kind":"parameters"},{"kind":"content","content":[{"type":"heading","text":"Return Value","anchor":"return-value","level":2},{"type":"paragraph","inlineContent":[{"text":"A request that will yield a passkey enrollment challenge.","type":"text"}]}]},{"kind":"content","content":[{"type":"heading","text":"Discussion","anchor":"discussion","level":2},{"type":"paragraph","inlineContent":[{"text":"You can specify an optional user identity identifier and an optional database connection name. If a","type":"text"},{"text":" ","type":"text"},{"text":"connection name is not specified, your tenant’s default directory will be used.","type":"text"}]},{"type":"heading","text":"Availability","anchor":"Availability","level":2},{"type":"paragraph","inlineContent":[{"text":"This feature is currently available in","type":"text"},{"text":" ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","isActive":true,"type":"reference"},{"text":".","type":"text"},{"text":" ","type":"text"},{"text":"Please reach out to Auth0 support to get it enabled for your tenant.","type":"text"}]},{"type":"heading","text":"Scopes Required","anchor":"Scopes-Required","level":2},{"type":"paragraph","inlineContent":[{"code":"create:me:authentication_methods","type":"codeVoice"}]},{"type":"heading","text":"Usage","anchor":"Usage","level":2},{"type":"codeListing","syntax":"swift","code":["Auth0"," .myAccount(token: apiCredentials.accessToken)"," .authenticationMethods"," .passkeyEnrollmentChallenge()"," .start { result in"," switch result {"," case .success(let enrollmentChallenge):"," print(\"Obtained enrollment challenge: \\(enrollmentChallenge)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"]},{"type":"paragraph","inlineContent":[{"text":"Use the challenge with ","type":"text"},{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialprovider","isActive":true,"type":"reference"},{"text":" ","type":"text"},{"text":"from the ","type":"text"},{"code":"AuthenticationServices","type":"codeVoice"},{"text":" framework to generate a new passkey credential. It will be delivered through the ","type":"text"},{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","isActive":true,"type":"reference"},{"text":" ","type":"text"},{"text":"delegate. Check out ","type":"text"},{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/supporting-passkeys#Register-a-new-account-on-a-service","isActive":true,"type":"reference"},{"text":" ","type":"text"},{"text":"to learn more.","type":"text"}]},{"type":"codeListing","syntax":"swift","code":["let credentialProvider = ASAuthorizationPlatformPublicKeyCredentialProvider("," relyingPartyIdentifier: enrollmentChallenge.relyingPartyId",")","","let request = credentialProvider.createCredentialRegistrationRequest("," challenge: enrollmentChallenge.challengeData,"," name: enrollmentChallenge.userName,"," userID: enrollmentChallenge.userId",")","","let authController = ASAuthorizationController(authorizationRequests: [request])","authController.delegate = self \/\/ ASAuthorizationControllerDelegate","authController.presentationContextProvider = self","authController.performRequests()"]},{"type":"paragraph","inlineContent":[{"text":"Then, call ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/enroll(passkey:challenge:)","isActive":true,"type":"reference"},{"text":" with the created passkey credential and the challenge to complete the","type":"text"},{"text":" ","type":"text"},{"text":"enrollment.","type":"text"}]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Request":{"title":"Request","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"abstract":[{"text":"Auth0 API request.","type":"text"}],"url":"\/documentation\/auth0\/request","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods/passkeyEnrollmentChallenge(userIdentityId:connection:)-71dk8":{"type":"topic","abstract":[{"type":"text","text":"Requests a challenge for enrolling a new passkey. This is the first part of the enrollment flow."}],"title":"passkeyEnrollmentChallenge(userIdentityId:connection:)","url":"\/documentation\/auth0\/myaccountauthenticationmethods\/passkeyenrollmentchallenge(useridentityid:connection:)-71dk8","kind":"symbol","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"passkeyEnrollmentChallenge","kind":"identifier"},{"text":"(","kind":"text"},{"text":"userIdentityId","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?) -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"PasskeyEnrollmentChallenge","kind":"typeIdentifier","preciseIdentifier":"s:5Auth026PasskeyEnrollmentChallengeV"},{"text":", ","kind":"text"},{"text":"MyAccountError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth014MyAccountErrorV"},{"text":">","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/passkeyEnrollmentChallenge(userIdentityId:connection:)-71dk8"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods":{"role":"symbol","title":"MyAccountAuthenticationMethods","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"MyAccountAuthenticationMethods"}],"navigatorTitle":[{"text":"MyAccountAuthenticationMethods","kind":"identifier"}],"abstract":[{"type":"text","text":"My Account API sub-client for managing the current user’s authentication methods."}],"kind":"symbol","url":"\/documentation\/auth0\/myaccountauthenticationmethods","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods/enroll(passkey:challenge:)":{"kind":"symbol","title":"enroll(passkey:challenge:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"enroll","kind":"identifier"},{"text":"(","kind":"text"},{"text":"passkey","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"NewPasskey","preciseIdentifier":"s:5Auth010NewPasskeyP","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"challenge","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth026PasskeyEnrollmentChallengeV","kind":"typeIdentifier","text":"PasskeyEnrollmentChallenge"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth027PasskeyAuthenticationMethodV","text":"PasskeyAuthenticationMethod"},{"kind":"text","text":", "},{"text":"MyAccountError","preciseIdentifier":"s:5Auth014MyAccountErrorV","kind":"typeIdentifier"},{"kind":"text","text":">"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/enroll(passkey:challenge:)","required":true,"abstract":[{"type":"text","text":"Enrolls a new passkey credential. This is the last part of the enrollment flow."}],"url":"\/documentation\/auth0\/myaccountauthenticationmethods\/enroll(passkey:challenge:)"},"https://developer.apple.com/documentation/authenticationservices/asauthorizationplatformpublickeycredentialprovider":{"title":"ASAuthorizationPlatformPublicKeyCredentialProvider","type":"link","titleInlineContent":[{"type":"codeVoice","code":"ASAuthorizationPlatformPublicKeyCredentialProvider"}],"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialprovider","url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialprovider"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyEnrollmentChallenge":{"role":"symbol","title":"PasskeyEnrollmentChallenge","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyEnrollmentChallenge","kind":"identifier"}],"navigatorTitle":[{"text":"PasskeyEnrollmentChallenge","kind":"identifier"}],"abstract":[{"type":"text","text":"A passkey enrollment challenge."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge","url":"\/documentation\/auth0\/passkeyenrollmentchallenge","type":"topic"},"https://developer.apple.com/documentation/authenticationservices/supporting-passkeys#Register-a-new-account-on-a-service":{"title":"Supporting passkeys","type":"link","titleInlineContent":[{"type":"text","text":"Supporting passkeys"}],"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/supporting-passkeys#Register-a-new-account-on-a-service","url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/supporting-passkeys#Register-a-new-account-on-a-service"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccountError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 My Account API."}],"url":"\/documentation\/auth0\/myaccounterror","navigatorTitle":[{"kind":"identifier","text":"MyAccountError"}]},"https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access":{"title":"Early Access","type":"link","titleInlineContent":[{"type":"text","text":"Early Access"}],"identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","url":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access"},"https://developer.apple.com/documentation/authenticationservices/asauthorizationcontrollerdelegate":{"title":"ASAuthorizationControllerDelegate","type":"link","titleInlineContent":[{"type":"codeVoice","code":"ASAuthorizationControllerDelegate"}],"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate"},"https://auth0.com/docs/manage-users/user-accounts/user-account-linking":{"title":"linked account","type":"link","titleInlineContent":[{"type":"text","text":"linked account"}],"identifier":"https:\/\/auth0.com\/docs\/manage-users\/user-accounts\/user-account-linking","url":"https:\/\/auth0.com\/docs\/manage-users\/user-accounts\/user-account-linking"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/myaccountauthenticationmethods/passkeyenrollmentchallenge(useridentityid:connection:).json b/docs/data/documentation/auth0/myaccountauthenticationmethods/passkeyenrollmentchallenge(useridentityid:connection:).json index 875440a3a..2d01d648e 100644 --- a/docs/data/documentation/auth0/myaccountauthenticationmethods/passkeyenrollmentchallenge(useridentityid:connection:).json +++ b/docs/data/documentation/auth0/myaccountauthenticationmethods/passkeyenrollmentchallenge(useridentityid:connection:).json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"passkeyEnrollmentChallenge"},{"kind":"text","text":"("},{"kind":"externalParam","text":"userIdentityId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"?) -> ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge","preciseIdentifier":"s:5Auth026PasskeyEnrollmentChallengeV","text":"PasskeyEnrollmentChallenge","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","preciseIdentifier":"s:5Auth014MyAccountErrorV","text":"MyAccountError","kind":"typeIdentifier"},{"text":">","kind":"text"}]}]},{"kind":"parameters","parameters":[{"name":"userIdentityId","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Unique identifier of the current user’s identity. Needed if the user logged in with a "},{"identifier":"https:\/\/auth0.com\/docs\/manage-users\/user-accounts\/user-account-linking","isActive":true,"type":"reference"},{"type":"text","text":"."},{"type":"text","text":" "},{"type":"text","text":"Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}]}]},{"name":"connection","content":[{"type":"paragraph","inlineContent":[{"text":"Name of the database connection where the user is stored. Defaults to ","type":"text"},{"code":"nil","type":"codeVoice"},{"text":".","type":"text"}]}]}]},{"kind":"content","content":[{"anchor":"return-value","type":"heading","text":"Return Value","level":2},{"inlineContent":[{"text":"A request that will yield a passkey enrollment challenge.","type":"text"}],"type":"paragraph"}]},{"kind":"content","content":[{"type":"heading","level":2,"text":"Discussion","anchor":"discussion"},{"type":"paragraph","inlineContent":[{"type":"text","text":"You can specify an optional user identity identifier and an optional database connection name. If a"},{"type":"text","text":" "},{"type":"text","text":"connection name is not specified, your tenant’s default directory will be used."}]},{"type":"heading","level":2,"text":"Availability","anchor":"Availability"},{"type":"paragraph","inlineContent":[{"text":"This feature is currently available in","type":"text"},{"text":" ","type":"text"},{"type":"reference","isActive":true,"identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access"},{"text":".","type":"text"},{"text":" ","type":"text"},{"text":"Please reach out to Auth0 support to get it enabled for your tenant.","type":"text"}]},{"type":"heading","level":2,"text":"Scopes Required","anchor":"Scopes-Required"},{"type":"paragraph","inlineContent":[{"code":"create:me:authentication_methods","type":"codeVoice"}]},{"type":"heading","level":2,"text":"Usage","anchor":"Usage"},{"type":"codeListing","code":["Auth0"," .myAccount(token: apiCredentials.accessToken)"," .authenticationMethods"," .passkeyEnrollmentChallenge()"," .start { result in"," switch result {"," case .success(let enrollmentChallenge):"," print(\"Obtained enrollment challenge: \\(enrollmentChallenge)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"],"syntax":"swift"},{"type":"paragraph","inlineContent":[{"text":"Use the challenge with ","type":"text"},{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialprovider","type":"reference","isActive":true},{"text":" ","type":"text"},{"text":"from the ","type":"text"},{"type":"codeVoice","code":"AuthenticationServices"},{"text":" framework to generate a new passkey credential. It will be delivered through the ","type":"text"},{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","type":"reference","isActive":true},{"text":" ","type":"text"},{"text":"delegate. Check out ","type":"text"},{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/supporting-passkeys#Register-a-new-account-on-a-service","type":"reference","isActive":true},{"text":" ","type":"text"},{"text":"to learn more.","type":"text"}]},{"type":"codeListing","code":["let credentialProvider = ASAuthorizationPlatformPublicKeyCredentialProvider("," relyingPartyIdentifier: enrollmentChallenge.relyingPartyId",")","","let request = credentialProvider.createCredentialRegistrationRequest("," challenge: enrollmentChallenge.challengeData,"," name: enrollmentChallenge.userName,"," userID: enrollmentChallenge.userId",")","","let authController = ASAuthorizationController(authorizationRequests: [request])","authController.delegate = self \/\/ ASAuthorizationControllerDelegate","authController.presentationContextProvider = self","authController.performRequests()"],"syntax":"swift"},{"type":"paragraph","inlineContent":[{"text":"Then, call ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/enroll(passkey:challenge:)","isActive":true,"type":"reference"},{"text":" with the created passkey credential and the challenge to complete the","type":"text"},{"text":" ","type":"text"},{"text":"enrollment.","type":"text"}]}]}],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/developer.apple.com\/documentation\/authenticationservices\/supporting-passkeys#Register-a-new-account-on-a-service"],"anchor":"Related-Documentation"}],"sections":[],"abstract":[{"type":"text","text":"Requests a challenge for enrolling a new passkey. This is the first part of the enrollment flow."}],"defaultImplementationsSections":[{"title":"MyAccountAuthenticationMethods Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/passkeyEnrollmentChallenge(userIdentityId:connection:)-71dk8"],"anchor":"MyAccountAuthenticationMethods-Implementations"}],"metadata":{"symbolKind":"method","modules":[{"name":"Auth0"}],"externalID":"s:5Auth030MyAccountAuthenticationMethodsP26passkeyEnrollmentChallenge14userIdentityId10connectionAA7RequestVyAA07PasskeygH0VAA0bC5ErrorVGSSSg_ANtF","roleHeading":"Instance Method","required":true,"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"passkeyEnrollmentChallenge"},{"kind":"text","text":"("},{"kind":"externalParam","text":"userIdentityId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth026PasskeyEnrollmentChallengeV","text":"PasskeyEnrollmentChallenge"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth014MyAccountErrorV","text":"MyAccountError"},{"kind":"text","text":">"}],"platforms":[{"introducedAt":"16.6","beta":false,"name":"iOS","unavailable":false,"deprecated":false},{"introducedAt":"16.6","beta":false,"name":"iPadOS","unavailable":false,"deprecated":false},{"introducedAt":"16.6","beta":false,"name":"Mac Catalyst","unavailable":false,"deprecated":false},{"introducedAt":"13.5","beta":false,"name":"macOS","unavailable":false,"deprecated":false},{"introducedAt":"1.0","beta":false,"name":"visionOS","unavailable":false,"deprecated":false}],"title":"passkeyEnrollmentChallenge(userIdentityId:connection:)","role":"symbol"},"schemaVersion":{"major":0,"patch":0,"minor":3},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/passkeyEnrollmentChallenge(userIdentityId:connection:)","interfaceLanguage":"swift"},"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/myaccountauthenticationmethods\/passkeyenrollmentchallenge(useridentityid:connection:)"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods/passkeyEnrollmentChallenge(userIdentityId:connection:)-71dk8":{"title":"passkeyEnrollmentChallenge(userIdentityId:connection:)","abstract":[{"type":"text","text":"Requests a challenge for enrolling a new passkey. This is the first part of the enrollment flow."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/passkeyEnrollmentChallenge(userIdentityId:connection:)-71dk8","kind":"symbol","role":"symbol","url":"\/documentation\/auth0\/myaccountauthenticationmethods\/passkeyenrollmentchallenge(useridentityid:connection:)-71dk8","type":"topic","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"passkeyEnrollmentChallenge","kind":"identifier"},{"text":"(","kind":"text"},{"text":"userIdentityId","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?) -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"PasskeyEnrollmentChallenge","kind":"typeIdentifier","preciseIdentifier":"s:5Auth026PasskeyEnrollmentChallengeV"},{"text":", ","kind":"text"},{"text":"MyAccountError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth014MyAccountErrorV"},{"text":">","kind":"text"}]},"https://developer.apple.com/documentation/authenticationservices/asauthorizationcontrollerdelegate":{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","title":"ASAuthorizationControllerDelegate","titleInlineContent":[{"code":"ASAuthorizationControllerDelegate","type":"codeVoice"}],"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods/enroll(passkey:challenge:)":{"type":"topic","title":"enroll(passkey:challenge:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/enroll(passkey:challenge:)","required":true,"role":"symbol","abstract":[{"text":"Enrolls a new passkey credential. This is the last part of the enrollment flow.","type":"text"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"enroll","kind":"identifier"},{"text":"(","kind":"text"},{"text":"passkey","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"NewPasskey","kind":"typeIdentifier","preciseIdentifier":"s:5Auth010NewPasskeyP"},{"text":", ","kind":"text"},{"text":"challenge","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"PasskeyEnrollmentChallenge","kind":"typeIdentifier","preciseIdentifier":"s:5Auth026PasskeyEnrollmentChallengeV"},{"text":") -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"PasskeyAuthenticationMethod","kind":"typeIdentifier","preciseIdentifier":"s:5Auth027PasskeyAuthenticationMethodV"},{"text":", ","kind":"text"},{"text":"MyAccountError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth014MyAccountErrorV"},{"text":">","kind":"text"}],"url":"\/documentation\/auth0\/myaccountauthenticationmethods\/enroll(passkey:challenge:)"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods/passkeyEnrollmentChallenge(userIdentityId:connection:)":{"type":"topic","title":"passkeyEnrollmentChallenge(userIdentityId:connection:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/passkeyEnrollmentChallenge(userIdentityId:connection:)","required":true,"role":"symbol","abstract":[{"type":"text","text":"Requests a challenge for enrolling a new passkey. This is the first part of the enrollment flow."}],"defaultImplementations":1,"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"passkeyEnrollmentChallenge"},{"kind":"text","text":"("},{"kind":"externalParam","text":"userIdentityId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth026PasskeyEnrollmentChallengeV","text":"PasskeyEnrollmentChallenge"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth014MyAccountErrorV","text":"MyAccountError"},{"kind":"text","text":">"}],"url":"\/documentation\/auth0\/myaccountauthenticationmethods\/passkeyenrollmentchallenge(useridentityid:connection:)"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods":{"url":"\/documentation\/auth0\/myaccountauthenticationmethods","kind":"symbol","type":"topic","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountAuthenticationMethods","kind":"identifier"}],"navigatorTitle":[{"text":"MyAccountAuthenticationMethods","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods","title":"MyAccountAuthenticationMethods","abstract":[{"type":"text","text":"My Account API sub-client for managing the current user’s authentication methods."}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","type":"topic","kind":"symbol","abstract":[{"text":"Represents an error during a request to the Auth0 My Account API.","type":"text"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountError","kind":"identifier"}],"navigatorTitle":[{"text":"MyAccountError","kind":"identifier"}],"url":"\/documentation\/auth0\/myaccounterror","role":"symbol"},"https://developer.apple.com/documentation/authenticationservices/asauthorizationplatformpublickeycredentialprovider":{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialprovider","title":"ASAuthorizationPlatformPublicKeyCredentialProvider","titleInlineContent":[{"code":"ASAuthorizationPlatformPublicKeyCredentialProvider","type":"codeVoice"}],"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialprovider","type":"link"},"https://developer.apple.com/documentation/authenticationservices/supporting-passkeys#Register-a-new-account-on-a-service":{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/supporting-passkeys#Register-a-new-account-on-a-service","title":"Supporting passkeys","titleInlineContent":[{"text":"Supporting passkeys","type":"text"}],"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/supporting-passkeys#Register-a-new-account-on-a-service","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyEnrollmentChallenge":{"title":"PasskeyEnrollmentChallenge","role":"symbol","url":"\/documentation\/auth0\/passkeyenrollmentchallenge","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyEnrollmentChallenge","kind":"identifier"}],"type":"topic","navigatorTitle":[{"text":"PasskeyEnrollmentChallenge","kind":"identifier"}],"abstract":[{"type":"text","text":"A passkey enrollment challenge."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/request","kind":"symbol","abstract":[{"type":"text","text":"Auth0 API request."}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access":{"identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","title":"Early Access","titleInlineContent":[{"text":"Early Access","type":"text"}],"url":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","type":"link"},"https://auth0.com/docs/manage-users/user-accounts/user-account-linking":{"identifier":"https:\/\/auth0.com\/docs\/manage-users\/user-accounts\/user-account-linking","title":"linked account","titleInlineContent":[{"text":"linked account","type":"text"}],"url":"https:\/\/auth0.com\/docs\/manage-users\/user-accounts\/user-account-linking","type":"link"}}} \ No newline at end of file +{"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"passkeyEnrollmentChallenge"},{"kind":"text","text":"("},{"kind":"externalParam","text":"userIdentityId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?) -> "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge","kind":"typeIdentifier","text":"PasskeyEnrollmentChallenge","preciseIdentifier":"s:5Auth026PasskeyEnrollmentChallengeV"},{"kind":"text","text":", "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","kind":"typeIdentifier","text":"MyAccountError","preciseIdentifier":"s:5Auth014MyAccountErrorV"},{"kind":"text","text":">"}]}],"kind":"declarations"},{"parameters":[{"content":[{"inlineContent":[{"text":"Unique identifier of the current user’s identity. Needed if the user logged in with a ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/manage-users\/user-accounts\/user-account-linking","isActive":true,"type":"reference"},{"text":".","type":"text"},{"text":" ","type":"text"},{"text":"Defaults to ","type":"text"},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"type":"paragraph"}],"name":"userIdentityId"},{"content":[{"inlineContent":[{"type":"text","text":"Name of the database connection where the user is stored. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"type":"paragraph"}],"name":"connection"}],"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 passkey enrollment challenge."}]}],"kind":"content"},{"content":[{"level":2,"type":"heading","anchor":"discussion","text":"Discussion"},{"type":"paragraph","inlineContent":[{"type":"text","text":"You can specify an optional user identity identifier and an optional database connection name. If a"},{"type":"text","text":" "},{"type":"text","text":"connection name is not specified, your tenant’s default directory will be used."}]},{"level":2,"type":"heading","anchor":"Availability","text":"Availability"},{"type":"paragraph","inlineContent":[{"type":"text","text":"This feature is currently available in"},{"type":"text","text":" "},{"identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","type":"reference","isActive":true},{"type":"text","text":"."},{"type":"text","text":" "},{"type":"text","text":"Please reach out to Auth0 support to get it enabled for your tenant."}]},{"level":2,"type":"heading","anchor":"Scopes-Required","text":"Scopes Required"},{"type":"paragraph","inlineContent":[{"code":"create:me:authentication_methods","type":"codeVoice"}]},{"level":2,"type":"heading","anchor":"Usage","text":"Usage"},{"type":"codeListing","syntax":"swift","code":["Auth0"," .myAccount(token: apiCredentials.accessToken)"," .authenticationMethods"," .passkeyEnrollmentChallenge()"," .start { result in"," switch result {"," case .success(let enrollmentChallenge):"," print(\"Obtained enrollment challenge: \\(enrollmentChallenge)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"]},{"type":"paragraph","inlineContent":[{"type":"text","text":"Use the challenge with "},{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialprovider","type":"reference","isActive":true},{"type":"text","text":" "},{"type":"text","text":"from the "},{"code":"AuthenticationServices","type":"codeVoice"},{"type":"text","text":" framework to generate a new passkey credential. It will be delivered through the "},{"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","isActive":true},{"type":"text","text":" "},{"type":"text","text":"delegate. Check out "},{"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/supporting-passkeys#Register-a-new-account-on-a-service","isActive":true},{"type":"text","text":" "},{"type":"text","text":"to learn more."}]},{"type":"codeListing","syntax":"swift","code":["let credentialProvider = ASAuthorizationPlatformPublicKeyCredentialProvider("," relyingPartyIdentifier: enrollmentChallenge.relyingPartyId",")","","let request = credentialProvider.createCredentialRegistrationRequest("," challenge: enrollmentChallenge.challengeData,"," name: enrollmentChallenge.userName,"," userID: enrollmentChallenge.userId",")","","let authController = ASAuthorizationController(authorizationRequests: [request])","authController.delegate = self \/\/ ASAuthorizationControllerDelegate","authController.presentationContextProvider = self","authController.performRequests()"]},{"type":"paragraph","inlineContent":[{"type":"text","text":"Then, call "},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/enroll(passkey:challenge:)"},{"type":"text","text":" with the created passkey credential and the challenge to complete the"},{"type":"text","text":" "},{"type":"text","text":"enrollment."}]}],"kind":"content"}],"sections":[],"abstract":[{"type":"text","text":"Requests a challenge for enrolling a new passkey. This is the first part of the enrollment flow."}],"kind":"symbol","defaultImplementationsSections":[{"title":"MyAccountAuthenticationMethods Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/passkeyEnrollmentChallenge(userIdentityId:connection:)-71dk8"],"anchor":"MyAccountAuthenticationMethods-Implementations"}],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/developer.apple.com\/documentation\/authenticationservices\/supporting-passkeys#Register-a-new-account-on-a-service"],"anchor":"Related-Documentation"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/myaccountauthenticationmethods\/passkeyenrollmentchallenge(useridentityid:connection:)"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/passkeyEnrollmentChallenge(userIdentityId:connection:)","interfaceLanguage":"swift"},"metadata":{"roleHeading":"Instance Method","symbolKind":"method","title":"passkeyEnrollmentChallenge(userIdentityId:connection:)","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"passkeyEnrollmentChallenge"},{"kind":"text","text":"("},{"kind":"externalParam","text":"userIdentityId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth026PasskeyEnrollmentChallengeV","text":"PasskeyEnrollmentChallenge"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth014MyAccountErrorV","text":"MyAccountError"},{"kind":"text","text":">"}],"required":true,"externalID":"s:5Auth030MyAccountAuthenticationMethodsP26passkeyEnrollmentChallenge14userIdentityId10connectionAA7RequestVyAA07PasskeygH0VAA0bC5ErrorVGSSSg_ANtF","modules":[{"name":"Auth0"}],"platforms":[{"beta":false,"name":"iOS","introducedAt":"16.6","unavailable":false,"deprecated":false},{"beta":false,"name":"iPadOS","introducedAt":"16.6","unavailable":false,"deprecated":false},{"beta":false,"name":"Mac Catalyst","introducedAt":"16.6","unavailable":false,"deprecated":false},{"beta":false,"name":"macOS","introducedAt":"13.5","unavailable":false,"deprecated":false},{"beta":false,"name":"visionOS","introducedAt":"1.0","unavailable":false,"deprecated":false}]},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasskeyEnrollmentChallenge":{"role":"symbol","title":"PasskeyEnrollmentChallenge","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyEnrollmentChallenge","kind":"identifier"}],"navigatorTitle":[{"text":"PasskeyEnrollmentChallenge","kind":"identifier"}],"abstract":[{"type":"text","text":"A passkey enrollment challenge."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge","url":"\/documentation\/auth0\/passkeyenrollmentchallenge","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods":{"role":"symbol","title":"MyAccountAuthenticationMethods","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"MyAccountAuthenticationMethods"}],"navigatorTitle":[{"text":"MyAccountAuthenticationMethods","kind":"identifier"}],"abstract":[{"type":"text","text":"My Account API sub-client for managing the current user’s authentication methods."}],"kind":"symbol","url":"\/documentation\/auth0\/myaccountauthenticationmethods","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods","type":"topic"},"https://auth0.com/docs/manage-users/user-accounts/user-account-linking":{"title":"linked account","type":"link","identifier":"https:\/\/auth0.com\/docs\/manage-users\/user-accounts\/user-account-linking","titleInlineContent":[{"type":"text","text":"linked account"}],"url":"https:\/\/auth0.com\/docs\/manage-users\/user-accounts\/user-account-linking"},"https://developer.apple.com/documentation/authenticationservices/supporting-passkeys#Register-a-new-account-on-a-service":{"title":"Supporting passkeys","type":"link","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/supporting-passkeys#Register-a-new-account-on-a-service","titleInlineContent":[{"type":"text","text":"Supporting passkeys"}],"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/supporting-passkeys#Register-a-new-account-on-a-service"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods/enroll(passkey:challenge:)":{"kind":"symbol","title":"enroll(passkey:challenge:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"enroll","kind":"identifier"},{"text":"(","kind":"text"},{"text":"passkey","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"NewPasskey","preciseIdentifier":"s:5Auth010NewPasskeyP","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"challenge","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth026PasskeyEnrollmentChallengeV","kind":"typeIdentifier","text":"PasskeyEnrollmentChallenge"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth027PasskeyAuthenticationMethodV","text":"PasskeyAuthenticationMethod"},{"kind":"text","text":", "},{"text":"MyAccountError","preciseIdentifier":"s:5Auth014MyAccountErrorV","kind":"typeIdentifier"},{"kind":"text","text":">"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/enroll(passkey:challenge:)","required":true,"abstract":[{"type":"text","text":"Enrolls a new passkey credential. This is the last part of the enrollment flow."}],"url":"\/documentation\/auth0\/myaccountauthenticationmethods\/enroll(passkey:challenge:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccountError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 My Account API."}],"url":"\/documentation\/auth0\/myaccounterror","navigatorTitle":[{"kind":"identifier","text":"MyAccountError"}]},"https://developer.apple.com/documentation/authenticationservices/asauthorizationplatformpublickeycredentialprovider":{"title":"ASAuthorizationPlatformPublicKeyCredentialProvider","type":"link","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialprovider","titleInlineContent":[{"code":"ASAuthorizationPlatformPublicKeyCredentialProvider","type":"codeVoice"}],"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialprovider"},"https://developer.apple.com/documentation/authenticationservices/asauthorizationcontrollerdelegate":{"title":"ASAuthorizationControllerDelegate","type":"link","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","titleInlineContent":[{"code":"ASAuthorizationControllerDelegate","type":"codeVoice"}],"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate"},"https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access":{"title":"Early Access","type":"link","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","titleInlineContent":[{"type":"text","text":"Early Access"}],"url":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"title":"Request","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"abstract":[{"text":"Auth0 API request.","type":"text"}],"url":"\/documentation\/auth0\/request","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods/passkeyEnrollmentChallenge(userIdentityId:connection:)":{"url":"\/documentation\/auth0\/myaccountauthenticationmethods\/passkeyenrollmentchallenge(useridentityid:connection:)","abstract":[{"type":"text","text":"Requests a challenge for enrolling a new passkey. This is the first part of the enrollment flow."}],"title":"passkeyEnrollmentChallenge(userIdentityId:connection:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"passkeyEnrollmentChallenge","kind":"identifier"},{"text":"(","kind":"text"},{"text":"userIdentityId","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?) -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"PasskeyEnrollmentChallenge","preciseIdentifier":"s:5Auth026PasskeyEnrollmentChallengeV","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"MyAccountError","preciseIdentifier":"s:5Auth014MyAccountErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/passkeyEnrollmentChallenge(userIdentityId:connection:)","required":true,"kind":"symbol","role":"symbol","defaultImplementations":1,"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods/passkeyEnrollmentChallenge(userIdentityId:connection:)-71dk8":{"type":"topic","abstract":[{"type":"text","text":"Requests a challenge for enrolling a new passkey. This is the first part of the enrollment flow."}],"title":"passkeyEnrollmentChallenge(userIdentityId:connection:)","url":"\/documentation\/auth0\/myaccountauthenticationmethods\/passkeyenrollmentchallenge(useridentityid:connection:)-71dk8","kind":"symbol","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"passkeyEnrollmentChallenge","kind":"identifier"},{"text":"(","kind":"text"},{"text":"userIdentityId","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?, ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?) -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"PasskeyEnrollmentChallenge","kind":"typeIdentifier","preciseIdentifier":"s:5Auth026PasskeyEnrollmentChallengeV"},{"text":", ","kind":"text"},{"text":"MyAccountError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth014MyAccountErrorV"},{"text":">","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods\/passkeyEnrollmentChallenge(userIdentityId:connection:)-71dk8"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/myaccountclient.json b/docs/data/documentation/auth0/myaccountclient.json index d33f1befa..fef5b69c9 100644 --- a/docs/data/documentation/auth0/myaccountclient.json +++ b/docs/data/documentation/auth0/myaccountclient.json @@ -1 +1 @@ -{"metadata":{"externalID":"s:5Auth015MyAccountClientP","roleHeading":"Protocol","navigatorTitle":[{"text":"MyAccountClient","kind":"identifier"}],"role":"symbol","symbolKind":"protocol","title":"MyAccountClient","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccountClient"}]},"relationshipsSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable"],"title":"Inherits From","type":"inheritsFrom","kind":"relationships"},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccount","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods"],"title":"Inherited By","type":"inheritedBy","kind":"relationships"}],"abstract":[{"type":"text","text":"A client for the My Account API."},{"type":"text","text":" "},{"type":"text","text":"Adopting types could be either the root client or a leaf sub-client."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"sections":[],"kind":"symbol","seeAlsoSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError"],"title":"Related Documentation","anchor":"Related-Documentation"}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountClient","kind":"identifier"},{"text":" : ","kind":"text"},{"text":"Loggable","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","preciseIdentifier":"s:5Auth08LoggableP"},{"text":", ","kind":"text"},{"text":"Trackable","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable","preciseIdentifier":"s:5Auth09TrackableP"}]}],"kind":"declarations"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountClient"},"schemaVersion":{"minor":3,"patch":0,"major":0},"topicSections":[{"generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountClient\/token","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountClient\/url"],"title":"Instance Properties","anchor":"Instance-Properties"}],"variants":[{"paths":["\/documentation\/auth0\/myaccountclient"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccount":{"fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccount","kind":"identifier"}],"type":"topic","kind":"symbol","url":"\/documentation\/auth0\/myaccount","navigatorTitle":[{"text":"MyAccount","kind":"identifier"}],"abstract":[{"type":"text","text":"My Account API client for managing the current user’s account."}],"title":"MyAccount","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccount"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountClient":{"type":"topic","title":"MyAccountClient","kind":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountClient","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountClient","navigatorTitle":[{"text":"MyAccountClient","kind":"identifier"}],"role":"symbol","abstract":[{"type":"text","text":"A client for the My Account API."},{"type":"text","text":" "},{"type":"text","text":"Adopting types could be either the root client or a leaf sub-client."}],"url":"\/documentation\/auth0\/myaccountclient"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods":{"url":"\/documentation\/auth0\/myaccountauthenticationmethods","kind":"symbol","type":"topic","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountAuthenticationMethods","kind":"identifier"}],"navigatorTitle":[{"text":"MyAccountAuthenticationMethods","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods","title":"MyAccountAuthenticationMethods","abstract":[{"type":"text","text":"My Account API sub-client for managing the current user’s authentication methods."}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountClient/token":{"type":"topic","required":true,"title":"token","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"token"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountClient\/token","abstract":[{"type":"text","text":"An access token for My Account API."}],"url":"\/documentation\/auth0\/myaccountclient\/token"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountClient/url":{"required":true,"url":"\/documentation\/auth0\/myaccountclient\/url","kind":"symbol","abstract":[{"text":"URL of the My Account API.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountClient\/url","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"url"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV","text":"URL"}],"title":"url","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","type":"topic","kind":"symbol","abstract":[{"text":"Represents an error during a request to the Auth0 My Account API.","type":"text"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountError","kind":"identifier"}],"navigatorTitle":[{"text":"MyAccountError","kind":"identifier"}],"url":"\/documentation\/auth0\/myaccounterror","role":"symbol"},"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","url":"\/documentation\/auth0\/trackable","role":"symbol","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Trackable"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable","title":"Trackable","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Trackable"}]},"doc://com.auth0.Auth0/documentation/Auth0/Loggable":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","abstract":[{"type":"text","text":"A type that can log statements for debugging purposes."}],"fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Loggable","kind":"identifier"}],"kind":"symbol","title":"Loggable","type":"topic","role":"symbol","navigatorTitle":[{"text":"Loggable","kind":"identifier"}],"url":"\/documentation\/auth0\/loggable"}}} \ No newline at end of file +{"sections":[],"topicSections":[{"title":"Instance Properties","generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountClient\/token","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountClient\/url"],"anchor":"Instance-Properties"}],"kind":"symbol","seeAlsoSections":[{"title":"Related Documentation","anchor":"Related-Documentation","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"variants":[{"paths":["\/documentation\/auth0\/myaccountclient"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"type":"text","text":"A client for the My Account API."},{"type":"text","text":" "},{"type":"text","text":"Adopting types could be either the root client or a leaf sub-client."}],"schemaVersion":{"patch":0,"major":0,"minor":3},"metadata":{"roleHeading":"Protocol","navigatorTitle":[{"text":"MyAccountClient","kind":"identifier"}],"title":"MyAccountClient","role":"symbol","symbolKind":"protocol","externalID":"s:5Auth015MyAccountClientP","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccountClient"}]},"relationshipsSections":[{"title":"Inherits From","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable"],"type":"inheritsFrom","kind":"relationships"},{"title":"Inherited By","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccount","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods"],"type":"inheritedBy","kind":"relationships"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccountClient"},{"kind":"text","text":" : "},{"preciseIdentifier":"s:5Auth08LoggableP","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","kind":"typeIdentifier","text":"Loggable"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth09TrackableP","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable","kind":"typeIdentifier","text":"Trackable"}],"languages":["swift"],"platforms":["iOS"]}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountClient","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Trackable":{"title":"Trackable","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Trackable"}],"abstract":[{"text":"A type that can send the ","type":"text"},{"code":"Auth0-Client","type":"codeVoice"},{"text":" header on every request to Auth0.","type":"text"}],"url":"\/documentation\/auth0\/trackable","navigatorTitle":[{"kind":"identifier","text":"Trackable"}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccount":{"url":"\/documentation\/auth0\/myaccount","abstract":[{"type":"text","text":"My Account API client for managing the current user’s account."}],"title":"MyAccount","navigatorTitle":[{"text":"MyAccount","kind":"identifier"}],"fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccount"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccount","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountClient/url":{"kind":"symbol","abstract":[{"type":"text","text":"URL of the My Account API."}],"type":"topic","title":"url","url":"\/documentation\/auth0\/myaccountclient\/url","required":true,"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountClient\/url","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"url","kind":"identifier"},{"text":": ","kind":"text"},{"text":"URL","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV"}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountClient/token":{"kind":"symbol","abstract":[{"type":"text","text":"An access token for My Account API."}],"type":"topic","title":"token","url":"\/documentation\/auth0\/myaccountclient\/token","required":true,"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountClient\/token","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"token","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountClient":{"title":"MyAccountClient","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountClient","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccountClient"}],"abstract":[{"text":"A client for the My Account API.","type":"text"},{"text":" ","type":"text"},{"text":"Adopting types could be either the root client or a leaf sub-client.","type":"text"}],"url":"\/documentation\/auth0\/myaccountclient","navigatorTitle":[{"kind":"identifier","text":"MyAccountClient"}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods":{"role":"symbol","title":"MyAccountAuthenticationMethods","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"MyAccountAuthenticationMethods"}],"navigatorTitle":[{"text":"MyAccountAuthenticationMethods","kind":"identifier"}],"abstract":[{"type":"text","text":"My Account API sub-client for managing the current user’s authentication methods."}],"kind":"symbol","url":"\/documentation\/auth0\/myaccountauthenticationmethods","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccountError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 My Account API."}],"url":"\/documentation\/auth0\/myaccounterror","navigatorTitle":[{"kind":"identifier","text":"MyAccountError"}]},"doc://com.auth0.Auth0/documentation/Auth0/Loggable":{"role":"symbol","title":"Loggable","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Loggable"}],"navigatorTitle":[{"text":"Loggable","kind":"identifier"}],"abstract":[{"text":"A type that can log statements for debugging purposes.","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/loggable","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/myaccountclient/token.json b/docs/data/documentation/auth0/myaccountclient/token.json index aede367cc..a1d833ef6 100644 --- a/docs/data/documentation/auth0/myaccountclient/token.json +++ b/docs/data/documentation/auth0/myaccountclient/token.json @@ -1 +1 @@ -{"sections":[],"metadata":{"externalID":"s:5Auth015MyAccountClientP5tokenSSvp","role":"symbol","symbolKind":"property","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"token","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"title":"token","required":true,"roleHeading":"Instance Property","modules":[{"name":"Auth0"}]},"schemaVersion":{"patch":0,"major":0,"minor":3},"abstract":[{"type":"text","text":"An access token for My Account API."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"token","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"languages":["swift"]}]}],"variants":[{"paths":["\/documentation\/auth0\/myaccountclient\/token"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountClient"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountClient\/token"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountClient":{"type":"topic","title":"MyAccountClient","kind":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountClient","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountClient","navigatorTitle":[{"text":"MyAccountClient","kind":"identifier"}],"role":"symbol","abstract":[{"type":"text","text":"A client for the My Account API."},{"type":"text","text":" "},{"type":"text","text":"Adopting types could be either the root client or a leaf sub-client."}],"url":"\/documentation\/auth0\/myaccountclient"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountClient/token":{"type":"topic","required":true,"title":"token","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"token"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountClient\/token","abstract":[{"type":"text","text":"An access token for My Account API."}],"url":"\/documentation\/auth0\/myaccountclient\/token"}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/myaccountclient\/token"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountClient"]]},"abstract":[{"text":"An access token for My Account API.","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"token","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"platforms":["iOS"]}]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"kind":"symbol","sections":[],"metadata":{"externalID":"s:5Auth015MyAccountClientP5tokenSSvp","symbolKind":"property","title":"token","role":"symbol","roleHeading":"Instance Property","required":true,"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"token"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"modules":[{"name":"Auth0"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountClient\/token","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountClient":{"title":"MyAccountClient","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountClient","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccountClient"}],"abstract":[{"text":"A client for the My Account API.","type":"text"},{"text":" ","type":"text"},{"text":"Adopting types could be either the root client or a leaf sub-client.","type":"text"}],"url":"\/documentation\/auth0\/myaccountclient","navigatorTitle":[{"kind":"identifier","text":"MyAccountClient"}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountClient/token":{"kind":"symbol","abstract":[{"type":"text","text":"An access token for My Account API."}],"type":"topic","title":"token","url":"\/documentation\/auth0\/myaccountclient\/token","required":true,"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountClient\/token","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"token","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/myaccountclient/url.json b/docs/data/documentation/auth0/myaccountclient/url.json index a117d963b..a828d6f34 100644 --- a/docs/data/documentation/auth0/myaccountclient/url.json +++ b/docs/data/documentation/auth0/myaccountclient/url.json @@ -1 +1 @@ -{"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountClient\/url"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountClient"]]},"variants":[{"paths":["\/documentation\/auth0\/myaccountclient\/url"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"abstract":[{"type":"text","text":"URL of the My Account API."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"url","kind":"identifier"},{"text":": ","kind":"text"},{"text":"URL","preciseIdentifier":"s:10Foundation3URLV","kind":"typeIdentifier"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}]}],"sections":[],"metadata":{"title":"url","externalID":"s:5Auth015MyAccountClientP3url10Foundation3URLVvp","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"url"},{"kind":"text","text":": "},{"preciseIdentifier":"s:10Foundation3URLV","kind":"typeIdentifier","text":"URL"}],"roleHeading":"Instance Property","required":true,"symbolKind":"property","role":"symbol","modules":[{"name":"Auth0"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/MyAccountClient":{"type":"topic","title":"MyAccountClient","kind":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountClient","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountClient","navigatorTitle":[{"text":"MyAccountClient","kind":"identifier"}],"role":"symbol","abstract":[{"type":"text","text":"A client for the My Account API."},{"type":"text","text":" "},{"type":"text","text":"Adopting types could be either the root client or a leaf sub-client."}],"url":"\/documentation\/auth0\/myaccountclient"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountClient/url":{"required":true,"url":"\/documentation\/auth0\/myaccountclient\/url","kind":"symbol","abstract":[{"text":"URL of the My Account API.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountClient\/url","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"url"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV","text":"URL"}],"title":"url","role":"symbol","type":"topic"}}} \ No newline at end of file +{"metadata":{"symbolKind":"property","title":"url","roleHeading":"Instance Property","externalID":"s:5Auth015MyAccountClientP3url10Foundation3URLVvp","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"url"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"URL","preciseIdentifier":"s:10Foundation3URLV"}],"role":"symbol","required":true},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/myaccountclient\/url"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountClient\/url","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"type":"text","text":"URL of the My Account API."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountClient"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"url"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"URL","preciseIdentifier":"s:10Foundation3URLV"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"languages":["swift"],"platforms":["iOS"]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/MyAccountClient":{"title":"MyAccountClient","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountClient","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccountClient"}],"abstract":[{"text":"A client for the My Account API.","type":"text"},{"text":" ","type":"text"},{"text":"Adopting types could be either the root client or a leaf sub-client.","type":"text"}],"url":"\/documentation\/auth0\/myaccountclient","navigatorTitle":[{"kind":"identifier","text":"MyAccountClient"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountClient/url":{"kind":"symbol","abstract":[{"type":"text","text":"URL of the My Account API."}],"type":"topic","title":"url","url":"\/documentation\/auth0\/myaccountclient\/url","required":true,"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountClient\/url","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"url","kind":"identifier"},{"text":": ","kind":"text"},{"text":"URL","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/myaccounterror.json b/docs/data/documentation/auth0/myaccounterror.json index aa5ec1a53..4a8d0f197 100644 --- a/docs/data/documentation/auth0/myaccounterror.json +++ b/docs/data/documentation/auth0/myaccounterror.json @@ -1 +1 @@ -{"relationshipsSections":[{"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\/s8CopyableP","doc:\/\/com.auth0.Auth0\/s28CustomDebugStringConvertibleP","doc:\/\/com.auth0.Auth0\/SQ","doc:\/\/com.auth0.Auth0\/s5ErrorP","doc:\/\/com.auth0.Auth0\/s8SendableP","doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP"],"kind":"relationships","title":"Conforms To"}],"topicSections":[{"generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/ValidationError"],"anchor":"Structures","title":"Structures"},{"generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/init(info:statusCode:)"],"anchor":"Initializers","title":"Initializers"},{"generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/code","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/debugDescription","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/detail","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/info","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/statusCode","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/title","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/validationErrors"],"anchor":"Instance-Properties","title":"Instance Properties"},{"generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/Auth0APIError-Implementations","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/Auth0Error-Implementations","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/Equatable-Implementations","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/LocalizedError-Implementations"],"anchor":"Default-Implementations","title":"Default Implementations"}],"abstract":[{"text":"Represents an error during a request to the Auth0 My Account API.","type":"text"}],"sections":[],"metadata":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountError","kind":"identifier"}],"modules":[{"name":"Auth0"}],"externalID":"s:5Auth014MyAccountErrorV","symbolKind":"struct","title":"MyAccountError","roleHeading":"Structure","navigatorTitle":[{"text":"MyAccountError","kind":"identifier"}],"role":"symbol"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","interfaceLanguage":"swift"},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccountError"}]}],"kind":"declarations"}],"kind":"symbol","schemaVersion":{"minor":3,"patch":0,"major":0},"variants":[{"paths":["\/documentation\/auth0\/myaccounterror"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/validationErrors":{"role":"symbol","kind":"symbol","title":"validationErrors","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/validationErrors","abstract":[{"text":"All the server-side validation errors.","type":"text"}],"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"validationErrors","kind":"identifier"},{"text":": [","kind":"text"},{"text":"ValidationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth014MyAccountErrorV010ValidationD0V"},{"text":"]?","kind":"text"}],"url":"\/documentation\/auth0\/myaccounterror\/validationerrors","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/init(info:statusCode:)":{"url":"\/documentation\/auth0\/myaccounterror\/init(info:statuscode:)","title":"init(info:statusCode:)","role":"symbol","kind":"symbol","abstract":[{"type":"text","text":"Creates an error from a JSON response."}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/init(info:statusCode:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"info"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"statusCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"},{"kind":"text","text":")"}]},"doc://com.auth0.Auth0/s28CustomDebugStringConvertibleP":{"identifier":"doc:\/\/com.auth0.Auth0\/s28CustomDebugStringConvertibleP","type":"unresolvable","title":"Swift.CustomDebugStringConvertible"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","type":"topic","kind":"symbol","abstract":[{"text":"Represents an error during a request to the Auth0 My Account API.","type":"text"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountError","kind":"identifier"}],"navigatorTitle":[{"text":"MyAccountError","kind":"identifier"}],"url":"\/documentation\/auth0\/myaccounterror","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error":{"url":"\/documentation\/auth0\/auth0error","title":"Auth0Error","kind":"symbol","type":"topic","abstract":[{"type":"text","text":"Generic representation of Auth0 errors."}],"role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Auth0Error"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","navigatorTitle":[{"kind":"identifier","text":"Auth0Error"}]},"doc://com.auth0.Auth0/10Foundation14LocalizedErrorP":{"identifier":"doc:\/\/com.auth0.Auth0\/10Foundation14LocalizedErrorP","title":"Foundation.LocalizedError","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","type":"topic","url":"\/documentation\/auth0\/auth0apierror","title":"Auth0APIError","abstract":[{"type":"text","text":"Generic representation of Auth0 API errors."}],"role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Auth0APIError","kind":"identifier"}],"kind":"symbol","navigatorTitle":[{"text":"Auth0APIError","kind":"identifier"}]},"doc://com.auth0.Auth0/s16SendableMetatypeP":{"identifier":"doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP","type":"unresolvable","title":"Swift.SendableMetatype"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/detail":{"type":"topic","title":"detail","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"detail"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"role":"symbol","abstract":[{"text":"More information about the error.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/detail","url":"\/documentation\/auth0\/myaccounterror\/detail","kind":"symbol"},"doc://com.auth0.Auth0/s8SendableP":{"identifier":"doc:\/\/com.auth0.Auth0\/s8SendableP","title":"Swift.Sendable","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/title":{"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"title","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"title":"title","kind":"symbol","type":"topic","abstract":[{"text":"Error description.","type":"text"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/title","url":"\/documentation\/auth0\/myaccounterror\/title"},"doc://com.auth0.Auth0/s8CopyableP":{"identifier":"doc:\/\/com.auth0.Auth0\/s8CopyableP","type":"unresolvable","title":"Swift.Copyable"},"doc://com.auth0.Auth0/SQ":{"identifier":"doc:\/\/com.auth0.Auth0\/SQ","title":"Swift.Equatable","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/Equatable-Implementations":{"type":"topic","url":"\/documentation\/auth0\/myaccounterror\/equatable-implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/Equatable-Implementations","kind":"article","title":"Equatable Implementations","abstract":[],"role":"collectionGroup"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/LocalizedError-Implementations":{"kind":"article","role":"collectionGroup","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/LocalizedError-Implementations","type":"topic","abstract":[],"url":"\/documentation\/auth0\/myaccounterror\/localizederror-implementations","title":"LocalizedError Implementations"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/ValidationError":{"title":"MyAccountError.ValidationError","abstract":[{"type":"text","text":"A server-side validation error."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/ValidationError","kind":"symbol","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"ValidationError"}],"type":"topic","url":"\/documentation\/auth0\/myaccounterror\/validationerror","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ValidationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/info":{"abstract":[{"text":"Raw error values.","type":"text"}],"title":"info","url":"\/documentation\/auth0\/myaccounterror\/info","type":"topic","role":"symbol","kind":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"info","kind":"identifier"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"]","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/info"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/statusCode":{"url":"\/documentation\/auth0\/myaccounterror\/statuscode","kind":"symbol","abstract":[{"text":"HTTP status code of the response.","type":"text"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/statusCode","role":"symbol","title":"statusCode","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"statusCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"}]},"doc://com.auth0.Auth0/s5ErrorP":{"title":"Swift.Error","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s5ErrorP"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/code":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/code","type":"topic","role":"symbol","kind":"symbol","title":"code","abstract":[{"text":"Error code.","type":"text"}],"url":"\/documentation\/auth0\/myaccounterror\/code","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"code","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/debugDescription":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/debugDescription","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"debugDescription","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"type":"topic","title":"debugDescription","url":"\/documentation\/auth0\/myaccounterror\/debugdescription","abstract":[{"text":"Description of the error.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/Auth0Error-Implementations":{"role":"collectionGroup","url":"\/documentation\/auth0\/myaccounterror\/auth0error-implementations","title":"Auth0Error Implementations","abstract":[],"kind":"article","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/Auth0Error-Implementations"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/Auth0APIError-Implementations":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/Auth0APIError-Implementations","title":"Auth0APIError Implementations","role":"collectionGroup","abstract":[],"url":"\/documentation\/auth0\/myaccounterror\/auth0apierror-implementations","kind":"article"}}} \ No newline at end of file +{"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountError","kind":"identifier"}]}]}],"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\/s8CopyableP","doc:\/\/com.auth0.Auth0\/s28CustomDebugStringConvertibleP","doc:\/\/com.auth0.Auth0\/SQ","doc:\/\/com.auth0.Auth0\/s5ErrorP","doc:\/\/com.auth0.Auth0\/s8SendableP","doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP"]}],"topicSections":[{"title":"Structures","generated":true,"anchor":"Structures","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/ValidationError"]},{"title":"Initializers","generated":true,"anchor":"Initializers","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/init(info:statusCode:)"]},{"title":"Instance Properties","generated":true,"anchor":"Instance-Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/code","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/debugDescription","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/detail","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/info","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/message","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/statusCode","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/title","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/validationErrors"]},{"title":"Default Implementations","generated":true,"anchor":"Default-Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/Auth0APIError-Implementations","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/Auth0Error-Implementations","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/Equatable-Implementations","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/LocalizedError-Implementations"]}],"variants":[{"paths":["\/documentation\/auth0\/myaccounterror"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 My Account API."}],"metadata":{"roleHeading":"Structure","navigatorTitle":[{"kind":"identifier","text":"MyAccountError"}],"symbolKind":"struct","title":"MyAccountError","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountError","kind":"identifier"}],"externalID":"s:5Auth014MyAccountErrorV","modules":[{"name":"Auth0"}]},"references":{"doc://com.auth0.Auth0/s5ErrorP":{"title":"Swift.Error","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s5ErrorP"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/title":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/title","title":"title","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"title","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"role":"symbol","url":"\/documentation\/auth0\/myaccounterror\/title","abstract":[{"text":"Error description.","type":"text"}],"type":"topic"},"doc://com.auth0.Auth0/SQ":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/SQ","title":"Swift.Equatable"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/code":{"url":"\/documentation\/auth0\/myaccounterror\/code","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"code","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"title":"code","type":"topic","role":"symbol","abstract":[{"text":"Error code.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/code","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/Auth0APIError-Implementations":{"role":"collectionGroup","title":"Auth0APIError Implementations","abstract":[],"kind":"article","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/Auth0APIError-Implementations","url":"\/documentation\/auth0\/myaccounterror\/auth0apierror-implementations","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/debugDescription":{"role":"symbol","title":"debugDescription","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"debugDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"abstract":[{"type":"text","text":"Description of the error."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/debugDescription","url":"\/documentation\/auth0\/myaccounterror\/debugdescription","type":"topic"},"doc://com.auth0.Auth0/s28CustomDebugStringConvertibleP":{"title":"Swift.CustomDebugStringConvertible","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s28CustomDebugStringConvertibleP"},"doc://com.auth0.Auth0/s16SendableMetatypeP":{"title":"Swift.SendableMetatype","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccountError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 My Account API."}],"url":"\/documentation\/auth0\/myaccounterror","navigatorTitle":[{"kind":"identifier","text":"MyAccountError"}]},"doc://com.auth0.Auth0/10Foundation14LocalizedErrorP":{"title":"Foundation.LocalizedError","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/10Foundation14LocalizedErrorP"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/ValidationError":{"title":"MyAccountError.ValidationError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/ValidationError","type":"topic","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ValidationError"}],"abstract":[{"type":"text","text":"A server-side validation error."}],"url":"\/documentation\/auth0\/myaccounterror\/validationerror","navigatorTitle":[{"kind":"identifier","text":"ValidationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/init(info:statusCode:)":{"kind":"symbol","title":"init(info:statusCode:)","role":"symbol","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"info"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"statusCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"},{"kind":"text","text":")"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/init(info:statusCode:)","abstract":[{"type":"text","text":"Creates an error from a JSON response."}],"url":"\/documentation\/auth0\/myaccounterror\/init(info:statuscode:)"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/message":{"kind":"symbol","title":"message","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"message"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/message","abstract":[],"url":"\/documentation\/auth0\/myaccounterror\/message"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/statusCode":{"type":"topic","title":"statusCode","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/statusCode","kind":"symbol","abstract":[{"type":"text","text":"HTTP status code of the response."}],"url":"\/documentation\/auth0\/myaccounterror\/statuscode","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"statusCode"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/info":{"kind":"symbol","title":"info","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"info"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/info","abstract":[{"type":"text","text":"Raw error values."}],"url":"\/documentation\/auth0\/myaccounterror\/info"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/Equatable-Implementations":{"kind":"article","title":"Equatable Implementations","role":"collectionGroup","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/Equatable-Implementations","abstract":[],"url":"\/documentation\/auth0\/myaccounterror\/equatable-implementations"},"doc://com.auth0.Auth0/s8CopyableP":{"title":"Swift.Copyable","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s8CopyableP"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/Auth0Error-Implementations":{"role":"collectionGroup","title":"Auth0Error Implementations","abstract":[],"kind":"article","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/Auth0Error-Implementations","url":"\/documentation\/auth0\/myaccounterror\/auth0error-implementations","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/detail":{"kind":"symbol","title":"detail","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"detail"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/detail","abstract":[{"type":"text","text":"More information about the error."}],"url":"\/documentation\/auth0\/myaccounterror\/detail"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError":{"url":"\/documentation\/auth0\/auth0apierror","abstract":[{"type":"text","text":"Generic representation of Auth0 API errors."}],"title":"Auth0APIError","navigatorTitle":[{"kind":"identifier","text":"Auth0APIError"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Auth0APIError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/s8SendableP":{"title":"Swift.Sendable","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s8SendableP"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/validationErrors":{"role":"symbol","title":"validationErrors","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"validationErrors"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth014MyAccountErrorV010ValidationD0V","text":"ValidationError"},{"kind":"text","text":"]?"}],"abstract":[{"type":"text","text":"All the server-side validation errors."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/validationErrors","url":"\/documentation\/auth0\/myaccounterror\/validationerrors","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/LocalizedError-Implementations":{"role":"collectionGroup","title":"LocalizedError Implementations","abstract":[],"kind":"article","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/LocalizedError-Implementations","url":"\/documentation\/auth0\/myaccounterror\/localizederror-implementations","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error":{"url":"\/documentation\/auth0\/auth0error","title":"Auth0Error","abstract":[{"type":"text","text":"Generic representation of Auth0 errors."}],"navigatorTitle":[{"kind":"identifier","text":"Auth0Error"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Auth0Error"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","role":"symbol","kind":"symbol","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/myaccounterror/!=(_:_:).json b/docs/data/documentation/auth0/myaccounterror/!=(_:_:).json index c5c6ed5d7..ce4efb2bd 100644 --- a/docs/data/documentation/auth0/myaccounterror/!=(_:_:).json +++ b/docs/data/documentation/auth0/myaccounterror/!=(_:_:).json @@ -1 +1 @@ -{"abstract":[{"text":"Inherited from ","type":"text"},{"code":"Equatable.!=(_:_:)","type":"codeVoice"},{"text":".","type":"text"}],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"!="},{"kind":"text","text":" "},{"kind":"text","text":"("},{"kind":"internalParam","text":"lhs"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":", "},{"text":"rhs","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"schemaVersion":{"minor":3,"major":0,"patch":0},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/!=(_:_:)","interfaceLanguage":"swift"},"sections":[],"variants":[{"paths":["\/documentation\/auth0\/myaccounterror\/!=(_:_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"modules":[{"name":"Auth0","relatedModules":["Swift"]}],"roleHeading":"Operator","symbolKind":"op","role":"symbol","title":"!=(_:_:)","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"externalID":"s:SQsE2neoiySbx_xtFZ::SYNTHESIZED::s:5Auth014MyAccountErrorV","extendedModule":"Swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/!=(_:_:)":{"abstract":[],"title":"!=(_:_:)","type":"topic","kind":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/!=(_:_:)","role":"symbol","url":"\/documentation\/auth0\/myaccounterror\/!=(_:_:)"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","type":"topic","kind":"symbol","abstract":[{"text":"Represents an error during a request to the Auth0 My Account API.","type":"text"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountError","kind":"identifier"}],"navigatorTitle":[{"text":"MyAccountError","kind":"identifier"}],"url":"\/documentation\/auth0\/myaccounterror","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/myaccounterror\/!=(_:_:)"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError"]]},"abstract":[{"text":"Inherited from ","type":"text"},{"type":"codeVoice","code":"Equatable.!=(_:_:)"},{"type":"text","text":"."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"!="},{"kind":"text","text":" "},{"kind":"text","text":"("},{"kind":"internalParam","text":"lhs"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":", "},{"kind":"internalParam","text":"rhs"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"platforms":["iOS"]}]}],"sections":[],"kind":"symbol","schemaVersion":{"patch":0,"major":0,"minor":3},"metadata":{"externalID":"s:SQsE2neoiySbx_xtFZ::SYNTHESIZED::s:5Auth014MyAccountErrorV","extendedModule":"Swift","symbolKind":"op","title":"!=(_:_:)","roleHeading":"Operator","role":"symbol","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","text":"Self"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"modules":[{"name":"Auth0","relatedModules":["Swift"]}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/!=(_:_:)","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccountError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 My Account API."}],"url":"\/documentation\/auth0\/myaccounterror","navigatorTitle":[{"kind":"identifier","text":"MyAccountError"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/!=(_:_:)":{"url":"\/documentation\/auth0\/myaccounterror\/!=(_:_:)","title":"!=(_:_:)","abstract":[],"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","text":"Self"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/!=(_:_:)","role":"symbol","kind":"symbol","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/myaccounterror/==(_:_:).json b/docs/data/documentation/auth0/myaccounterror/==(_:_:).json index f50ce80ba..478afc7e7 100644 --- a/docs/data/documentation/auth0/myaccounterror/==(_:_:).json +++ b/docs/data/documentation/auth0/myaccounterror/==(_:_:).json @@ -1 +1 @@ -{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/myaccounterror\/==(_:_:)"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/==(_:_:)","interfaceLanguage":"swift"},"schemaVersion":{"minor":3,"major":0,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"==","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"lhs","kind":"internalParam"},{"text":": ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","preciseIdentifier":"s:5Auth014MyAccountErrorV","text":"MyAccountError","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"rhs","kind":"internalParam"},{"text":": ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","preciseIdentifier":"s:5Auth014MyAccountErrorV","text":"MyAccountError","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}]}]}],"kind":"symbol","metadata":{"roleHeading":"Operator","extendedModule":"Auth0","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"=="},{"kind":"text","text":" "},{"kind":"text","text":"("},{"preciseIdentifier":"s:5Auth014MyAccountErrorV","kind":"typeIdentifier","text":"MyAccountError"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth014MyAccountErrorV","kind":"typeIdentifier","text":"MyAccountError"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"externalID":"s:5Auth014MyAccountErrorV2eeoiySbAC_ACtFZ","title":"==(_:_:)","role":"symbol","symbolKind":"op"},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError"]]},"abstract":[{"type":"text","text":"Conformance to "},{"type":"codeVoice","code":"Equatable"},{"type":"text","text":"."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","type":"topic","kind":"symbol","abstract":[{"text":"Represents an error during a request to the Auth0 My Account API.","type":"text"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountError","kind":"identifier"}],"navigatorTitle":[{"text":"MyAccountError","kind":"identifier"}],"url":"\/documentation\/auth0\/myaccounterror","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/==(_:_:)":{"url":"\/documentation\/auth0\/myaccounterror\/==(_:_:)","abstract":[{"text":"Conformance to ","type":"text"},{"code":"Equatable","type":"codeVoice"},{"text":".","type":"text"}],"role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"==","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:5Auth014MyAccountErrorV","text":"MyAccountError","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth014MyAccountErrorV","text":"MyAccountError","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"kind":"symbol","title":"==(_:_:)","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/==(_:_:)"}}} \ No newline at end of file +{"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"=="},{"kind":"text","text":" "},{"kind":"text","text":"("},{"kind":"internalParam","text":"lhs"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth014MyAccountErrorV","text":"MyAccountError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError"},{"kind":"text","text":", "},{"kind":"internalParam","text":"rhs"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth014MyAccountErrorV","text":"MyAccountError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}]}],"kind":"declarations"}],"sections":[],"abstract":[{"type":"text","text":"Conformance to "},{"type":"codeVoice","code":"Equatable"},{"type":"text","text":"."}],"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/myaccounterror\/==(_:_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"role":"symbol","modules":[{"name":"Auth0"}],"title":"==(_:_:)","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"==","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:5Auth014MyAccountErrorV","text":"MyAccountError","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth014MyAccountErrorV","text":"MyAccountError","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"externalID":"s:5Auth014MyAccountErrorV2eeoiySbAC_ACtFZ","extendedModule":"Auth0","roleHeading":"Operator","symbolKind":"op"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/==(_:_:)"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/==(_:_:)":{"url":"\/documentation\/auth0\/myaccounterror\/==(_:_:)","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","text":"MyAccountError","preciseIdentifier":"s:5Auth014MyAccountErrorV"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"MyAccountError","preciseIdentifier":"s:5Auth014MyAccountErrorV"},{"kind":"text","text":") -> "},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"title":"==(_:_:)","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Conformance to "},{"code":"Equatable","type":"codeVoice"},{"text":".","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/==(_:_:)","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccountError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 My Account API."}],"url":"\/documentation\/auth0\/myaccounterror","navigatorTitle":[{"kind":"identifier","text":"MyAccountError"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/myaccounterror/auth0apierror-implementations.json b/docs/data/documentation/auth0/myaccounterror/auth0apierror-implementations.json index a5d719c16..585b972ae 100644 --- a/docs/data/documentation/auth0/myaccounterror/auth0apierror-implementations.json +++ b/docs/data/documentation/auth0/myaccounterror/auth0apierror-implementations.json @@ -1 +1 @@ -{"metadata":{"role":"collectionGroup","title":"Auth0APIError Implementations","modules":[{"name":"Auth0"}],"roleHeading":"API Collection"},"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/Auth0APIError-Implementations"},"topicSections":[{"title":"Instance Properties","anchor":"Instance-Properties","generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/cause","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/isNetworkError"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError"]]},"schemaVersion":{"patch":0,"major":0,"minor":3},"kind":"article","variants":[{"paths":["\/documentation\/auth0\/myaccounterror\/auth0apierror-implementations"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/isNetworkError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/isNetworkError","kind":"symbol","type":"topic","abstract":[{"type":"text","text":"Whether the request failed due to network issues."}],"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isNetworkError"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"url":"\/documentation\/auth0\/myaccounterror\/isnetworkerror","title":"isNetworkError"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","type":"topic","kind":"symbol","abstract":[{"text":"Represents an error during a request to the Auth0 My Account API.","type":"text"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountError","kind":"identifier"}],"navigatorTitle":[{"text":"MyAccountError","kind":"identifier"}],"url":"\/documentation\/auth0\/myaccounterror","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/cause":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/cause","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":"."}],"url":"\/documentation\/auth0\/myaccounterror\/cause","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:s5ErrorP","text":"Error","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"title":"cause"}}} \ No newline at end of file +{"topicSections":[{"anchor":"Instance-Properties","title":"Instance Properties","generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/cause","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/isNetworkError"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError"]]},"metadata":{"role":"collectionGroup","title":"Auth0APIError Implementations","roleHeading":"API Collection","modules":[{"name":"Auth0"}]},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/myaccounterror\/auth0apierror-implementations"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/Auth0APIError-Implementations","interfaceLanguage":"swift"},"kind":"article","schemaVersion":{"minor":3,"patch":0,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccountError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 My Account API."}],"url":"\/documentation\/auth0\/myaccounterror","navigatorTitle":[{"kind":"identifier","text":"MyAccountError"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/cause":{"title":"cause","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/cause","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP","text":"Error"},{"kind":"text","text":"?"}],"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":"."}],"url":"\/documentation\/auth0\/myaccounterror\/cause"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/isNetworkError":{"title":"isNetworkError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/isNetworkError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isNetworkError"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"abstract":[{"type":"text","text":"Whether the request failed due to network issues."}],"url":"\/documentation\/auth0\/myaccounterror\/isnetworkerror"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/myaccounterror/auth0error-implementations.json b/docs/data/documentation/auth0/myaccounterror/auth0error-implementations.json index 9ce681d71..ca4c67bdb 100644 --- a/docs/data/documentation/auth0/myaccounterror/auth0error-implementations.json +++ b/docs/data/documentation/auth0/myaccounterror/auth0error-implementations.json @@ -1 +1 @@ -{"metadata":{"title":"Auth0Error Implementations","modules":[{"name":"Auth0"}],"roleHeading":"API Collection","role":"collectionGroup"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/Auth0Error-Implementations","interfaceLanguage":"swift"},"variants":[{"paths":["\/documentation\/auth0\/myaccounterror\/auth0error-implementations"],"traits":[{"interfaceLanguage":"swift"}]}],"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/errorDescription","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/localizedDescription"],"anchor":"Instance-Properties","generated":true,"title":"Instance Properties"}],"kind":"article","sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/errorDescription":{"title":"errorDescription","abstract":[{"type":"text","text":"Description of the error."}],"url":"\/documentation\/auth0\/myaccounterror\/errordescription","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/errorDescription","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"errorDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"role":"symbol","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/localizedDescription":{"kind":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/localizedDescription","abstract":[{"type":"text","text":"Description of the error."}],"fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"localizedDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"title":"localizedDescription","url":"\/documentation\/auth0\/myaccounterror\/localizeddescription","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","type":"topic","kind":"symbol","abstract":[{"text":"Represents an error during a request to the Auth0 My Account API.","type":"text"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountError","kind":"identifier"}],"navigatorTitle":[{"text":"MyAccountError","kind":"identifier"}],"url":"\/documentation\/auth0\/myaccounterror","role":"symbol"}}} \ No newline at end of file +{"kind":"article","topicSections":[{"anchor":"Instance-Properties","title":"Instance Properties","generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/errorDescription","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/localizedDescription"]}],"variants":[{"paths":["\/documentation\/auth0\/myaccounterror\/auth0error-implementations"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"schemaVersion":{"patch":0,"minor":3,"major":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/Auth0Error-Implementations","interfaceLanguage":"swift"},"metadata":{"role":"collectionGroup","title":"Auth0Error Implementations","roleHeading":"API Collection","modules":[{"name":"Auth0"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccountError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 My Account API."}],"url":"\/documentation\/auth0\/myaccounterror","navigatorTitle":[{"kind":"identifier","text":"MyAccountError"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/localizedDescription":{"url":"\/documentation\/auth0\/myaccounterror\/localizeddescription","abstract":[{"type":"text","text":"Description of the error."}],"title":"localizedDescription","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"localizedDescription","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/localizedDescription","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/errorDescription":{"kind":"symbol","title":"errorDescription","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"errorDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/errorDescription","abstract":[{"type":"text","text":"Description of the error."}],"url":"\/documentation\/auth0\/myaccounterror\/errordescription"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/myaccounterror/cause.json b/docs/data/documentation/auth0/myaccounterror/cause.json index 251b682c6..3ff2cfdc4 100644 --- a/docs/data/documentation/auth0/myaccounterror/cause.json +++ b/docs/data/documentation/auth0/myaccounterror/cause.json @@ -1 +1 @@ -{"abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/cause"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError"]]},"schemaVersion":{"patch":0,"minor":3,"major":0},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":"? { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}]}],"kind":"declarations"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/myaccounterror\/cause"]}],"kind":"symbol","sections":[],"metadata":{"extendedModule":"Auth0","externalID":"s:5Auth00A8APIErrorPAAE5causes5Error_pSgvp::SYNTHESIZED::s:5Auth014MyAccountErrorV","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP","text":"Error"},{"kind":"text","text":"?"}],"role":"symbol","roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"title":"cause","symbolKind":"property"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","type":"topic","kind":"symbol","abstract":[{"text":"Represents an error during a request to the Auth0 My Account API.","type":"text"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountError","kind":"identifier"}],"navigatorTitle":[{"text":"MyAccountError","kind":"identifier"}],"url":"\/documentation\/auth0\/myaccounterror","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/cause":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/cause","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":"."}],"url":"\/documentation\/auth0\/myaccounterror\/cause","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:s5ErrorP","text":"Error","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"title":"cause"}}} \ No newline at end of file +{"metadata":{"symbolKind":"property","title":"cause","externalID":"s:5Auth00A8APIErrorPAAE5causes5Error_pSgvp::SYNTHESIZED::s:5Auth014MyAccountErrorV","extendedModule":"Auth0","roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Error","preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"role":"symbol"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/myaccounterror\/cause"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/cause"},"kind":"symbol","abstract":[{"text":"The underlying ","type":"text"},{"code":"Error","type":"codeVoice"},{"text":" value, if any. Defaults to ","type":"text"},{"code":"nil","type":"codeVoice"},{"text":".","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":"? { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"platforms":["iOS"]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/cause":{"title":"cause","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/cause","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP","text":"Error"},{"kind":"text","text":"?"}],"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":"."}],"url":"\/documentation\/auth0\/myaccounterror\/cause"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccountError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 My Account API."}],"url":"\/documentation\/auth0\/myaccounterror","navigatorTitle":[{"kind":"identifier","text":"MyAccountError"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/myaccounterror/code.json b/docs/data/documentation/auth0/myaccounterror/code.json index d1b07a3ae..e9f057c82 100644 --- a/docs/data/documentation/auth0/myaccounterror/code.json +++ b/docs/data/documentation/auth0/myaccounterror/code.json @@ -1 +1 @@ -{"schemaVersion":{"major":0,"minor":3,"patch":0},"variants":[{"paths":["\/documentation\/auth0\/myaccounterror\/code"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/code","interfaceLanguage":"swift"},"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"code"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"languages":["swift"],"platforms":["iOS"]}]}],"metadata":{"role":"symbol","externalID":"s:5Auth014MyAccountErrorV4codeSSvp","title":"code","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"code"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","symbolKind":"property"},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError"]]},"abstract":[{"type":"text","text":"Error code."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/code":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/code","type":"topic","role":"symbol","kind":"symbol","title":"code","abstract":[{"text":"Error code.","type":"text"}],"url":"\/documentation\/auth0\/myaccounterror\/code","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"code","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","type":"topic","kind":"symbol","abstract":[{"text":"Represents an error during a request to the Auth0 My Account API.","type":"text"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountError","kind":"identifier"}],"navigatorTitle":[{"text":"MyAccountError","kind":"identifier"}],"url":"\/documentation\/auth0\/myaccounterror","role":"symbol"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError"]]},"metadata":{"modules":[{"name":"Auth0"}],"title":"code","roleHeading":"Instance Property","symbolKind":"property","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"code"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"externalID":"s:5Auth014MyAccountErrorV4codeSSvp"},"sections":[],"abstract":[{"type":"text","text":"Error code."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/myaccounterror\/code"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/code","interfaceLanguage":"swift"},"kind":"symbol","schemaVersion":{"patch":0,"minor":3,"major":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"code","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/code":{"url":"\/documentation\/auth0\/myaccounterror\/code","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"code","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"title":"code","type":"topic","role":"symbol","abstract":[{"text":"Error code.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/code","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccountError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 My Account API."}],"url":"\/documentation\/auth0\/myaccounterror","navigatorTitle":[{"kind":"identifier","text":"MyAccountError"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/myaccounterror/debugdescription.json b/docs/data/documentation/auth0/myaccounterror/debugdescription.json index 71dcea96c..863bc707f 100644 --- a/docs/data/documentation/auth0/myaccounterror/debugdescription.json +++ b/docs/data/documentation/auth0/myaccounterror/debugdescription.json @@ -1 +1 @@ -{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/debugDescription"},"abstract":[{"text":"Description of the error.","type":"text"}],"kind":"symbol","sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError"]]},"schemaVersion":{"patch":0,"minor":3,"major":0},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"debugDescription","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"languages":["swift"]}],"kind":"declarations"},{"kind":"content","content":[{"anchor":"discussion","text":"Discussion","type":"heading","level":2},{"style":"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"}]},{"text":" only.","type":"text"}],"type":"paragraph"}],"type":"aside","name":"Important"}]}],"variants":[{"paths":["\/documentation\/auth0\/myaccounterror\/debugdescription"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","externalID":"s:5Auth014MyAccountErrorV16debugDescriptionSSvp","title":"debugDescription","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"debugDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"symbolKind":"property"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","type":"topic","kind":"symbol","abstract":[{"text":"Represents an error during a request to the Auth0 My Account API.","type":"text"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountError","kind":"identifier"}],"navigatorTitle":[{"text":"MyAccountError","kind":"identifier"}],"url":"\/documentation\/auth0\/myaccounterror","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/debugDescription":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/debugDescription","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"debugDescription","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"type":"topic","title":"debugDescription","url":"\/documentation\/auth0\/myaccounterror\/debugdescription","abstract":[{"text":"Description of the error.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"metadata":{"symbolKind":"property","title":"debugDescription","externalID":"s:5Auth014MyAccountErrorV16debugDescriptionSSvp","roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"debugDescription","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"role":"symbol"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/myaccounterror\/debugdescription"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/debugDescription"},"kind":"symbol","abstract":[{"type":"text","text":"Description of the error."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError"]]},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"debugDescription"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"},{"content":[{"text":"Discussion","level":2,"anchor":"discussion","type":"heading"},{"name":"Important","style":"important","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"You should avoid displaying the error description to the user, it’s meant for "},{"inlineContent":[{"text":"debugging","type":"text"}],"type":"strong"},{"type":"text","text":" only."}]}],"type":"aside"}],"kind":"content"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccountError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 My Account API."}],"url":"\/documentation\/auth0\/myaccounterror","navigatorTitle":[{"kind":"identifier","text":"MyAccountError"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/debugDescription":{"role":"symbol","title":"debugDescription","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"debugDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"abstract":[{"type":"text","text":"Description of the error."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/debugDescription","url":"\/documentation\/auth0\/myaccounterror\/debugdescription","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/myaccounterror/detail.json b/docs/data/documentation/auth0/myaccounterror/detail.json index 44fe6765b..86920648e 100644 --- a/docs/data/documentation/auth0/myaccounterror/detail.json +++ b/docs/data/documentation/auth0/myaccounterror/detail.json @@ -1 +1 @@ -{"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"detail"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"platforms":["iOS"],"languages":["swift"]}]}],"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/detail"},"abstract":[{"type":"text","text":"More information about the error."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/myaccounterror\/detail"]}],"metadata":{"roleHeading":"Instance Property","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"detail"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"modules":[{"name":"Auth0"}],"externalID":"s:5Auth014MyAccountErrorV6detailSSvp","symbolKind":"property","title":"detail"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","type":"topic","kind":"symbol","abstract":[{"text":"Represents an error during a request to the Auth0 My Account API.","type":"text"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountError","kind":"identifier"}],"navigatorTitle":[{"text":"MyAccountError","kind":"identifier"}],"url":"\/documentation\/auth0\/myaccounterror","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/detail":{"type":"topic","title":"detail","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"detail"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"role":"symbol","abstract":[{"text":"More information about the error.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/detail","url":"\/documentation\/auth0\/myaccounterror\/detail","kind":"symbol"}}} \ No newline at end of file +{"metadata":{"symbolKind":"property","title":"detail","roleHeading":"Instance Property","externalID":"s:5Auth014MyAccountErrorV6detailSSvp","modules":[{"name":"Auth0"}],"fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"detail"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"role":"symbol"},"sections":[],"variants":[{"paths":["\/documentation\/auth0\/myaccounterror\/detail"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/detail"},"kind":"symbol","abstract":[{"type":"text","text":"More information about the error."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError"]]},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"detail"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}]}],"kind":"declarations"}],"schemaVersion":{"patch":0,"minor":3,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/detail":{"kind":"symbol","title":"detail","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"detail"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/detail","abstract":[{"type":"text","text":"More information about the error."}],"url":"\/documentation\/auth0\/myaccounterror\/detail"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccountError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 My Account API."}],"url":"\/documentation\/auth0\/myaccounterror","navigatorTitle":[{"kind":"identifier","text":"MyAccountError"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/myaccounterror/equatable-implementations.json b/docs/data/documentation/auth0/myaccounterror/equatable-implementations.json index ea0999482..44f3ea744 100644 --- a/docs/data/documentation/auth0/myaccounterror/equatable-implementations.json +++ b/docs/data/documentation/auth0/myaccounterror/equatable-implementations.json @@ -1 +1 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/Equatable-Implementations","interfaceLanguage":"swift"},"schemaVersion":{"minor":3,"patch":0,"major":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/myaccounterror\/equatable-implementations"]}],"topicSections":[{"anchor":"Operators","title":"Operators","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/!=(_:_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/==(_:_:)"],"generated":true}],"sections":[],"kind":"article","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError"]]},"metadata":{"modules":[{"name":"Auth0"}],"title":"Equatable Implementations","roleHeading":"API Collection","role":"collectionGroup"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","type":"topic","kind":"symbol","abstract":[{"text":"Represents an error during a request to the Auth0 My Account API.","type":"text"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountError","kind":"identifier"}],"navigatorTitle":[{"text":"MyAccountError","kind":"identifier"}],"url":"\/documentation\/auth0\/myaccounterror","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/==(_:_:)":{"url":"\/documentation\/auth0\/myaccounterror\/==(_:_:)","abstract":[{"text":"Conformance to ","type":"text"},{"code":"Equatable","type":"codeVoice"},{"text":".","type":"text"}],"role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"==","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:5Auth014MyAccountErrorV","text":"MyAccountError","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth014MyAccountErrorV","text":"MyAccountError","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"kind":"symbol","title":"==(_:_:)","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/==(_:_:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/!=(_:_:)":{"abstract":[],"title":"!=(_:_:)","type":"topic","kind":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/!=(_:_:)","role":"symbol","url":"\/documentation\/auth0\/myaccounterror\/!=(_:_:)"}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/myaccounterror\/equatable-implementations"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError"]]},"topicSections":[{"title":"Operators","generated":true,"anchor":"Operators","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/!=(_:_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/==(_:_:)"]}],"metadata":{"title":"Equatable Implementations","modules":[{"name":"Auth0"}],"roleHeading":"API Collection","role":"collectionGroup"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/Equatable-Implementations","interfaceLanguage":"swift"},"kind":"article","references":{"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/!=(_:_:)":{"url":"\/documentation\/auth0\/myaccounterror\/!=(_:_:)","title":"!=(_:_:)","abstract":[],"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","text":"Self"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/!=(_:_:)","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/==(_:_:)":{"url":"\/documentation\/auth0\/myaccounterror\/==(_:_:)","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","text":"MyAccountError","preciseIdentifier":"s:5Auth014MyAccountErrorV"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"MyAccountError","preciseIdentifier":"s:5Auth014MyAccountErrorV"},{"kind":"text","text":") -> "},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"title":"==(_:_:)","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Conformance to "},{"code":"Equatable","type":"codeVoice"},{"text":".","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/==(_:_:)","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccountError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 My Account API."}],"url":"\/documentation\/auth0\/myaccounterror","navigatorTitle":[{"kind":"identifier","text":"MyAccountError"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/myaccounterror/errordescription.json b/docs/data/documentation/auth0/myaccounterror/errordescription.json index 4780a96ef..755063a12 100644 --- a/docs/data/documentation/auth0/myaccounterror/errordescription.json +++ b/docs/data/documentation/auth0/myaccounterror/errordescription.json @@ -1 +1 @@ -{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/myaccounterror\/errordescription"]}],"schemaVersion":{"minor":3,"major":0,"patch":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/errorDescription","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError"]]},"abstract":[{"type":"text","text":"Description of the error."}],"sections":[],"metadata":{"symbolKind":"property","extendedModule":"Auth0","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"errorDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"externalID":"s:5Auth00A5ErrorPAAE16errorDescriptionSSSgvp::SYNTHESIZED::s:5Auth014MyAccountErrorV","modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","title":"errorDescription","role":"symbol"},"kind":"symbol","primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"errorDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"? { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}]}],"kind":"declarations"},{"content":[{"level":2,"type":"heading","text":"Discussion","anchor":"discussion"},{"content":[{"inlineContent":[{"type":"text","text":"You should avoid displaying the error description to the user, it’s meant for "},{"type":"strong","inlineContent":[{"type":"text","text":"debugging"}]},{"type":"text","text":" only."}],"type":"paragraph"}],"type":"aside","style":"important","name":"Important"}],"kind":"content"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/errorDescription":{"title":"errorDescription","abstract":[{"type":"text","text":"Description of the error."}],"url":"\/documentation\/auth0\/myaccounterror\/errordescription","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/errorDescription","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"errorDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"role":"symbol","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","type":"topic","kind":"symbol","abstract":[{"text":"Represents an error during a request to the Auth0 My Account API.","type":"text"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountError","kind":"identifier"}],"navigatorTitle":[{"text":"MyAccountError","kind":"identifier"}],"url":"\/documentation\/auth0\/myaccounterror","role":"symbol"}}} \ No newline at end of file +{"kind":"symbol","primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"errorDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"? { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}]}],"kind":"declarations"},{"content":[{"anchor":"discussion","type":"heading","level":2,"text":"Discussion"},{"type":"aside","name":"Important","content":[{"inlineContent":[{"text":"You should avoid displaying the error description to the user, it’s meant for ","type":"text"},{"inlineContent":[{"text":"debugging","type":"text"}],"type":"strong"},{"text":" only.","type":"text"}],"type":"paragraph"}],"style":"important"}],"kind":"content"}],"variants":[{"paths":["\/documentation\/auth0\/myaccounterror\/errordescription"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"schemaVersion":{"patch":0,"minor":3,"major":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/errorDescription","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Description of the error."}],"metadata":{"roleHeading":"Instance Property","extendedModule":"Auth0","role":"symbol","title":"errorDescription","symbolKind":"property","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"errorDescription","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"externalID":"s:5Auth00A5ErrorPAAE16errorDescriptionSSSgvp::SYNTHESIZED::s:5Auth014MyAccountErrorV","modules":[{"name":"Auth0"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccountError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 My Account API."}],"url":"\/documentation\/auth0\/myaccounterror","navigatorTitle":[{"kind":"identifier","text":"MyAccountError"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/errorDescription":{"kind":"symbol","title":"errorDescription","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"errorDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/errorDescription","abstract":[{"type":"text","text":"Description of the error."}],"url":"\/documentation\/auth0\/myaccounterror\/errordescription"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/myaccounterror/failurereason.json b/docs/data/documentation/auth0/myaccounterror/failurereason.json index b65af80e6..edc63247a 100644 --- a/docs/data/documentation/auth0/myaccounterror/failurereason.json +++ b/docs/data/documentation/auth0/myaccounterror/failurereason.json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"failureReason"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"? { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"languages":["swift"],"platforms":["iOS"]}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/failureReason"},"variants":[{"paths":["\/documentation\/auth0\/myaccounterror\/failurereason"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError"]]},"metadata":{"externalID":"s:10Foundation14LocalizedErrorPAAE13failureReasonSSSgvp::SYNTHESIZED::s:5Auth014MyAccountErrorV","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"failureReason"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"role":"symbol","platforms":[{"introducedAt":"8.0","deprecated":false,"unavailable":false,"beta":false,"name":"iOS"},{"introducedAt":"8.0","deprecated":false,"unavailable":false,"beta":false,"name":"iPadOS"},{"introducedAt":"8.0","deprecated":false,"unavailable":false,"beta":false,"name":"Mac Catalyst"},{"introducedAt":"10.10","deprecated":false,"unavailable":false,"beta":false,"name":"macOS"},{"introducedAt":"9.0","deprecated":false,"unavailable":false,"beta":false,"name":"tvOS"},{"introducedAt":"2.0","deprecated":false,"unavailable":false,"beta":false,"name":"watchOS"}],"symbolKind":"property","modules":[{"relatedModules":["Foundation"],"name":"Auth0"}],"roleHeading":"Instance Property","extendedModule":"Foundation","title":"failureReason"},"abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"LocalizedError.failureReason"},{"type":"text","text":"."}],"kind":"symbol","schemaVersion":{"minor":3,"major":0,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","type":"topic","kind":"symbol","abstract":[{"text":"Represents an error during a request to the Auth0 My Account API.","type":"text"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountError","kind":"identifier"}],"navigatorTitle":[{"text":"MyAccountError","kind":"identifier"}],"url":"\/documentation\/auth0\/myaccounterror","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/failureReason":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/failureReason","title":"failureReason","url":"\/documentation\/auth0\/myaccounterror\/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"}],"kind":"symbol","abstract":[]}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError"]]},"metadata":{"platforms":[{"introducedAt":"8.0","beta":false,"deprecated":false,"unavailable":false,"name":"iOS"},{"deprecated":false,"introducedAt":"8.0","unavailable":false,"name":"iPadOS","beta":false},{"deprecated":false,"introducedAt":"8.0","unavailable":false,"name":"Mac Catalyst","beta":false},{"deprecated":false,"introducedAt":"10.10","unavailable":false,"name":"macOS","beta":false},{"deprecated":false,"introducedAt":"9.0","unavailable":false,"name":"tvOS","beta":false},{"deprecated":false,"introducedAt":"2.0","unavailable":false,"name":"watchOS","beta":false}],"extendedModule":"Foundation","symbolKind":"property","modules":[{"name":"Auth0","relatedModules":["Foundation"]}],"title":"failureReason","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"failureReason"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"externalID":"s:10Foundation14LocalizedErrorPAAE13failureReasonSSSgvp::SYNTHESIZED::s:5Auth014MyAccountErrorV","role":"symbol","roleHeading":"Instance Property"},"sections":[],"abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"LocalizedError.failureReason"},{"type":"text","text":"."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/myaccounterror\/failurereason"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/failureReason","interfaceLanguage":"swift"},"kind":"symbol","schemaVersion":{"minor":3,"patch":0,"major":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"failureReason"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"? { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"platforms":["iOS"]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/failureReason":{"url":"\/documentation\/auth0\/myaccounterror\/failurereason","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"failureReason"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"title":"failureReason","type":"topic","role":"symbol","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/failureReason","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccountError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 My Account API."}],"url":"\/documentation\/auth0\/myaccounterror","navigatorTitle":[{"kind":"identifier","text":"MyAccountError"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/myaccounterror/helpanchor.json b/docs/data/documentation/auth0/myaccounterror/helpanchor.json index 71820b9df..4fba48421 100644 --- a/docs/data/documentation/auth0/myaccounterror/helpanchor.json +++ b/docs/data/documentation/auth0/myaccounterror/helpanchor.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError"]]},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"helpAnchor","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"? { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/helpAnchor"},"metadata":{"externalID":"s:10Foundation14LocalizedErrorPAAE10helpAnchorSSSgvp::SYNTHESIZED::s:5Auth014MyAccountErrorV","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"helpAnchor"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}],"platforms":[{"beta":false,"deprecated":false,"name":"iOS","unavailable":false,"introducedAt":"8.0"},{"beta":false,"deprecated":false,"name":"iPadOS","unavailable":false,"introducedAt":"8.0"},{"beta":false,"deprecated":false,"name":"Mac Catalyst","unavailable":false,"introducedAt":"8.0"},{"beta":false,"deprecated":false,"name":"macOS","unavailable":false,"introducedAt":"10.10"},{"beta":false,"deprecated":false,"name":"tvOS","unavailable":false,"introducedAt":"9.0"},{"beta":false,"deprecated":false,"name":"watchOS","unavailable":false,"introducedAt":"2.0"}],"extendedModule":"Foundation","symbolKind":"property","roleHeading":"Instance Property","title":"helpAnchor","modules":[{"name":"Auth0","relatedModules":["Foundation"]}]},"variants":[{"paths":["\/documentation\/auth0\/myaccounterror\/helpanchor"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"patch":0,"minor":3},"kind":"symbol","abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"LocalizedError.helpAnchor"},{"type":"text","text":"."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/helpAnchor":{"type":"topic","title":"helpAnchor","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"helpAnchor","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"url":"\/documentation\/auth0\/myaccounterror\/helpanchor","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/helpAnchor","kind":"symbol","abstract":[],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","type":"topic","kind":"symbol","abstract":[{"text":"Represents an error during a request to the Auth0 My Account API.","type":"text"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountError","kind":"identifier"}],"navigatorTitle":[{"text":"MyAccountError","kind":"identifier"}],"url":"\/documentation\/auth0\/myaccounterror","role":"symbol"}}} \ No newline at end of file +{"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"helpAnchor"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"? { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"platforms":["iOS"],"languages":["swift"]}]}],"sections":[],"abstract":[{"type":"text","text":"Inherited from "},{"code":"LocalizedError.helpAnchor","type":"codeVoice"},{"type":"text","text":"."}],"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/myaccounterror\/helpanchor"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"role":"symbol","title":"helpAnchor","modules":[{"relatedModules":["Foundation"],"name":"Auth0"}],"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"helpAnchor","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"externalID":"s:10Foundation14LocalizedErrorPAAE10helpAnchorSSSgvp::SYNTHESIZED::s:5Auth014MyAccountErrorV","extendedModule":"Foundation","roleHeading":"Instance Property","platforms":[{"unavailable":false,"name":"iOS","beta":false,"introducedAt":"8.0","deprecated":false},{"unavailable":false,"name":"iPadOS","beta":false,"introducedAt":"8.0","deprecated":false},{"unavailable":false,"name":"Mac Catalyst","beta":false,"introducedAt":"8.0","deprecated":false},{"unavailable":false,"name":"macOS","beta":false,"introducedAt":"10.10","deprecated":false},{"unavailable":false,"name":"tvOS","beta":false,"introducedAt":"9.0","deprecated":false},{"unavailable":false,"name":"watchOS","beta":false,"introducedAt":"2.0","deprecated":false}],"symbolKind":"property"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/helpAnchor","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccountError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 My Account API."}],"url":"\/documentation\/auth0\/myaccounterror","navigatorTitle":[{"kind":"identifier","text":"MyAccountError"}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/helpAnchor":{"role":"symbol","title":"helpAnchor","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"helpAnchor"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"abstract":[],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/helpAnchor","url":"\/documentation\/auth0\/myaccounterror\/helpanchor","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/myaccounterror/info.json b/docs/data/documentation/auth0/myaccounterror/info.json index 435c4ce93..7bec0ec07 100644 --- a/docs/data/documentation/auth0/myaccounterror/info.json +++ b/docs/data/documentation/auth0/myaccounterror/info.json @@ -1 +1 @@ -{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/myaccounterror\/info"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/info","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"info"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]"}],"languages":["swift"],"platforms":["iOS"]}]}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError"]]},"metadata":{"title":"info","modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"info"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]"}],"externalID":"s:5Auth014MyAccountErrorV4infoSDySSypGvp","role":"symbol","symbolKind":"property"},"schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"type":"text","text":"Raw error values."}],"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/info":{"abstract":[{"text":"Raw error values.","type":"text"}],"title":"info","url":"\/documentation\/auth0\/myaccounterror\/info","type":"topic","role":"symbol","kind":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"info","kind":"identifier"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"]","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/info"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","type":"topic","kind":"symbol","abstract":[{"text":"Represents an error during a request to the Auth0 My Account API.","type":"text"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountError","kind":"identifier"}],"navigatorTitle":[{"text":"MyAccountError","kind":"identifier"}],"url":"\/documentation\/auth0\/myaccounterror","role":"symbol"}}} \ No newline at end of file +{"sections":[],"metadata":{"externalID":"s:5Auth014MyAccountErrorV4infoSDySSypGvp","modules":[{"name":"Auth0"}],"title":"info","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"info"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]"}],"roleHeading":"Instance Property","role":"symbol","symbolKind":"property"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/info"},"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/myaccounterror\/info"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"info"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]"}]}],"kind":"declarations"}],"abstract":[{"type":"text","text":"Raw error values."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccountError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 My Account API."}],"url":"\/documentation\/auth0\/myaccounterror","navigatorTitle":[{"kind":"identifier","text":"MyAccountError"}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/info":{"kind":"symbol","title":"info","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"info"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/info","abstract":[{"type":"text","text":"Raw error values."}],"url":"\/documentation\/auth0\/myaccounterror\/info"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/myaccounterror/init(info:statuscode:).json b/docs/data/documentation/auth0/myaccounterror/init(info:statuscode:).json index 118b2afa1..bd32e8dcf 100644 --- a/docs/data/documentation/auth0/myaccounterror/init(info:statuscode:).json +++ b/docs/data/documentation/auth0/myaccounterror/init(info:statuscode:).json @@ -1 +1 @@ -{"metadata":{"externalID":"s:5Auth014MyAccountErrorV4info10statusCodeACSDySSypG_Sitcfc","title":"init(info:statusCode:)","roleHeading":"Initializer","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"info","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"], ","kind":"text"},{"text":"statusCode","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"text":")","kind":"text"}],"modules":[{"name":"Auth0"}],"symbolKind":"init","role":"symbol"},"abstract":[{"text":"Creates an error from a JSON response.","type":"text"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/myaccounterror\/init(info:statuscode:)"]}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError"]]},"schemaVersion":{"patch":0,"major":0,"minor":3},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/init(info:statusCode:)"},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"init","kind":"keyword"},{"text":"(","kind":"text"},{"text":"info","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"], ","kind":"text"},{"text":"statusCode","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"kind":"text","text":")"}],"languages":["swift"],"platforms":["iOS"]}]},{"kind":"parameters","parameters":[{"name":"info","content":[{"type":"paragraph","inlineContent":[{"text":"JSON response from Auth0.","type":"text"}]}]},{"name":"statusCode","content":[{"inlineContent":[{"type":"text","text":"HTTP status code of the response."}],"type":"paragraph"}]}]},{"kind":"content","content":[{"type":"heading","text":"Return Value","level":2,"anchor":"return-value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A new "},{"type":"codeVoice","code":"NyAccountError"},{"type":"text","text":"."}]}]}],"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","type":"topic","kind":"symbol","abstract":[{"text":"Represents an error during a request to the Auth0 My Account API.","type":"text"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountError","kind":"identifier"}],"navigatorTitle":[{"text":"MyAccountError","kind":"identifier"}],"url":"\/documentation\/auth0\/myaccounterror","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/init(info:statusCode:)":{"url":"\/documentation\/auth0\/myaccounterror\/init(info:statuscode:)","title":"init(info:statusCode:)","role":"symbol","kind":"symbol","abstract":[{"type":"text","text":"Creates an error from a JSON response."}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/init(info:statusCode:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"info"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"statusCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"},{"kind":"text","text":")"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"abstract":[{"type":"text","text":"Creates an error from a JSON response."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"init","kind":"keyword"},{"text":"(","kind":"text"},{"text":"info","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"text":"statusCode","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"},{"kind":"text","text":")"}],"platforms":["iOS"],"languages":["swift"]}]},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"text":"JSON response from Auth0.","type":"text"}]}],"name":"info"},{"content":[{"type":"paragraph","inlineContent":[{"text":"HTTP status code of the response.","type":"text"}]}],"name":"statusCode"}]},{"kind":"content","content":[{"type":"heading","level":2,"anchor":"return-value","text":"Return Value"},{"inlineContent":[{"type":"text","text":"A new "},{"type":"codeVoice","code":"NyAccountError"},{"type":"text","text":"."}],"type":"paragraph"}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/myaccounterror\/init(info:statuscode:)"]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError"]]},"metadata":{"symbolKind":"init","roleHeading":"Initializer","title":"init(info:statusCode:)","externalID":"s:5Auth014MyAccountErrorV4info10statusCodeACSDySSypG_Sitcfc","modules":[{"name":"Auth0"}],"fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"info"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"], ","kind":"text"},{"text":"statusCode","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Int","preciseIdentifier":"s:Si","kind":"typeIdentifier"},{"text":")","kind":"text"}],"role":"symbol"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/init(info:statusCode:)","interfaceLanguage":"swift"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccountError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 My Account API."}],"url":"\/documentation\/auth0\/myaccounterror","navigatorTitle":[{"kind":"identifier","text":"MyAccountError"}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/init(info:statusCode:)":{"kind":"symbol","title":"init(info:statusCode:)","role":"symbol","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"info"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"statusCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"},{"kind":"text","text":")"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/init(info:statusCode:)","abstract":[{"type":"text","text":"Creates an error from a JSON response."}],"url":"\/documentation\/auth0\/myaccounterror\/init(info:statuscode:)"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/myaccounterror/isnetworkerror.json b/docs/data/documentation/auth0/myaccounterror/isnetworkerror.json index 39e10e7c0..aa7b07e85 100644 --- a/docs/data/documentation/auth0/myaccounterror/isnetworkerror.json +++ b/docs/data/documentation/auth0/myaccounterror/isnetworkerror.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError"]]},"abstract":[{"text":"Whether the request failed due to network issues.","type":"text"}],"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/myaccounterror\/isnetworkerror"]}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isNetworkError"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"title":"isNetworkError","externalID":"s:5Auth00A8APIErrorPAAE14isNetworkErrorSbvp::SYNTHESIZED::s:5Auth014MyAccountErrorV","roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"role":"symbol","extendedModule":"Auth0","symbolKind":"property"},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isNetworkError"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}]}]},{"kind":"content","content":[{"type":"heading","level":2,"text":"Discussion","anchor":"discussion"},{"inlineContent":[{"text":"Returns ","type":"text"},{"type":"codeVoice","code":"true"},{"text":" when the ","type":"text"},{"type":"codeVoice","code":"URLError"},{"text":" code is one of the following:","type":"text"}],"type":"paragraph"},{"type":"unorderedList","items":[{"content":[{"type":"paragraph","inlineContent":[{"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/datanotallowed","type":"reference","isActive":true}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/notconnectedtointernet","isActive":true}]}]},{"content":[{"inlineContent":[{"type":"reference","isActive":true,"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/networkconnectionlost"}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/dnslookupfailed","isActive":true}]}]},{"content":[{"type":"paragraph","inlineContent":[{"isActive":true,"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/cannotfindhost"}]}]},{"content":[{"type":"paragraph","inlineContent":[{"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/cannotconnecttohost","isActive":true,"type":"reference"}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"reference","isActive":true,"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/timedout"}]}]},{"content":[{"inlineContent":[{"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/internationalroamingoff","type":"reference","isActive":true}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"isActive":true,"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/callisactive"}],"type":"paragraph"}]}]},{"inlineContent":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"URLError"},{"type":"text","text":" is available in the "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/cause","type":"reference","isActive":true},{"type":"text","text":" property."}],"type":"paragraph"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/isNetworkError","interfaceLanguage":"swift"},"schemaVersion":{"patch":0,"major":0,"minor":3},"references":{"https://developer.apple.com/documentation/foundation/urlerror/timedout":{"titleInlineContent":[{"text":"timedOut","type":"text"}],"url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/timedout","type":"link","title":"timedOut","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/timedout"},"https://developer.apple.com/documentation/foundation/urlerror/notconnectedtointernet":{"titleInlineContent":[{"text":"notConnectedToInternet","type":"text"}],"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/notconnectedtointernet","url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/notconnectedtointernet","type":"link","title":"notConnectedToInternet"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","type":"topic","kind":"symbol","abstract":[{"text":"Represents an error during a request to the Auth0 My Account API.","type":"text"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountError","kind":"identifier"}],"navigatorTitle":[{"text":"MyAccountError","kind":"identifier"}],"url":"\/documentation\/auth0\/myaccounterror","role":"symbol"},"https://developer.apple.com/documentation/foundation/urlerror/networkconnectionlost":{"titleInlineContent":[{"text":"networkConnectionLost","type":"text"}],"url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/networkconnectionlost","type":"link","title":"networkConnectionLost","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/networkconnectionlost"},"https://developer.apple.com/documentation/foundation/urlerror/callisactive":{"titleInlineContent":[{"text":"callIsActive","type":"text"}],"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/callisactive","url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/callisactive","type":"link","title":"callIsActive"},"https://developer.apple.com/documentation/foundation/urlerror/cannotfindhost":{"titleInlineContent":[{"text":"cannotFindHost","type":"text"}],"url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/cannotfindhost","type":"link","title":"cannotFindHost","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/cannotfindhost"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/cause":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/cause","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":"."}],"url":"\/documentation\/auth0\/myaccounterror\/cause","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:s5ErrorP","text":"Error","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"title":"cause"},"https://developer.apple.com/documentation/foundation/urlerror/internationalroamingoff":{"titleInlineContent":[{"text":"internationalRoamingOff","type":"text"}],"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/internationalroamingoff","url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/internationalroamingoff","type":"link","title":"internationalRoamingOff"},"https://developer.apple.com/documentation/foundation/urlerror/datanotallowed":{"titleInlineContent":[{"text":"dataNotAllowed","type":"text"}],"url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/datanotallowed","type":"link","title":"dataNotAllowed","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/datanotallowed"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/isNetworkError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/isNetworkError","kind":"symbol","type":"topic","abstract":[{"type":"text","text":"Whether the request failed due to network issues."}],"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isNetworkError"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"url":"\/documentation\/auth0\/myaccounterror\/isnetworkerror","title":"isNetworkError"},"https://developer.apple.com/documentation/foundation/urlerror/dnslookupfailed":{"url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/dnslookupfailed","title":"dnsLookupFailed","type":"link","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/dnslookupfailed","titleInlineContent":[{"text":"dnsLookupFailed","type":"text"}]},"https://developer.apple.com/documentation/foundation/urlerror/cannotconnecttohost":{"titleInlineContent":[{"type":"text","text":"cannotConnectToHost"}],"type":"link","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/cannotconnecttohost","url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/cannotconnecttohost","title":"cannotConnectToHost"}}} \ No newline at end of file +{"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/isNetworkError","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"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"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}]}]},{"kind":"content","content":[{"level":2,"anchor":"discussion","type":"heading","text":"Discussion"},{"inlineContent":[{"text":"Returns ","type":"text"},{"code":"true","type":"codeVoice"},{"text":" when the ","type":"text"},{"code":"URLError","type":"codeVoice"},{"text":" code is one of the following:","type":"text"}],"type":"paragraph"},{"type":"unorderedList","items":[{"content":[{"type":"paragraph","inlineContent":[{"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/datanotallowed","isActive":true}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/notconnectedtointernet","isActive":true}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/networkconnectionlost","isActive":true}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/dnslookupfailed","isActive":true}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/cannotfindhost","isActive":true}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/cannotconnecttohost","isActive":true}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/timedout","isActive":true}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/internationalroamingoff","isActive":true}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/callisactive","isActive":true}]}]}]},{"inlineContent":[{"text":"The underlying ","type":"text"},{"code":"URLError","type":"codeVoice"},{"text":" is available in the ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/cause","isActive":true,"type":"reference"},{"text":" property.","type":"text"}],"type":"paragraph"}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/myaccounterror\/isnetworkerror"]}],"kind":"symbol","metadata":{"modules":[{"name":"Auth0"}],"title":"isNetworkError","externalID":"s:5Auth00A8APIErrorPAAE14isNetworkErrorSbvp::SYNTHESIZED::s:5Auth014MyAccountErrorV","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isNetworkError"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"extendedModule":"Auth0","roleHeading":"Instance Property","symbolKind":"property"},"schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"type":"text","text":"Whether the request failed due to network issues."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError"]]},"references":{"https://developer.apple.com/documentation/foundation/urlerror/networkconnectionlost":{"title":"networkConnectionLost","type":"link","titleInlineContent":[{"type":"text","text":"networkConnectionLost"}],"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/networkconnectionlost","url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/networkconnectionlost"},"https://developer.apple.com/documentation/foundation/urlerror/cannotconnecttohost":{"title":"cannotConnectToHost","type":"link","titleInlineContent":[{"type":"text","text":"cannotConnectToHost"}],"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/cannotconnecttohost","url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/cannotconnecttohost"},"https://developer.apple.com/documentation/foundation/urlerror/callisactive":{"title":"callIsActive","type":"link","titleInlineContent":[{"type":"text","text":"callIsActive"}],"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/callisactive","url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/callisactive"},"https://developer.apple.com/documentation/foundation/urlerror/cannotfindhost":{"title":"cannotFindHost","type":"link","titleInlineContent":[{"type":"text","text":"cannotFindHost"}],"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/cannotfindhost","url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/cannotfindhost"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/cause":{"title":"cause","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/cause","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP","text":"Error"},{"kind":"text","text":"?"}],"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":"."}],"url":"\/documentation\/auth0\/myaccounterror\/cause"},"https://developer.apple.com/documentation/foundation/urlerror/internationalroamingoff":{"title":"internationalRoamingOff","type":"link","titleInlineContent":[{"type":"text","text":"internationalRoamingOff"}],"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/internationalroamingoff","url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/internationalroamingoff"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccountError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 My Account API."}],"url":"\/documentation\/auth0\/myaccounterror","navigatorTitle":[{"kind":"identifier","text":"MyAccountError"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"https://developer.apple.com/documentation/foundation/urlerror/notconnectedtointernet":{"title":"notConnectedToInternet","type":"link","titleInlineContent":[{"type":"text","text":"notConnectedToInternet"}],"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/notconnectedtointernet","url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/notconnectedtointernet"},"https://developer.apple.com/documentation/foundation/urlerror/datanotallowed":{"title":"dataNotAllowed","type":"link","titleInlineContent":[{"type":"text","text":"dataNotAllowed"}],"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/datanotallowed","url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/datanotallowed"},"https://developer.apple.com/documentation/foundation/urlerror/timedout":{"title":"timedOut","type":"link","titleInlineContent":[{"type":"text","text":"timedOut"}],"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/timedout","url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/timedout"},"https://developer.apple.com/documentation/foundation/urlerror/dnslookupfailed":{"title":"dnsLookupFailed","type":"link","titleInlineContent":[{"type":"text","text":"dnsLookupFailed"}],"identifier":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/dnslookupfailed","url":"https:\/\/developer.apple.com\/documentation\/foundation\/urlerror\/dnslookupfailed"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/isNetworkError":{"title":"isNetworkError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/isNetworkError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"isNetworkError"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"abstract":[{"type":"text","text":"Whether the request failed due to network issues."}],"url":"\/documentation\/auth0\/myaccounterror\/isnetworkerror"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/myaccounterror/localizeddescription.json b/docs/data/documentation/auth0/myaccounterror/localizeddescription.json index cf049fee8..0bf538405 100644 --- a/docs/data/documentation/auth0/myaccounterror/localizeddescription.json +++ b/docs/data/documentation/auth0/myaccounterror/localizeddescription.json @@ -1 +1 @@ -{"metadata":{"roleHeading":"Instance Property","extendedModule":"Auth0","modules":[{"name":"Auth0"}],"title":"localizedDescription","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"localizedDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"externalID":"s:5Auth00A5ErrorPAAE20localizedDescriptionSSvp::SYNTHESIZED::s:5Auth014MyAccountErrorV","role":"symbol","symbolKind":"property"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/localizedDescription"},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError"]]},"kind":"symbol","schemaVersion":{"patch":0,"minor":3,"major":0},"abstract":[{"type":"text","text":"Description of the error."}],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"localizedDescription"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"},{"content":[{"level":2,"anchor":"discussion","type":"heading","text":"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."}]}],"style":"important","name":"Important","type":"aside"}],"kind":"content"}],"variants":[{"paths":["\/documentation\/auth0\/myaccounterror\/localizeddescription"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/localizedDescription":{"kind":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/localizedDescription","abstract":[{"type":"text","text":"Description of the error."}],"fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"localizedDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"title":"localizedDescription","url":"\/documentation\/auth0\/myaccounterror\/localizeddescription","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","type":"topic","kind":"symbol","abstract":[{"text":"Represents an error during a request to the Auth0 My Account API.","type":"text"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountError","kind":"identifier"}],"navigatorTitle":[{"text":"MyAccountError","kind":"identifier"}],"url":"\/documentation\/auth0\/myaccounterror","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError"]]},"metadata":{"roleHeading":"Instance Property","symbolKind":"property","modules":[{"name":"Auth0"}],"title":"localizedDescription","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"localizedDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"externalID":"s:5Auth00A5ErrorPAAE20localizedDescriptionSSvp::SYNTHESIZED::s:5Auth014MyAccountErrorV","role":"symbol","extendedModule":"Auth0"},"sections":[],"abstract":[{"type":"text","text":"Description of the error."}],"variants":[{"paths":["\/documentation\/auth0\/myaccounterror\/localizeddescription"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/localizedDescription","interfaceLanguage":"swift"},"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"localizedDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}]}]},{"kind":"content","content":[{"level":2,"anchor":"discussion","type":"heading","text":"Discussion"},{"name":"Important","content":[{"inlineContent":[{"text":"You should avoid displaying the error description to the user, it’s meant for ","type":"text"},{"inlineContent":[{"type":"text","text":"debugging"}],"type":"strong"},{"text":" only.","type":"text"}],"type":"paragraph"}],"type":"aside","style":"important"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/localizedDescription":{"url":"\/documentation\/auth0\/myaccounterror\/localizeddescription","abstract":[{"type":"text","text":"Description of the error."}],"title":"localizedDescription","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"localizedDescription","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/localizedDescription","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccountError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 My Account API."}],"url":"\/documentation\/auth0\/myaccounterror","navigatorTitle":[{"kind":"identifier","text":"MyAccountError"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/myaccounterror/localizederror-implementations.json b/docs/data/documentation/auth0/myaccounterror/localizederror-implementations.json index 2ee983bd4..54e277dc0 100644 --- a/docs/data/documentation/auth0/myaccounterror/localizederror-implementations.json +++ b/docs/data/documentation/auth0/myaccounterror/localizederror-implementations.json @@ -1 +1 @@ -{"metadata":{"modules":[{"name":"Auth0"}],"role":"collectionGroup","title":"LocalizedError Implementations","roleHeading":"API Collection"},"kind":"article","topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/failureReason","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/helpAnchor","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/recoverySuggestion"],"generated":true,"anchor":"Instance-Properties","title":"Instance Properties"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/myaccounterror\/localizederror-implementations"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/LocalizedError-Implementations"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","type":"topic","kind":"symbol","abstract":[{"text":"Represents an error during a request to the Auth0 My Account API.","type":"text"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountError","kind":"identifier"}],"navigatorTitle":[{"text":"MyAccountError","kind":"identifier"}],"url":"\/documentation\/auth0\/myaccounterror","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/failureReason":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/failureReason","title":"failureReason","url":"\/documentation\/auth0\/myaccounterror\/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"}],"kind":"symbol","abstract":[]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/recoverySuggestion":{"kind":"symbol","abstract":[],"type":"topic","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/recoverySuggestion","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"recoverySuggestion"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"url":"\/documentation\/auth0\/myaccounterror\/recoverysuggestion","title":"recoverySuggestion"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/helpAnchor":{"type":"topic","title":"helpAnchor","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"helpAnchor","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"url":"\/documentation\/auth0\/myaccounterror\/helpanchor","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/helpAnchor","kind":"symbol","abstract":[],"role":"symbol"}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/myaccounterror\/localizederror-implementations"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError"]]},"topicSections":[{"title":"Instance Properties","generated":true,"anchor":"Instance-Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/failureReason","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/helpAnchor","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/recoverySuggestion"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"article","sections":[],"metadata":{"title":"LocalizedError Implementations","modules":[{"name":"Auth0"}],"roleHeading":"API Collection","role":"collectionGroup"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/LocalizedError-Implementations","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/helpAnchor":{"role":"symbol","title":"helpAnchor","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"helpAnchor"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"abstract":[],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/helpAnchor","url":"\/documentation\/auth0\/myaccounterror\/helpanchor","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/failureReason":{"url":"\/documentation\/auth0\/myaccounterror\/failurereason","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"failureReason"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"title":"failureReason","type":"topic","role":"symbol","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/failureReason","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccountError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 My Account API."}],"url":"\/documentation\/auth0\/myaccounterror","navigatorTitle":[{"kind":"identifier","text":"MyAccountError"}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/recoverySuggestion":{"type":"topic","abstract":[],"title":"recoverySuggestion","url":"\/documentation\/auth0\/myaccounterror\/recoverysuggestion","kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"recoverySuggestion"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/recoverySuggestion"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/myaccounterror/message.json b/docs/data/documentation/auth0/myaccounterror/message.json new file mode 100644 index 000000000..496a80585 --- /dev/null +++ b/docs/data/documentation/auth0/myaccounterror/message.json @@ -0,0 +1 @@ +{"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/message","interfaceLanguage":"swift"},"kind":"symbol","metadata":{"externalID":"s:5Auth014MyAccountErrorV7messageSSvp","modules":[{"name":"Auth0"}],"title":"message","extendedModule":"Auth0","roleHeading":"Instance Property","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"message"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"role":"symbol","symbolKind":"property"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/myaccounterror\/message"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"message","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccountError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 My Account API."}],"url":"\/documentation\/auth0\/myaccounterror","navigatorTitle":[{"kind":"identifier","text":"MyAccountError"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/message":{"kind":"symbol","title":"message","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"message"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/message","abstract":[],"url":"\/documentation\/auth0\/myaccounterror\/message"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/myaccounterror/recoverysuggestion.json b/docs/data/documentation/auth0/myaccounterror/recoverysuggestion.json index f33bcfdb0..baad277e6 100644 --- a/docs/data/documentation/auth0/myaccounterror/recoverysuggestion.json +++ b/docs/data/documentation/auth0/myaccounterror/recoverysuggestion.json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"recoverySuggestion","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"? { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"platforms":["iOS"]}]}],"abstract":[{"text":"Inherited from ","type":"text"},{"code":"LocalizedError.recoverySuggestion","type":"codeVoice"},{"text":".","type":"text"}],"variants":[{"paths":["\/documentation\/auth0\/myaccounterror\/recoverysuggestion"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/recoverySuggestion"},"kind":"symbol","sections":[],"metadata":{"externalID":"s:10Foundation14LocalizedErrorPAAE18recoverySuggestionSSSgvp::SYNTHESIZED::s:5Auth014MyAccountErrorV","symbolKind":"property","extendedModule":"Foundation","modules":[{"relatedModules":["Foundation"],"name":"Auth0"}],"platforms":[{"beta":false,"deprecated":false,"introducedAt":"8.0","unavailable":false,"name":"iOS"},{"beta":false,"deprecated":false,"introducedAt":"8.0","unavailable":false,"name":"iPadOS"},{"beta":false,"deprecated":false,"introducedAt":"8.0","unavailable":false,"name":"Mac Catalyst"},{"beta":false,"deprecated":false,"introducedAt":"10.10","unavailable":false,"name":"macOS"},{"beta":false,"deprecated":false,"introducedAt":"9.0","unavailable":false,"name":"tvOS"},{"beta":false,"deprecated":false,"introducedAt":"2.0","unavailable":false,"name":"watchOS"}],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"recoverySuggestion"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"roleHeading":"Instance Property","title":"recoverySuggestion","role":"symbol"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","type":"topic","kind":"symbol","abstract":[{"text":"Represents an error during a request to the Auth0 My Account API.","type":"text"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountError","kind":"identifier"}],"navigatorTitle":[{"text":"MyAccountError","kind":"identifier"}],"url":"\/documentation\/auth0\/myaccounterror","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/recoverySuggestion":{"kind":"symbol","abstract":[],"type":"topic","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/recoverySuggestion","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"recoverySuggestion"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"url":"\/documentation\/auth0\/myaccounterror\/recoverysuggestion","title":"recoverySuggestion"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/myaccounterror\/recoverysuggestion"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError"]]},"abstract":[{"text":"Inherited from ","type":"text"},{"code":"LocalizedError.recoverySuggestion","type":"codeVoice"},{"text":".","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"recoverySuggestion"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"? { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"platforms":["iOS"]}]}],"kind":"symbol","sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"externalID":"s:10Foundation14LocalizedErrorPAAE18recoverySuggestionSSSgvp::SYNTHESIZED::s:5Auth014MyAccountErrorV","extendedModule":"Foundation","platforms":[{"introducedAt":"8.0","unavailable":false,"name":"iOS","beta":false,"deprecated":false},{"introducedAt":"8.0","unavailable":false,"name":"iPadOS","beta":false,"deprecated":false},{"introducedAt":"8.0","unavailable":false,"name":"Mac Catalyst","beta":false,"deprecated":false},{"introducedAt":"10.10","unavailable":false,"name":"macOS","beta":false,"deprecated":false},{"introducedAt":"9.0","unavailable":false,"name":"tvOS","beta":false,"deprecated":false},{"introducedAt":"2.0","unavailable":false,"name":"watchOS","beta":false,"deprecated":false}],"symbolKind":"property","title":"recoverySuggestion","role":"symbol","roleHeading":"Instance Property","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"recoverySuggestion","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"modules":[{"relatedModules":["Foundation"],"name":"Auth0"}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/recoverySuggestion"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccountError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 My Account API."}],"url":"\/documentation\/auth0\/myaccounterror","navigatorTitle":[{"kind":"identifier","text":"MyAccountError"}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/recoverySuggestion":{"type":"topic","abstract":[],"title":"recoverySuggestion","url":"\/documentation\/auth0\/myaccounterror\/recoverysuggestion","kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"recoverySuggestion"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/recoverySuggestion"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/myaccounterror/statuscode.json b/docs/data/documentation/auth0/myaccounterror/statuscode.json index 7f1f6158e..6c144fc4c 100644 --- a/docs/data/documentation/auth0/myaccounterror/statuscode.json +++ b/docs/data/documentation/auth0/myaccounterror/statuscode.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/statusCode","interfaceLanguage":"swift"},"metadata":{"modules":[{"name":"Auth0"}],"externalID":"s:5Auth014MyAccountErrorV10statusCodeSivp","role":"symbol","title":"statusCode","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"statusCode","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"}],"roleHeading":"Instance Property","symbolKind":"property"},"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"statusCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"}],"platforms":["iOS"]}],"kind":"declarations"}],"schemaVersion":{"major":0,"patch":0,"minor":3},"kind":"symbol","sections":[],"variants":[{"paths":["\/documentation\/auth0\/myaccounterror\/statuscode"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"text":"HTTP status code of the response.","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","type":"topic","kind":"symbol","abstract":[{"text":"Represents an error during a request to the Auth0 My Account API.","type":"text"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountError","kind":"identifier"}],"navigatorTitle":[{"text":"MyAccountError","kind":"identifier"}],"url":"\/documentation\/auth0\/myaccounterror","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/statusCode":{"url":"\/documentation\/auth0\/myaccounterror\/statuscode","kind":"symbol","abstract":[{"text":"HTTP status code of the response.","type":"text"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/statusCode","role":"symbol","title":"statusCode","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"statusCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"}]}}} \ No newline at end of file +{"metadata":{"symbolKind":"property","roleHeading":"Instance Property","title":"statusCode","externalID":"s:5Auth014MyAccountErrorV10statusCodeSivp","modules":[{"name":"Auth0"}],"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"statusCode","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Int","preciseIdentifier":"s:Si","kind":"typeIdentifier"}],"role":"symbol"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/myaccounterror\/statuscode"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/statusCode"},"kind":"symbol","abstract":[{"type":"text","text":"HTTP status code of the response."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"statusCode","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Int","preciseIdentifier":"s:Si","kind":"typeIdentifier"}],"languages":["swift"],"platforms":["iOS"]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccountError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 My Account API."}],"url":"\/documentation\/auth0\/myaccounterror","navigatorTitle":[{"kind":"identifier","text":"MyAccountError"}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/statusCode":{"type":"topic","title":"statusCode","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/statusCode","kind":"symbol","abstract":[{"type":"text","text":"HTTP status code of the response."}],"url":"\/documentation\/auth0\/myaccounterror\/statuscode","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"statusCode"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/myaccounterror/title.json b/docs/data/documentation/auth0/myaccounterror/title.json index baaa20f95..8c0ca3f2e 100644 --- a/docs/data/documentation/auth0/myaccounterror/title.json +++ b/docs/data/documentation/auth0/myaccounterror/title.json @@ -1 +1 @@ -{"sections":[],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/myaccounterror\/title"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/title"},"schemaVersion":{"minor":3,"major":0,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError"]]},"metadata":{"roleHeading":"Instance Property","externalID":"s:5Auth014MyAccountErrorV5titleSSvp","role":"symbol","symbolKind":"property","title":"title","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"title","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}]},"abstract":[{"text":"Error description.","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"title"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"languages":["swift"]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/title":{"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"title","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"title":"title","kind":"symbol","type":"topic","abstract":[{"text":"Error description.","type":"text"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/title","url":"\/documentation\/auth0\/myaccounterror\/title"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","type":"topic","kind":"symbol","abstract":[{"text":"Represents an error during a request to the Auth0 My Account API.","type":"text"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountError","kind":"identifier"}],"navigatorTitle":[{"text":"MyAccountError","kind":"identifier"}],"url":"\/documentation\/auth0\/myaccounterror","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"sections":[],"kind":"symbol","metadata":{"externalID":"s:5Auth014MyAccountErrorV5titleSSvp","modules":[{"name":"Auth0"}],"title":"title","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"title","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"roleHeading":"Instance Property","role":"symbol","symbolKind":"property"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/title","interfaceLanguage":"swift"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/myaccounterror\/title"]}],"schemaVersion":{"patch":0,"minor":3,"major":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError"]]},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"title","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"abstract":[{"text":"Error description.","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccountError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 My Account API."}],"url":"\/documentation\/auth0\/myaccounterror","navigatorTitle":[{"kind":"identifier","text":"MyAccountError"}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/title":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/title","title":"title","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"title","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"role":"symbol","url":"\/documentation\/auth0\/myaccounterror\/title","abstract":[{"text":"Error description.","type":"text"}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/myaccounterror/validationerror.json b/docs/data/documentation/auth0/myaccounterror/validationerror.json index 12df4dc4e..0d8a34d25 100644 --- a/docs/data/documentation/auth0/myaccounterror/validationerror.json +++ b/docs/data/documentation/auth0/myaccounterror/validationerror.json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ValidationError"}],"languages":["swift"],"platforms":["iOS"]}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError"]]},"metadata":{"role":"symbol","externalID":"s:5Auth014MyAccountErrorV010ValidationD0V","modules":[{"name":"Auth0"}],"symbolKind":"struct","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ValidationError"}],"navigatorTitle":[{"kind":"identifier","text":"ValidationError"}],"roleHeading":"Structure","title":"MyAccountError.ValidationError"},"sections":[],"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/myaccounterror\/validationerror"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"patch":0,"minor":3,"major":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/ValidationError","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"A server-side validation error."}],"topicSections":[{"generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/ValidationError\/Equatable-Implementations"],"anchor":"Default-Implementations","title":"Default Implementations"}],"relationshipsSections":[{"type":"conformsTo","identifiers":["doc:\/\/com.auth0.Auth0\/SQ","doc:\/\/com.auth0.Auth0\/s8SendableP","doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP"],"kind":"relationships","title":"Conforms To"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","type":"topic","kind":"symbol","abstract":[{"text":"Represents an error during a request to the Auth0 My Account API.","type":"text"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountError","kind":"identifier"}],"navigatorTitle":[{"text":"MyAccountError","kind":"identifier"}],"url":"\/documentation\/auth0\/myaccounterror","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/ValidationError/Equatable-Implementations":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/ValidationError\/Equatable-Implementations","kind":"article","type":"topic","url":"\/documentation\/auth0\/myaccounterror\/validationerror\/equatable-implementations","abstract":[],"role":"collectionGroup","title":"Equatable Implementations"},"doc://com.auth0.Auth0/SQ":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/SQ","title":"Swift.Equatable"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/ValidationError":{"title":"MyAccountError.ValidationError","abstract":[{"type":"text","text":"A server-side validation error."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/ValidationError","kind":"symbol","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"ValidationError"}],"type":"topic","url":"\/documentation\/auth0\/myaccounterror\/validationerror","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ValidationError"}]},"doc://com.auth0.Auth0/s8SendableP":{"type":"unresolvable","title":"Swift.Sendable","identifier":"doc:\/\/com.auth0.Auth0\/s8SendableP"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/s16SendableMetatypeP":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP","title":"Swift.SendableMetatype"}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/myaccounterror\/validationerror"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError"]]},"abstract":[{"type":"text","text":"A server-side validation error."}],"topicSections":[{"title":"Instance Properties","generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/ValidationError\/detail","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/ValidationError\/field","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/ValidationError\/pointer","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/ValidationError\/source"],"anchor":"Instance-Properties"},{"title":"Default Implementations","generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/ValidationError\/Equatable-Implementations"],"anchor":"Default-Implementations"}],"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"relationshipsSections":[{"title":"Conforms To","type":"conformsTo","kind":"relationships","identifiers":["doc:\/\/com.auth0.Auth0\/SQ","doc:\/\/com.auth0.Auth0\/s8SendableP","doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP"]}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ValidationError"}]}],"kind":"declarations"}],"metadata":{"externalID":"s:5Auth014MyAccountErrorV010ValidationD0V","symbolKind":"struct","title":"MyAccountError.ValidationError","role":"symbol","roleHeading":"Structure","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ValidationError"}],"navigatorTitle":[{"kind":"identifier","text":"ValidationError"}],"modules":[{"name":"Auth0"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/ValidationError","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/SQ":{"title":"Swift.Equatable","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/SQ"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/ValidationError/Equatable-Implementations":{"type":"topic","abstract":[],"title":"Equatable Implementations","url":"\/documentation\/auth0\/myaccounterror\/validationerror\/equatable-implementations","kind":"article","role":"collectionGroup","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/ValidationError\/Equatable-Implementations"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/ValidationError/source":{"type":"topic","abstract":[],"title":"source","url":"\/documentation\/auth0\/myaccounterror\/validationerror\/source","kind":"symbol","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"source"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/ValidationError\/source"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccountError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 My Account API."}],"url":"\/documentation\/auth0\/myaccounterror","navigatorTitle":[{"kind":"identifier","text":"MyAccountError"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/ValidationError/pointer":{"role":"symbol","title":"pointer","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"pointer","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"abstract":[{"type":"text","text":"The property in the request payload that failed validation."}],"kind":"symbol","url":"\/documentation\/auth0\/myaccounterror\/validationerror\/pointer","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/ValidationError\/pointer","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/ValidationError":{"title":"MyAccountError.ValidationError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/ValidationError","type":"topic","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ValidationError"}],"abstract":[{"type":"text","text":"A server-side validation error."}],"url":"\/documentation\/auth0\/myaccounterror\/validationerror","navigatorTitle":[{"kind":"identifier","text":"ValidationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/ValidationError/detail":{"url":"\/documentation\/auth0\/myaccounterror\/validationerror\/detail","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"detail"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"title":"detail","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Information about the validation error."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/ValidationError\/detail","kind":"symbol"},"doc://com.auth0.Auth0/s8SendableP":{"title":"Swift.Sendable","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s8SendableP"},"doc://com.auth0.Auth0/s16SendableMetatypeP":{"title":"Swift.SendableMetatype","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/ValidationError/field":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/ValidationError\/field","kind":"symbol","title":"field","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"field","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"role":"symbol","url":"\/documentation\/auth0\/myaccounterror\/validationerror\/field","abstract":[],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/myaccounterror/validationerror/!=(_:_:).json b/docs/data/documentation/auth0/myaccounterror/validationerror/!=(_:_:).json index c0d074561..ded3cb451 100644 --- a/docs/data/documentation/auth0/myaccounterror/validationerror/!=(_:_:).json +++ b/docs/data/documentation/auth0/myaccounterror/validationerror/!=(_:_:).json @@ -1 +1 @@ -{"schemaVersion":{"minor":3,"major":0,"patch":0},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/ValidationError"]]},"abstract":[{"text":"Inherited from ","type":"text"},{"type":"codeVoice","code":"Equatable.!=(_:_:)"},{"text":".","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"lhs","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"internalParam","text":"rhs"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"languages":["swift"]}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/ValidationError\/!=(_:_:)","interfaceLanguage":"swift"},"metadata":{"roleHeading":"Operator","title":"!=(_:_:)","role":"symbol","extendedModule":"Swift","symbolKind":"op","modules":[{"relatedModules":["Swift"],"name":"Auth0"}],"fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"externalID":"s:SQsE2neoiySbx_xtFZ::SYNTHESIZED::s:5Auth014MyAccountErrorV010ValidationD0V"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/myaccounterror\/validationerror\/!=(_:_:)"]}],"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/ValidationError/!=(_:_:)":{"title":"!=(_:_:)","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/ValidationError\/!=(_:_:)","kind":"symbol","role":"symbol","type":"topic","url":"\/documentation\/auth0\/myaccounterror\/validationerror\/!=(_:_:)","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/ValidationError":{"title":"MyAccountError.ValidationError","abstract":[{"type":"text","text":"A server-side validation error."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/ValidationError","kind":"symbol","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"ValidationError"}],"type":"topic","url":"\/documentation\/auth0\/myaccounterror\/validationerror","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ValidationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","type":"topic","kind":"symbol","abstract":[{"text":"Represents an error during a request to the Auth0 My Account API.","type":"text"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountError","kind":"identifier"}],"navigatorTitle":[{"text":"MyAccountError","kind":"identifier"}],"url":"\/documentation\/auth0\/myaccounterror","role":"symbol"}}} \ No newline at end of file +{"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/ValidationError\/!=(_:_:)","interfaceLanguage":"swift"},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"lhs","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"rhs","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}]}],"kind":"declarations"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/myaccounterror\/validationerror\/!=(_:_:)"]}],"kind":"symbol","metadata":{"modules":[{"name":"Auth0","relatedModules":["Swift"]}],"title":"!=(_:_:)","roleHeading":"Operator","symbolKind":"op","role":"symbol","extendedModule":"Swift","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"externalID":"s:SQsE2neoiySbx_xtFZ::SYNTHESIZED::s:5Auth014MyAccountErrorV010ValidationD0V"},"schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"Equatable.!=(_:_:)"},{"type":"text","text":"."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/ValidationError"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/ValidationError/!=(_:_:)":{"kind":"symbol","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","text":"Self"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"title":"!=(_:_:)","type":"topic","role":"symbol","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/ValidationError\/!=(_:_:)","url":"\/documentation\/auth0\/myaccounterror\/validationerror\/!=(_:_:)"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccountError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 My Account API."}],"url":"\/documentation\/auth0\/myaccounterror","navigatorTitle":[{"kind":"identifier","text":"MyAccountError"}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/ValidationError":{"title":"MyAccountError.ValidationError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/ValidationError","type":"topic","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ValidationError"}],"abstract":[{"type":"text","text":"A server-side validation error."}],"url":"\/documentation\/auth0\/myaccounterror\/validationerror","navigatorTitle":[{"kind":"identifier","text":"ValidationError"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/myaccounterror/validationerror/detail.json b/docs/data/documentation/auth0/myaccounterror/validationerror/detail.json new file mode 100644 index 000000000..8ccf3b4f2 --- /dev/null +++ b/docs/data/documentation/auth0/myaccounterror/validationerror/detail.json @@ -0,0 +1 @@ +{"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"detail","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"languages":["swift"],"platforms":["iOS"]}]}],"sections":[],"abstract":[{"type":"text","text":"Information about the validation error."}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/myaccounterror\/validationerror\/detail"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/ValidationError\/detail"},"metadata":{"modules":[{"name":"Auth0"}],"symbolKind":"property","roleHeading":"Instance Property","title":"detail","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"detail","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"externalID":"s:5Auth014MyAccountErrorV010ValidationD0V6detailSSvp"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/ValidationError"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccountError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 My Account API."}],"url":"\/documentation\/auth0\/myaccounterror","navigatorTitle":[{"kind":"identifier","text":"MyAccountError"}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/ValidationError":{"title":"MyAccountError.ValidationError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/ValidationError","type":"topic","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ValidationError"}],"abstract":[{"type":"text","text":"A server-side validation error."}],"url":"\/documentation\/auth0\/myaccounterror\/validationerror","navigatorTitle":[{"kind":"identifier","text":"ValidationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/ValidationError/detail":{"url":"\/documentation\/auth0\/myaccounterror\/validationerror\/detail","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"detail"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"title":"detail","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Information about the validation error."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/ValidationError\/detail","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/myaccounterror/validationerror/equatable-implementations.json b/docs/data/documentation/auth0/myaccounterror/validationerror/equatable-implementations.json index 106976e76..6fe44abe2 100644 --- a/docs/data/documentation/auth0/myaccounterror/validationerror/equatable-implementations.json +++ b/docs/data/documentation/auth0/myaccounterror/validationerror/equatable-implementations.json @@ -1 +1 @@ -{"kind":"article","metadata":{"modules":[{"name":"Auth0"}],"title":"Equatable Implementations","role":"collectionGroup","roleHeading":"API Collection"},"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/ValidationError\/Equatable-Implementations","interfaceLanguage":"swift"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/myaccounterror\/validationerror\/equatable-implementations"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/ValidationError"]]},"topicSections":[{"generated":true,"title":"Operators","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/ValidationError\/!=(_:_:)"],"anchor":"Operators"}],"schemaVersion":{"minor":3,"patch":0,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/ValidationError":{"title":"MyAccountError.ValidationError","abstract":[{"type":"text","text":"A server-side validation error."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/ValidationError","kind":"symbol","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"ValidationError"}],"type":"topic","url":"\/documentation\/auth0\/myaccounterror\/validationerror","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ValidationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/ValidationError/!=(_:_:)":{"title":"!=(_:_:)","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/ValidationError\/!=(_:_:)","kind":"symbol","role":"symbol","type":"topic","url":"\/documentation\/auth0\/myaccounterror\/validationerror\/!=(_:_:)","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","type":"topic","kind":"symbol","abstract":[{"text":"Represents an error during a request to the Auth0 My Account API.","type":"text"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountError","kind":"identifier"}],"navigatorTitle":[{"text":"MyAccountError","kind":"identifier"}],"url":"\/documentation\/auth0\/myaccounterror","role":"symbol"}}} \ No newline at end of file +{"topicSections":[{"anchor":"Operators","title":"Operators","generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/ValidationError\/!=(_:_:)"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/ValidationError"]]},"metadata":{"role":"collectionGroup","title":"Equatable Implementations","roleHeading":"API Collection","modules":[{"name":"Auth0"}]},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/myaccounterror\/validationerror\/equatable-implementations"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/ValidationError\/Equatable-Implementations","interfaceLanguage":"swift"},"kind":"article","schemaVersion":{"patch":0,"minor":3,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/ValidationError":{"title":"MyAccountError.ValidationError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/ValidationError","type":"topic","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ValidationError"}],"abstract":[{"type":"text","text":"A server-side validation error."}],"url":"\/documentation\/auth0\/myaccounterror\/validationerror","navigatorTitle":[{"kind":"identifier","text":"ValidationError"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccountError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 My Account API."}],"url":"\/documentation\/auth0\/myaccounterror","navigatorTitle":[{"kind":"identifier","text":"MyAccountError"}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/ValidationError/!=(_:_:)":{"kind":"symbol","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","text":"Self"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"title":"!=(_:_:)","type":"topic","role":"symbol","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/ValidationError\/!=(_:_:)","url":"\/documentation\/auth0\/myaccounterror\/validationerror\/!=(_:_:)"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/myaccounterror/validationerror/field.json b/docs/data/documentation/auth0/myaccounterror/validationerror/field.json new file mode 100644 index 000000000..3879c61aa --- /dev/null +++ b/docs/data/documentation/auth0/myaccounterror/validationerror/field.json @@ -0,0 +1 @@ +{"sections":[],"metadata":{"externalID":"s:5Auth014MyAccountErrorV010ValidationD0V5fieldSSSgvp","modules":[{"name":"Auth0"}],"title":"field","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"field"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"roleHeading":"Instance Property","role":"symbol","symbolKind":"property"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/ValidationError\/field"},"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/myaccounterror\/validationerror\/field"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/ValidationError"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"field"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/ValidationError":{"title":"MyAccountError.ValidationError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/ValidationError","type":"topic","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ValidationError"}],"abstract":[{"type":"text","text":"A server-side validation error."}],"url":"\/documentation\/auth0\/myaccounterror\/validationerror","navigatorTitle":[{"kind":"identifier","text":"ValidationError"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/ValidationError/field":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/ValidationError\/field","kind":"symbol","title":"field","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"field","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"role":"symbol","url":"\/documentation\/auth0\/myaccounterror\/validationerror\/field","abstract":[],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccountError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 My Account API."}],"url":"\/documentation\/auth0\/myaccounterror","navigatorTitle":[{"kind":"identifier","text":"MyAccountError"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/myaccounterror/validationerror/pointer.json b/docs/data/documentation/auth0/myaccounterror/validationerror/pointer.json new file mode 100644 index 000000000..9e16fdf79 --- /dev/null +++ b/docs/data/documentation/auth0/myaccounterror/validationerror/pointer.json @@ -0,0 +1 @@ +{"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"pointer","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]}],"sections":[],"abstract":[{"type":"text","text":"The property in the request payload that failed validation."}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/myaccounterror\/validationerror\/pointer"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/ValidationError\/pointer"},"metadata":{"role":"symbol","modules":[{"name":"Auth0"}],"title":"pointer","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"pointer","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"externalID":"s:5Auth014MyAccountErrorV010ValidationD0V7pointerSSSgvp","roleHeading":"Instance Property","symbolKind":"property"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/ValidationError"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccountError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 My Account API."}],"url":"\/documentation\/auth0\/myaccounterror","navigatorTitle":[{"kind":"identifier","text":"MyAccountError"}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/ValidationError/pointer":{"role":"symbol","title":"pointer","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"pointer","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"abstract":[{"type":"text","text":"The property in the request payload that failed validation."}],"kind":"symbol","url":"\/documentation\/auth0\/myaccounterror\/validationerror\/pointer","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/ValidationError\/pointer","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/ValidationError":{"title":"MyAccountError.ValidationError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/ValidationError","type":"topic","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ValidationError"}],"abstract":[{"type":"text","text":"A server-side validation error."}],"url":"\/documentation\/auth0\/myaccounterror\/validationerror","navigatorTitle":[{"kind":"identifier","text":"ValidationError"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/myaccounterror/validationerror/source.json b/docs/data/documentation/auth0/myaccounterror/validationerror/source.json new file mode 100644 index 000000000..68c39fb07 --- /dev/null +++ b/docs/data/documentation/auth0/myaccounterror/validationerror/source.json @@ -0,0 +1 @@ +{"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/ValidationError\/source"},"metadata":{"modules":[{"name":"Auth0"}],"title":"source","roleHeading":"Instance Property","symbolKind":"property","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"source","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"externalID":"s:5Auth014MyAccountErrorV010ValidationD0V6sourceSSSgvp"},"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/myaccounterror\/validationerror\/source"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/ValidationError"]]},"schemaVersion":{"major":0,"patch":0,"minor":3},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"source"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/ValidationError/source":{"type":"topic","abstract":[],"title":"source","url":"\/documentation\/auth0\/myaccounterror\/validationerror\/source","kind":"symbol","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"source"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/ValidationError\/source"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/ValidationError":{"title":"MyAccountError.ValidationError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/ValidationError","type":"topic","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ValidationError"}],"abstract":[{"type":"text","text":"A server-side validation error."}],"url":"\/documentation\/auth0\/myaccounterror\/validationerror","navigatorTitle":[{"kind":"identifier","text":"ValidationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccountError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 My Account API."}],"url":"\/documentation\/auth0\/myaccounterror","navigatorTitle":[{"kind":"identifier","text":"MyAccountError"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/myaccounterror/validationerrors.json b/docs/data/documentation/auth0/myaccounterror/validationerrors.json index bf653791d..9965d536b 100644 --- a/docs/data/documentation/auth0/myaccounterror/validationerrors.json +++ b/docs/data/documentation/auth0/myaccounterror/validationerrors.json @@ -1 +1 @@ -{"sections":[],"metadata":{"roleHeading":"Instance Property","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"validationErrors","kind":"identifier"},{"text":": [","kind":"text"},{"text":"ValidationError","preciseIdentifier":"s:5Auth014MyAccountErrorV010ValidationD0V","kind":"typeIdentifier"},{"text":"]?","kind":"text"}],"symbolKind":"property","role":"symbol","modules":[{"name":"Auth0"}],"externalID":"s:5Auth014MyAccountErrorV16validationErrorsSayAC010ValidationD0VGSgvp","title":"validationErrors"},"abstract":[{"type":"text","text":"All the server-side validation errors."}],"variants":[{"paths":["\/documentation\/auth0\/myaccounterror\/validationerrors"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/validationErrors","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError"]]},"kind":"symbol","primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"validationErrors","kind":"identifier"},{"text":": [","kind":"text"},{"text":"ValidationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth014MyAccountErrorV010ValidationD0V","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/ValidationError"},{"text":"]?","kind":"text"}]}],"kind":"declarations"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/validationErrors":{"role":"symbol","kind":"symbol","title":"validationErrors","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/validationErrors","abstract":[{"text":"All the server-side validation errors.","type":"text"}],"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"validationErrors","kind":"identifier"},{"text":": [","kind":"text"},{"text":"ValidationError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth014MyAccountErrorV010ValidationD0V"},{"text":"]?","kind":"text"}],"url":"\/documentation\/auth0\/myaccounterror\/validationerrors","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","type":"topic","kind":"symbol","abstract":[{"text":"Represents an error during a request to the Auth0 My Account API.","type":"text"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountError","kind":"identifier"}],"navigatorTitle":[{"text":"MyAccountError","kind":"identifier"}],"url":"\/documentation\/auth0\/myaccounterror","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/ValidationError":{"title":"MyAccountError.ValidationError","abstract":[{"type":"text","text":"A server-side validation error."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/ValidationError","kind":"symbol","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"ValidationError"}],"type":"topic","url":"\/documentation\/auth0\/myaccounterror\/validationerror","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ValidationError"}]}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/myaccounterror\/validationerrors"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError"]]},"abstract":[{"text":"All the server-side validation errors.","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"validationErrors"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:5Auth014MyAccountErrorV010ValidationD0V","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/ValidationError","kind":"typeIdentifier","text":"ValidationError"},{"kind":"text","text":"]?"}],"platforms":["iOS"],"languages":["swift"]}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"kind":"symbol","sections":[],"metadata":{"externalID":"s:5Auth014MyAccountErrorV16validationErrorsSayAC010ValidationD0VGSgvp","symbolKind":"property","title":"validationErrors","role":"symbol","roleHeading":"Instance Property","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"validationErrors"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:5Auth014MyAccountErrorV010ValidationD0V","kind":"typeIdentifier","text":"ValidationError"},{"kind":"text","text":"]?"}],"modules":[{"name":"Auth0"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/validationErrors","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/validationErrors":{"role":"symbol","title":"validationErrors","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"validationErrors"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth014MyAccountErrorV010ValidationD0V","text":"ValidationError"},{"kind":"text","text":"]?"}],"abstract":[{"type":"text","text":"All the server-side validation errors."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/validationErrors","url":"\/documentation\/auth0\/myaccounterror\/validationerrors","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccountError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 My Account API."}],"url":"\/documentation\/auth0\/myaccounterror","navigatorTitle":[{"kind":"identifier","text":"MyAccountError"}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError/ValidationError":{"title":"MyAccountError.ValidationError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError\/ValidationError","type":"topic","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ValidationError"}],"abstract":[{"type":"text","text":"A server-side validation error."}],"url":"\/documentation\/auth0\/myaccounterror\/validationerror","navigatorTitle":[{"kind":"identifier","text":"ValidationError"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/myaccountresult.json b/docs/data/documentation/auth0/myaccountresult.json index dd803157d..4ff052cd5 100644 --- a/docs/data/documentation/auth0/myaccountresult.json +++ b/docs/data/documentation/auth0/myaccountresult.json @@ -1 +1 @@ -{"sections":[],"metadata":{"externalID":"s:5Auth015MyAccountResulta","role":"symbol","modules":[{"name":"Auth0"}],"fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountResult","kind":"identifier"}],"title":"MyAccountResult","navigatorTitle":[{"text":"MyAccountResult","kind":"identifier"}],"symbolKind":"typealias","roleHeading":"Type Alias"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"schemaVersion":{"minor":3,"patch":0,"major":0},"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountResult","interfaceLanguage":"swift"},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountResult","kind":"identifier"},{"text":"<","kind":"text"},{"text":"T","kind":"genericParameter"},{"text":"> = ","kind":"text"},{"text":"Result","kind":"typeIdentifier","preciseIdentifier":"s:s6ResultO"},{"text":"<","kind":"text"},{"text":"T","kind":"typeIdentifier","preciseIdentifier":"s:5Auth015MyAccountResulta1Txmfp"},{"text":", ","kind":"text"},{"text":"MyAccountError","preciseIdentifier":"s:5Auth014MyAccountErrorV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError"},{"text":">","kind":"text"}]}],"kind":"declarations"}],"abstract":[{"type":"codeVoice","code":"Result"},{"type":"text","text":" wrapper for My Account API operations."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/myaccountresult"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/MyAccountResult":{"url":"\/documentation\/auth0\/myaccountresult","role":"symbol","navigatorTitle":[{"text":"MyAccountResult","kind":"identifier"}],"type":"topic","abstract":[{"code":"Result","type":"codeVoice"},{"text":" wrapper for My Account API operations.","type":"text"}],"kind":"symbol","title":"MyAccountResult","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountResult","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountResult","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","type":"topic","kind":"symbol","abstract":[{"text":"Represents an error during a request to the Auth0 My Account API.","type":"text"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountError","kind":"identifier"}],"navigatorTitle":[{"text":"MyAccountError","kind":"identifier"}],"url":"\/documentation\/auth0\/myaccounterror","role":"symbol"}}} \ No newline at end of file +{"abstract":[{"type":"codeVoice","code":"Result"},{"type":"text","text":" wrapper for My Account API operations."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountResult","kind":"identifier"},{"text":"<","kind":"text"},{"text":"T","kind":"genericParameter"},{"text":"> = ","kind":"text"},{"text":"Result","kind":"typeIdentifier","preciseIdentifier":"s:s6ResultO"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth015MyAccountResulta1Txmfp","text":"T","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth014MyAccountErrorV","text":"MyAccountError","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError"},{"text":">","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/myaccountresult"]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"metadata":{"modules":[{"name":"Auth0"}],"title":"MyAccountResult","externalID":"s:5Auth015MyAccountResulta","role":"symbol","fragments":[{"kind":"keyword","text":"typealias"},{"text":" ","kind":"text"},{"kind":"identifier","text":"MyAccountResult"}],"symbolKind":"typealias","roleHeading":"Type Alias","navigatorTitle":[{"text":"MyAccountResult","kind":"identifier"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountResult","interfaceLanguage":"swift"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountError":{"title":"MyAccountError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccountError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 My Account API."}],"url":"\/documentation\/auth0\/myaccounterror","navigatorTitle":[{"kind":"identifier","text":"MyAccountError"}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountResult":{"title":"MyAccountResult","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountResult","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccountResult"}],"abstract":[{"code":"Result","type":"codeVoice"},{"text":" wrapper for My Account API operations.","type":"text"}],"url":"\/documentation\/auth0\/myaccountresult","navigatorTitle":[{"kind":"identifier","text":"MyAccountResult"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/newpasskey.json b/docs/data/documentation/auth0/newpasskey.json index d88c3f746..306331e4c 100644 --- a/docs/data/documentation/auth0/newpasskey.json +++ b/docs/data/documentation/auth0/newpasskey.json @@ -1 +1 @@ -{"relationshipsSections":[{"kind":"relationships","title":"Inherited By","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SignupPasskey"],"type":"inheritedBy"},{"kind":"relationships","title":"Conforming Types","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationServices\/ASAuthorizationPlatformPublicKeyCredentialRegistration"],"type":"conformingTypes"}],"schemaVersion":{"patch":0,"minor":3,"major":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"abstract":[{"text":"The signup passkey credential obtained from the ","type":"text"},{"isActive":true,"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","type":"reference"},{"text":" delegate.","type":"text"},{"text":" ","type":"text"},{"text":"Contains the subset of relevant properties from ","type":"text"},{"isActive":true,"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialregistration","type":"reference"},{"text":".","type":"text"}],"topicSections":[{"title":"Instance Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/NewPasskey\/attachment","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/NewPasskey\/credentialID","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/NewPasskey\/rawAttestationObject","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/NewPasskey\/rawClientDataJSON"],"generated":true,"anchor":"Instance-Properties"}],"sections":[],"metadata":{"title":"NewPasskey","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"NewPasskey"}],"platforms":[{"unavailable":false,"beta":false,"deprecated":false,"name":"iOS","introducedAt":"16.6"},{"unavailable":false,"beta":false,"deprecated":false,"name":"iPadOS","introducedAt":"16.6"},{"unavailable":false,"beta":false,"deprecated":false,"name":"Mac Catalyst","introducedAt":"16.6"},{"unavailable":false,"beta":false,"deprecated":false,"name":"macOS","introducedAt":"13.5"},{"unavailable":false,"beta":false,"deprecated":false,"name":"visionOS","introducedAt":"1.0"}],"navigatorTitle":[{"kind":"identifier","text":"NewPasskey"}],"roleHeading":"Protocol","externalID":"s:5Auth010NewPasskeyP","symbolKind":"protocol","role":"symbol"},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"NewPasskey","kind":"identifier"}],"languages":["swift"]}]}],"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/NewPasskey"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/newpasskey"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/NewPasskey/attachment":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/NewPasskey\/attachment","abstract":[],"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"attachment"},{"kind":"text","text":": "},{"preciseIdentifier":"c:@E@ASAuthorizationPublicKeyCredentialAttachment","kind":"typeIdentifier","text":"ASAuthorizationPublicKeyCredentialAttachment"}],"role":"symbol","url":"\/documentation\/auth0\/newpasskey\/attachment","required":true,"type":"topic","title":"attachment","kind":"symbol"},"https://developer.apple.com/documentation/authenticationservices/asauthorizationcontrollerdelegate":{"title":"ASAuthorizationControllerDelegate","type":"link","titleInlineContent":[{"type":"codeVoice","code":"ASAuthorizationControllerDelegate"}],"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate"},"https://developer.apple.com/documentation/authenticationservices/asauthorizationplatformpublickeycredentialregistration":{"title":"ASAuthorizationPlatformPublicKeyCredentialRegistration","type":"link","titleInlineContent":[{"type":"codeVoice","code":"ASAuthorizationPlatformPublicKeyCredentialRegistration"}],"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialregistration","url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialregistration"},"doc://com.auth0.Auth0/documentation/Auth0/NewPasskey":{"role":"symbol","title":"NewPasskey","abstract":[{"text":"The signup passkey credential obtained from the ","type":"text"},{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","isActive":true,"type":"reference"},{"text":" delegate.","type":"text"},{"text":" ","type":"text"},{"text":"Contains the subset of relevant properties from ","type":"text"},{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialregistration","isActive":true,"type":"reference"},{"text":".","type":"text"}],"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/newpasskey","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/NewPasskey","navigatorTitle":[{"text":"NewPasskey","kind":"identifier"}],"fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"NewPasskey","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/NewPasskey/rawClientDataJSON":{"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"rawClientDataJSON"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV","text":"Data"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/NewPasskey\/rawClientDataJSON","abstract":[],"title":"rawClientDataJSON","type":"topic","url":"\/documentation\/auth0\/newpasskey\/rawclientdatajson","required":true},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationServices/ASAuthorizationPlatformPublicKeyCredentialRegistration":{"title":"ASAuthorizationPlatformPublicKeyCredentialRegistration","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationServices\/ASAuthorizationPlatformPublicKeyCredentialRegistration"},"doc://com.auth0.Auth0/documentation/Auth0/SignupPasskey":{"type":"topic","kind":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"SignupPasskey","kind":"identifier"}],"url":"\/documentation\/auth0\/signuppasskey","abstract":[{"type":"text","text":"The signup passkey credential obtained from the "},{"isActive":true,"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","type":"reference"},{"type":"text","text":" delegate."},{"type":"text","text":" "},{"type":"text","text":"Contains the subset of relevant properties from "},{"isActive":true,"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialregistration","type":"reference"},{"type":"text","text":"."}],"role":"symbol","navigatorTitle":[{"text":"SignupPasskey","kind":"identifier"}],"title":"SignupPasskey","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SignupPasskey"},"doc://com.auth0.Auth0/documentation/Auth0/NewPasskey/rawAttestationObject":{"abstract":[],"kind":"symbol","role":"symbol","required":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/NewPasskey\/rawAttestationObject","url":"\/documentation\/auth0\/newpasskey\/rawattestationobject","title":"rawAttestationObject","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"rawAttestationObject"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV","text":"Data"},{"kind":"text","text":"?"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/NewPasskey/credentialID":{"url":"\/documentation\/auth0\/newpasskey\/credentialid","type":"topic","kind":"symbol","role":"symbol","required":true,"fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"credentialID"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/NewPasskey\/credentialID","abstract":[],"title":"credentialID"}}} \ No newline at end of file +{"topicSections":[{"title":"Instance Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/NewPasskey\/attachment","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/NewPasskey\/credentialID","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/NewPasskey\/rawAttestationObject","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/NewPasskey\/rawClientDataJSON"],"anchor":"Instance-Properties","generated":true}],"schemaVersion":{"major":0,"minor":3,"patch":0},"relationshipsSections":[{"title":"Inherited By","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SignupPasskey"],"type":"inheritedBy","kind":"relationships"},{"title":"Conforming Types","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationServices\/ASAuthorizationPlatformPublicKeyCredentialRegistration"],"type":"conformingTypes","kind":"relationships"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"NewPasskey","kind":"identifier"}],"languages":["swift"],"platforms":["iOS"]}]}],"sections":[],"abstract":[{"type":"text","text":"The signup passkey credential obtained from the "},{"type":"reference","isActive":true,"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate"},{"type":"text","text":" delegate."},{"type":"text","text":" "},{"type":"text","text":"Contains the subset of relevant properties from "},{"type":"reference","isActive":true,"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialregistration"},{"type":"text","text":"."}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/newpasskey"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/NewPasskey"},"metadata":{"role":"symbol","modules":[{"name":"Auth0"}],"title":"NewPasskey","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"NewPasskey","kind":"identifier"}],"externalID":"s:5Auth010NewPasskeyP","navigatorTitle":[{"text":"NewPasskey","kind":"identifier"}],"roleHeading":"Protocol","platforms":[{"deprecated":false,"unavailable":false,"introducedAt":"16.6","beta":false,"name":"iOS"},{"deprecated":false,"unavailable":false,"introducedAt":"16.6","beta":false,"name":"iPadOS"},{"deprecated":false,"unavailable":false,"introducedAt":"16.6","beta":false,"name":"Mac Catalyst"},{"deprecated":false,"unavailable":false,"introducedAt":"13.5","beta":false,"name":"macOS"},{"deprecated":false,"unavailable":false,"introducedAt":"1.0","beta":false,"name":"visionOS"}],"symbolKind":"protocol"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"references":{"https://developer.apple.com/documentation/authenticationservices/asauthorizationplatformpublickeycredentialregistration":{"title":"ASAuthorizationPlatformPublicKeyCredentialRegistration","type":"link","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialregistration","titleInlineContent":[{"type":"codeVoice","code":"ASAuthorizationPlatformPublicKeyCredentialRegistration"}],"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialregistration"},"doc://com.auth0.Auth0/documentation/Auth0/NewPasskey":{"title":"NewPasskey","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/NewPasskey","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"NewPasskey"}],"abstract":[{"type":"text","text":"The signup passkey credential obtained from the "},{"isActive":true,"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate"},{"type":"text","text":" delegate."},{"type":"text","text":" "},{"type":"text","text":"Contains the subset of relevant properties from "},{"isActive":true,"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialregistration"},{"type":"text","text":"."}],"url":"\/documentation\/auth0\/newpasskey","navigatorTitle":[{"kind":"identifier","text":"NewPasskey"}]},"doc://com.auth0.Auth0/documentation/Auth0/NewPasskey/rawClientDataJSON":{"role":"symbol","title":"rawClientDataJSON","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"rawClientDataJSON","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation4DataV","text":"Data","kind":"typeIdentifier"}],"abstract":[],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/NewPasskey\/rawClientDataJSON","url":"\/documentation\/auth0\/newpasskey\/rawclientdatajson","required":true,"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/SignupPasskey":{"title":"SignupPasskey","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SignupPasskey","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"SignupPasskey"}],"abstract":[{"text":"The signup passkey credential obtained from the ","type":"text"},{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","isActive":true,"type":"reference"},{"text":" delegate.","type":"text"},{"text":" ","type":"text"},{"text":"Contains the subset of relevant properties from ","type":"text"},{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialregistration","isActive":true,"type":"reference"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/signuppasskey","navigatorTitle":[{"kind":"identifier","text":"SignupPasskey"}]},"doc://com.auth0.Auth0/documentation/Auth0/NewPasskey/credentialID":{"role":"symbol","title":"credentialID","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"credentialID","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation4DataV","text":"Data","kind":"typeIdentifier"}],"abstract":[],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/NewPasskey\/credentialID","url":"\/documentation\/auth0\/newpasskey\/credentialid","required":true,"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/NewPasskey/rawAttestationObject":{"role":"symbol","title":"rawAttestationObject","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"rawAttestationObject","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation4DataV","text":"Data","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"abstract":[],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/NewPasskey\/rawAttestationObject","url":"\/documentation\/auth0\/newpasskey\/rawattestationobject","required":true,"type":"topic"},"https://developer.apple.com/documentation/authenticationservices/asauthorizationcontrollerdelegate":{"type":"link","titleInlineContent":[{"code":"ASAuthorizationControllerDelegate","type":"codeVoice"}],"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","title":"ASAuthorizationControllerDelegate","url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate"},"doc://com.auth0.Auth0/documentation/Auth0/NewPasskey/attachment":{"type":"topic","title":"attachment","url":"\/documentation\/auth0\/newpasskey\/attachment","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/NewPasskey\/attachment","abstract":[],"kind":"symbol","required":true,"role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"attachment","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"ASAuthorizationPublicKeyCredentialAttachment","preciseIdentifier":"c:@E@ASAuthorizationPublicKeyCredentialAttachment"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationServices/ASAuthorizationPlatformPublicKeyCredentialRegistration":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationServices\/ASAuthorizationPlatformPublicKeyCredentialRegistration","title":"ASAuthorizationPlatformPublicKeyCredentialRegistration"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/newpasskey/attachment.json b/docs/data/documentation/auth0/newpasskey/attachment.json index 97db3177e..0ef1951d5 100644 --- a/docs/data/documentation/auth0/newpasskey/attachment.json +++ b/docs/data/documentation/auth0/newpasskey/attachment.json @@ -1 +1 @@ -{"kind":"symbol","metadata":{"required":true,"role":"symbol","platforms":[{"introducedAt":"16.6","name":"iOS","beta":false,"unavailable":false,"deprecated":false},{"introducedAt":"16.6","name":"iPadOS","beta":false,"unavailable":false,"deprecated":false},{"introducedAt":"16.6","name":"Mac Catalyst","beta":false,"unavailable":false,"deprecated":false},{"introducedAt":"13.5","name":"macOS","beta":false,"unavailable":false,"deprecated":false},{"introducedAt":"1.0","name":"visionOS","beta":false,"unavailable":false,"deprecated":false}],"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"attachment","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:@E@ASAuthorizationPublicKeyCredentialAttachment","text":"ASAuthorizationPublicKeyCredentialAttachment","kind":"typeIdentifier"}],"externalID":"s:5Auth010NewPasskeyP10attachmentSo44ASAuthorizationPublicKeyCredentialAttachmentVvp","symbolKind":"property","roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"title":"attachment"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/NewPasskey"]]},"variants":[{"paths":["\/documentation\/auth0\/newpasskey\/attachment"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/NewPasskey\/attachment"},"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"attachment","kind":"identifier"},{"text":": ","kind":"text"},{"text":"ASAuthorizationPublicKeyCredentialAttachment","kind":"typeIdentifier","preciseIdentifier":"c:@E@ASAuthorizationPublicKeyCredentialAttachment"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"platforms":["iOS"]}],"kind":"declarations"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/NewPasskey/attachment":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/NewPasskey\/attachment","abstract":[],"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"attachment"},{"kind":"text","text":": "},{"preciseIdentifier":"c:@E@ASAuthorizationPublicKeyCredentialAttachment","kind":"typeIdentifier","text":"ASAuthorizationPublicKeyCredentialAttachment"}],"role":"symbol","url":"\/documentation\/auth0\/newpasskey\/attachment","required":true,"type":"topic","title":"attachment","kind":"symbol"},"https://developer.apple.com/documentation/authenticationservices/asauthorizationplatformpublickeycredentialregistration":{"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialregistration","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialregistration","titleInlineContent":[{"code":"ASAuthorizationPlatformPublicKeyCredentialRegistration","type":"codeVoice"}],"type":"link","title":"ASAuthorizationPlatformPublicKeyCredentialRegistration"},"https://developer.apple.com/documentation/authenticationservices/asauthorizationcontrollerdelegate":{"type":"link","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","titleInlineContent":[{"type":"codeVoice","code":"ASAuthorizationControllerDelegate"}],"title":"ASAuthorizationControllerDelegate","url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate"},"doc://com.auth0.Auth0/documentation/Auth0/NewPasskey":{"role":"symbol","title":"NewPasskey","abstract":[{"text":"The signup passkey credential obtained from the ","type":"text"},{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","isActive":true,"type":"reference"},{"text":" delegate.","type":"text"},{"text":" ","type":"text"},{"text":"Contains the subset of relevant properties from ","type":"text"},{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialregistration","isActive":true,"type":"reference"},{"text":".","type":"text"}],"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/newpasskey","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/NewPasskey","navigatorTitle":[{"text":"NewPasskey","kind":"identifier"}],"fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"NewPasskey","kind":"identifier"}]}}} \ No newline at end of file +{"metadata":{"modules":[{"name":"Auth0"}],"title":"attachment","roleHeading":"Instance Property","symbolKind":"property","role":"symbol","platforms":[{"unavailable":false,"beta":false,"name":"iOS","introducedAt":"16.6","deprecated":false},{"unavailable":false,"beta":false,"name":"iPadOS","introducedAt":"16.6","deprecated":false},{"introducedAt":"16.6","unavailable":false,"deprecated":false,"name":"Mac Catalyst","beta":false},{"introducedAt":"13.5","unavailable":false,"deprecated":false,"name":"macOS","beta":false},{"introducedAt":"1.0","unavailable":false,"deprecated":false,"name":"visionOS","beta":false}],"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"attachment"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"ASAuthorizationPublicKeyCredentialAttachment","preciseIdentifier":"c:@E@ASAuthorizationPublicKeyCredentialAttachment"}],"required":true,"externalID":"s:5Auth010NewPasskeyP10attachmentSo44ASAuthorizationPublicKeyCredentialAttachmentVvp"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/newpasskey\/attachment"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/NewPasskey\/attachment"},"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"attachment","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:@E@ASAuthorizationPublicKeyCredentialAttachment","text":"ASAuthorizationPublicKeyCredentialAttachment","kind":"typeIdentifier"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}]}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/NewPasskey"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"https://developer.apple.com/documentation/authenticationservices/asauthorizationcontrollerdelegate":{"type":"link","titleInlineContent":[{"type":"codeVoice","code":"ASAuthorizationControllerDelegate"}],"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","title":"ASAuthorizationControllerDelegate","url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"https://developer.apple.com/documentation/authenticationservices/asauthorizationplatformpublickeycredentialregistration":{"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialregistration","title":"ASAuthorizationPlatformPublicKeyCredentialRegistration","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialregistration","titleInlineContent":[{"code":"ASAuthorizationPlatformPublicKeyCredentialRegistration","type":"codeVoice"}],"type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/NewPasskey/attachment":{"type":"topic","title":"attachment","url":"\/documentation\/auth0\/newpasskey\/attachment","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/NewPasskey\/attachment","abstract":[],"kind":"symbol","required":true,"role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"attachment","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"ASAuthorizationPublicKeyCredentialAttachment","preciseIdentifier":"c:@E@ASAuthorizationPublicKeyCredentialAttachment"}]},"doc://com.auth0.Auth0/documentation/Auth0/NewPasskey":{"title":"NewPasskey","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/NewPasskey","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"NewPasskey"}],"abstract":[{"type":"text","text":"The signup passkey credential obtained from the "},{"isActive":true,"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate"},{"type":"text","text":" delegate."},{"type":"text","text":" "},{"type":"text","text":"Contains the subset of relevant properties from "},{"isActive":true,"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialregistration"},{"type":"text","text":"."}],"url":"\/documentation\/auth0\/newpasskey","navigatorTitle":[{"kind":"identifier","text":"NewPasskey"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/newpasskey/credentialid.json b/docs/data/documentation/auth0/newpasskey/credentialid.json index 923f9f2ec..38368ffbd 100644 --- a/docs/data/documentation/auth0/newpasskey/credentialid.json +++ b/docs/data/documentation/auth0/newpasskey/credentialid.json @@ -1 +1 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/NewPasskey\/credentialID","interfaceLanguage":"swift"},"metadata":{"platforms":[{"introducedAt":"16.6","beta":false,"deprecated":false,"name":"iOS","unavailable":false},{"introducedAt":"16.6","beta":false,"deprecated":false,"name":"iPadOS","unavailable":false},{"unavailable":false,"beta":false,"deprecated":false,"name":"Mac Catalyst","introducedAt":"16.6"},{"unavailable":false,"beta":false,"deprecated":false,"name":"macOS","introducedAt":"13.5"},{"unavailable":false,"beta":false,"deprecated":false,"name":"visionOS","introducedAt":"1.0"}],"required":true,"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"credentialID"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"}],"title":"credentialID","roleHeading":"Instance Property","symbolKind":"property","externalID":"s:5Auth010NewPasskeyP12credentialID10Foundation4DataVvp","modules":[{"name":"Auth0"}],"role":"symbol"},"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"credentialID"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV","text":"Data"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"platforms":["iOS"]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/newpasskey\/credentialid"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/NewPasskey"]]},"schemaVersion":{"minor":3,"patch":0,"major":0},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/NewPasskey":{"role":"symbol","title":"NewPasskey","abstract":[{"text":"The signup passkey credential obtained from the ","type":"text"},{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","isActive":true,"type":"reference"},{"text":" delegate.","type":"text"},{"text":" ","type":"text"},{"text":"Contains the subset of relevant properties from ","type":"text"},{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialregistration","isActive":true,"type":"reference"},{"text":".","type":"text"}],"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/newpasskey","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/NewPasskey","navigatorTitle":[{"text":"NewPasskey","kind":"identifier"}],"fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"NewPasskey","kind":"identifier"}]},"https://developer.apple.com/documentation/authenticationservices/asauthorizationcontrollerdelegate":{"titleInlineContent":[{"type":"codeVoice","code":"ASAuthorizationControllerDelegate"}],"type":"link","url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","title":"ASAuthorizationControllerDelegate"},"doc://com.auth0.Auth0/documentation/Auth0/NewPasskey/credentialID":{"url":"\/documentation\/auth0\/newpasskey\/credentialid","type":"topic","kind":"symbol","role":"symbol","required":true,"fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"credentialID"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/NewPasskey\/credentialID","abstract":[],"title":"credentialID"},"https://developer.apple.com/documentation/authenticationservices/asauthorizationplatformpublickeycredentialregistration":{"type":"link","title":"ASAuthorizationPlatformPublicKeyCredentialRegistration","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialregistration","titleInlineContent":[{"code":"ASAuthorizationPlatformPublicKeyCredentialRegistration","type":"codeVoice"}],"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialregistration"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"credentialID","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Data","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}]}]}],"sections":[],"variants":[{"paths":["\/documentation\/auth0\/newpasskey\/credentialid"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","metadata":{"role":"symbol","modules":[{"name":"Auth0"}],"title":"credentialID","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"credentialID","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation4DataV","text":"Data","kind":"typeIdentifier"}],"externalID":"s:5Auth010NewPasskeyP12credentialID10Foundation4DataVvp","roleHeading":"Instance Property","required":true,"platforms":[{"deprecated":false,"introducedAt":"16.6","unavailable":false,"name":"iOS","beta":false},{"deprecated":false,"introducedAt":"16.6","unavailable":false,"name":"iPadOS","beta":false},{"deprecated":false,"introducedAt":"16.6","unavailable":false,"name":"Mac Catalyst","beta":false},{"deprecated":false,"introducedAt":"13.5","unavailable":false,"name":"macOS","beta":false},{"deprecated":false,"introducedAt":"1.0","unavailable":false,"name":"visionOS","beta":false}],"symbolKind":"property"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/NewPasskey\/credentialID"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/NewPasskey"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"https://developer.apple.com/documentation/authenticationservices/asauthorizationcontrollerdelegate":{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","titleInlineContent":[{"type":"codeVoice","code":"ASAuthorizationControllerDelegate"}],"type":"link","title":"ASAuthorizationControllerDelegate"},"doc://com.auth0.Auth0/documentation/Auth0/NewPasskey/credentialID":{"role":"symbol","title":"credentialID","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"credentialID","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation4DataV","text":"Data","kind":"typeIdentifier"}],"abstract":[],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/NewPasskey\/credentialID","url":"\/documentation\/auth0\/newpasskey\/credentialid","required":true,"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/NewPasskey":{"title":"NewPasskey","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/NewPasskey","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"NewPasskey"}],"abstract":[{"type":"text","text":"The signup passkey credential obtained from the "},{"isActive":true,"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate"},{"type":"text","text":" delegate."},{"type":"text","text":" "},{"type":"text","text":"Contains the subset of relevant properties from "},{"isActive":true,"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialregistration"},{"type":"text","text":"."}],"url":"\/documentation\/auth0\/newpasskey","navigatorTitle":[{"kind":"identifier","text":"NewPasskey"}]},"https://developer.apple.com/documentation/authenticationservices/asauthorizationplatformpublickeycredentialregistration":{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialregistration","url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialregistration","titleInlineContent":[{"type":"codeVoice","code":"ASAuthorizationPlatformPublicKeyCredentialRegistration"}],"type":"link","title":"ASAuthorizationPlatformPublicKeyCredentialRegistration"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/newpasskey/rawattestationobject.json b/docs/data/documentation/auth0/newpasskey/rawattestationobject.json index ab7562b6f..a9ad78a04 100644 --- a/docs/data/documentation/auth0/newpasskey/rawattestationobject.json +++ b/docs/data/documentation/auth0/newpasskey/rawattestationobject.json @@ -1 +1 @@ -{"sections":[],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"rawAttestationObject"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV","text":"Data"},{"kind":"text","text":"? { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}]}],"kind":"declarations"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/NewPasskey"]]},"variants":[{"paths":["\/documentation\/auth0\/newpasskey\/rawattestationobject"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/NewPasskey\/rawAttestationObject","interfaceLanguage":"swift"},"metadata":{"title":"rawAttestationObject","modules":[{"name":"Auth0"}],"platforms":[{"name":"iOS","beta":false,"deprecated":false,"introducedAt":"16.6","unavailable":false},{"name":"iPadOS","beta":false,"deprecated":false,"introducedAt":"16.6","unavailable":false},{"name":"Mac Catalyst","beta":false,"deprecated":false,"introducedAt":"16.6","unavailable":false},{"name":"macOS","beta":false,"deprecated":false,"introducedAt":"13.5","unavailable":false},{"name":"visionOS","beta":false,"deprecated":false,"introducedAt":"1.0","unavailable":false}],"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"rawAttestationObject","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation4DataV","text":"Data","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"externalID":"s:5Auth010NewPasskeyP20rawAttestationObject10Foundation4DataVSgvp","roleHeading":"Instance Property","symbolKind":"property","role":"symbol","required":true},"schemaVersion":{"major":0,"patch":0,"minor":3},"references":{"https://developer.apple.com/documentation/authenticationservices/asauthorizationplatformpublickeycredentialregistration":{"titleInlineContent":[{"type":"codeVoice","code":"ASAuthorizationPlatformPublicKeyCredentialRegistration"}],"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialregistration","type":"link","title":"ASAuthorizationPlatformPublicKeyCredentialRegistration","url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialregistration"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/NewPasskey/rawAttestationObject":{"abstract":[],"kind":"symbol","role":"symbol","required":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/NewPasskey\/rawAttestationObject","url":"\/documentation\/auth0\/newpasskey\/rawattestationobject","title":"rawAttestationObject","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"rawAttestationObject"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV","text":"Data"},{"kind":"text","text":"?"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/NewPasskey":{"role":"symbol","title":"NewPasskey","abstract":[{"text":"The signup passkey credential obtained from the ","type":"text"},{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","isActive":true,"type":"reference"},{"text":" delegate.","type":"text"},{"text":" ","type":"text"},{"text":"Contains the subset of relevant properties from ","type":"text"},{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialregistration","isActive":true,"type":"reference"},{"text":".","type":"text"}],"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/newpasskey","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/NewPasskey","navigatorTitle":[{"text":"NewPasskey","kind":"identifier"}],"fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"NewPasskey","kind":"identifier"}]},"https://developer.apple.com/documentation/authenticationservices/asauthorizationcontrollerdelegate":{"titleInlineContent":[{"type":"codeVoice","code":"ASAuthorizationControllerDelegate"}],"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","type":"link","title":"ASAuthorizationControllerDelegate","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/NewPasskey"]]},"metadata":{"role":"symbol","modules":[{"name":"Auth0"}],"title":"rawAttestationObject","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"rawAttestationObject","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"?"}],"externalID":"s:5Auth010NewPasskeyP20rawAttestationObject10Foundation4DataVSgvp","roleHeading":"Instance Property","required":true,"platforms":[{"name":"iOS","deprecated":false,"beta":false,"unavailable":false,"introducedAt":"16.6"},{"name":"iPadOS","beta":false,"deprecated":false,"unavailable":false,"introducedAt":"16.6"},{"name":"Mac Catalyst","deprecated":false,"beta":false,"unavailable":false,"introducedAt":"16.6"},{"name":"macOS","beta":false,"deprecated":false,"unavailable":false,"introducedAt":"13.5"},{"name":"visionOS","beta":false,"deprecated":false,"unavailable":false,"introducedAt":"1.0"}],"symbolKind":"property"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/newpasskey\/rawattestationobject"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/NewPasskey\/rawAttestationObject","interfaceLanguage":"swift"},"kind":"symbol","schemaVersion":{"minor":3,"major":0,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"rawAttestationObject","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation4DataV","text":"Data","kind":"typeIdentifier"},{"text":"? { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/NewPasskey":{"title":"NewPasskey","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/NewPasskey","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"NewPasskey"}],"abstract":[{"type":"text","text":"The signup passkey credential obtained from the "},{"isActive":true,"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate"},{"type":"text","text":" delegate."},{"type":"text","text":" "},{"type":"text","text":"Contains the subset of relevant properties from "},{"isActive":true,"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialregistration"},{"type":"text","text":"."}],"url":"\/documentation\/auth0\/newpasskey","navigatorTitle":[{"kind":"identifier","text":"NewPasskey"}]},"https://developer.apple.com/documentation/authenticationservices/asauthorizationplatformpublickeycredentialregistration":{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialregistration","titleInlineContent":[{"code":"ASAuthorizationPlatformPublicKeyCredentialRegistration","type":"codeVoice"}],"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialregistration","title":"ASAuthorizationPlatformPublicKeyCredentialRegistration","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/NewPasskey/rawAttestationObject":{"role":"symbol","title":"rawAttestationObject","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"rawAttestationObject","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation4DataV","text":"Data","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"abstract":[],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/NewPasskey\/rawAttestationObject","url":"\/documentation\/auth0\/newpasskey\/rawattestationobject","required":true,"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"https://developer.apple.com/documentation/authenticationservices/asauthorizationcontrollerdelegate":{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","titleInlineContent":[{"code":"ASAuthorizationControllerDelegate","type":"codeVoice"}],"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","title":"ASAuthorizationControllerDelegate","type":"link"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/newpasskey/rawclientdatajson.json b/docs/data/documentation/auth0/newpasskey/rawclientdatajson.json index 1bacc8639..5aa014496 100644 --- a/docs/data/documentation/auth0/newpasskey/rawclientdatajson.json +++ b/docs/data/documentation/auth0/newpasskey/rawclientdatajson.json @@ -1 +1 @@ -{"variants":[{"paths":["\/documentation\/auth0\/newpasskey\/rawclientdatajson"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/NewPasskey"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/NewPasskey\/rawClientDataJSON"},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"rawClientDataJSON","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Data","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"platforms":["iOS"]}]}],"metadata":{"required":true,"externalID":"s:5Auth010NewPasskeyP17rawClientDataJSON10Foundation0F0Vvp","symbolKind":"property","platforms":[{"unavailable":false,"beta":false,"name":"iOS","introducedAt":"16.6","deprecated":false},{"unavailable":false,"beta":false,"name":"iPadOS","introducedAt":"16.6","deprecated":false},{"unavailable":false,"beta":false,"name":"Mac Catalyst","introducedAt":"16.6","deprecated":false},{"unavailable":false,"beta":false,"name":"macOS","introducedAt":"13.5","deprecated":false},{"unavailable":false,"beta":false,"name":"visionOS","introducedAt":"1.0","deprecated":false}],"title":"rawClientDataJSON","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"rawClientDataJSON","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Data","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV"}],"modules":[{"name":"Auth0"}],"roleHeading":"Instance Property"},"kind":"symbol","schemaVersion":{"patch":0,"major":0,"minor":3},"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/NewPasskey/rawClientDataJSON":{"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"rawClientDataJSON"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV","text":"Data"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/NewPasskey\/rawClientDataJSON","abstract":[],"title":"rawClientDataJSON","type":"topic","url":"\/documentation\/auth0\/newpasskey\/rawclientdatajson","required":true},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"https://developer.apple.com/documentation/authenticationservices/asauthorizationcontrollerdelegate":{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","titleInlineContent":[{"code":"ASAuthorizationControllerDelegate","type":"codeVoice"}],"title":"ASAuthorizationControllerDelegate","type":"link","url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate"},"https://developer.apple.com/documentation/authenticationservices/asauthorizationplatformpublickeycredentialregistration":{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialregistration","titleInlineContent":[{"type":"codeVoice","code":"ASAuthorizationPlatformPublicKeyCredentialRegistration"}],"title":"ASAuthorizationPlatformPublicKeyCredentialRegistration","type":"link","url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialregistration"},"doc://com.auth0.Auth0/documentation/Auth0/NewPasskey":{"role":"symbol","title":"NewPasskey","abstract":[{"text":"The signup passkey credential obtained from the ","type":"text"},{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","isActive":true,"type":"reference"},{"text":" delegate.","type":"text"},{"text":" ","type":"text"},{"text":"Contains the subset of relevant properties from ","type":"text"},{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialregistration","isActive":true,"type":"reference"},{"text":".","type":"text"}],"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/newpasskey","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/NewPasskey","navigatorTitle":[{"text":"NewPasskey","kind":"identifier"}],"fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"NewPasskey","kind":"identifier"}]}}} \ No newline at end of file +{"sections":[],"kind":"symbol","metadata":{"modules":[{"name":"Auth0"}],"externalID":"s:5Auth010NewPasskeyP17rawClientDataJSON10Foundation0F0Vvp","title":"rawClientDataJSON","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"rawClientDataJSON"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV","text":"Data"}],"roleHeading":"Instance Property","role":"symbol","required":true,"symbolKind":"property","platforms":[{"name":"iOS","unavailable":false,"deprecated":false,"introducedAt":"16.6","beta":false},{"name":"iPadOS","unavailable":false,"deprecated":false,"introducedAt":"16.6","beta":false},{"name":"Mac Catalyst","unavailable":false,"deprecated":false,"introducedAt":"16.6","beta":false},{"name":"macOS","unavailable":false,"deprecated":false,"introducedAt":"13.5","beta":false},{"name":"visionOS","unavailable":false,"deprecated":false,"introducedAt":"1.0","beta":false}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/NewPasskey\/rawClientDataJSON","interfaceLanguage":"swift"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/newpasskey\/rawclientdatajson"]}],"schemaVersion":{"patch":0,"minor":3,"major":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/NewPasskey"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"rawClientDataJSON","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation4DataV","text":"Data","kind":"typeIdentifier"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]}],"references":{"https://developer.apple.com/documentation/authenticationservices/asauthorizationcontrollerdelegate":{"titleInlineContent":[{"code":"ASAuthorizationControllerDelegate","type":"codeVoice"}],"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","type":"link","title":"ASAuthorizationControllerDelegate","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/NewPasskey/rawClientDataJSON":{"role":"symbol","title":"rawClientDataJSON","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"rawClientDataJSON","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation4DataV","text":"Data","kind":"typeIdentifier"}],"abstract":[],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/NewPasskey\/rawClientDataJSON","url":"\/documentation\/auth0\/newpasskey\/rawclientdatajson","required":true,"type":"topic"},"https://developer.apple.com/documentation/authenticationservices/asauthorizationplatformpublickeycredentialregistration":{"titleInlineContent":[{"code":"ASAuthorizationPlatformPublicKeyCredentialRegistration","type":"codeVoice"}],"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialregistration","type":"link","title":"ASAuthorizationPlatformPublicKeyCredentialRegistration","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialregistration"},"doc://com.auth0.Auth0/documentation/Auth0/NewPasskey":{"title":"NewPasskey","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/NewPasskey","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"NewPasskey"}],"abstract":[{"type":"text","text":"The signup passkey credential obtained from the "},{"isActive":true,"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate"},{"type":"text","text":" delegate."},{"type":"text","text":" "},{"type":"text","text":"Contains the subset of relevant properties from "},{"isActive":true,"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialregistration"},{"type":"text","text":"."}],"url":"\/documentation\/auth0\/newpasskey","navigatorTitle":[{"kind":"identifier","text":"NewPasskey"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/passkeyauthenticationmethod.json b/docs/data/documentation/auth0/passkeyauthenticationmethod.json index b9b8394dd..d608ed785 100644 --- a/docs/data/documentation/auth0/passkeyauthenticationmethod.json +++ b/docs/data/documentation/auth0/passkeyauthenticationmethod.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"topicSections":[{"anchor":"Instance-Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/createdAt","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/credential","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/id","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/type","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/userAgent","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/userIdentityId"],"title":"Instance Properties","generated":true},{"anchor":"Default-Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/Decodable-Implementations","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/Equatable-Implementations"],"title":"Default Implementations","generated":true}],"relationshipsSections":[{"type":"conformsTo","identifiers":["doc:\/\/com.auth0.Auth0\/s8CopyableP","doc:\/\/com.auth0.Auth0\/Se","doc:\/\/com.auth0.Auth0\/SQ","doc:\/\/com.auth0.Auth0\/s12IdentifiableP","doc:\/\/com.auth0.Auth0\/s8SendableP","doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP"],"kind":"relationships","title":"Conforms To"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyAuthenticationMethod","kind":"identifier"}],"languages":["swift"]}]}],"variants":[{"paths":["\/documentation\/auth0\/passkeyauthenticationmethod"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"abstract":[{"type":"text","text":"A passkey authentication method."}],"metadata":{"modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasskeyAuthenticationMethod"}],"role":"symbol","externalID":"s:5Auth027PasskeyAuthenticationMethodV","navigatorTitle":[{"kind":"identifier","text":"PasskeyAuthenticationMethod"}],"roleHeading":"Structure","symbolKind":"struct","title":"PasskeyAuthenticationMethod"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod","interfaceLanguage":"swift"},"kind":"symbol","references":{"doc://com.auth0.Auth0/Se":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/Se","title":"Swift.Decodable"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/s8SendableP":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s8SendableP","title":"Swift.Sendable"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyAuthenticationMethod/userAgent":{"role":"symbol","kind":"symbol","abstract":[{"text":"The user agent of the browser o device used to enroll the passkey.","type":"text"}],"url":"\/documentation\/auth0\/passkeyauthenticationmethod\/useragent","type":"topic","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"userAgent"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/userAgent","title":"userAgent"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyAuthenticationMethod/id":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/id","kind":"symbol","abstract":[{"type":"text","text":"Unique identifier of the authentication method."}],"url":"\/documentation\/auth0\/passkeyauthenticationmethod\/id","role":"symbol","title":"id","type":"topic","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"id"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}]},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyAuthenticationMethod/userIdentityId":{"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"userIdentityId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/userIdentityId","url":"\/documentation\/auth0\/passkeyauthenticationmethod\/useridentityid","kind":"symbol","role":"symbol","title":"userIdentityId","abstract":[{"type":"text","text":"Unique identifier of the user identity linked with the authentication method."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyAuthenticationMethod/Decodable-Implementations":{"type":"topic","role":"collectionGroup","title":"Decodable Implementations","abstract":[],"url":"\/documentation\/auth0\/passkeyauthenticationmethod\/decodable-implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/Decodable-Implementations","kind":"article"},"doc://com.auth0.Auth0/s12IdentifiableP":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s12IdentifiableP","title":"Swift.Identifiable"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyAuthenticationMethod/type":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/type","role":"symbol","url":"\/documentation\/auth0\/passkeyauthenticationmethod\/type","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"type","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"title":"type","type":"topic","abstract":[{"type":"text","text":"Type of the authentication method. Equals to "},{"type":"codeVoice","code":"passkey"},{"type":"text","text":"."}]},"doc://com.auth0.Auth0/s8CopyableP":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s8CopyableP","title":"Swift.Copyable"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyAuthenticationMethod":{"role":"symbol","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod","type":"topic","navigatorTitle":[{"text":"PasskeyAuthenticationMethod","kind":"identifier"}],"title":"PasskeyAuthenticationMethod","url":"\/documentation\/auth0\/passkeyauthenticationmethod","abstract":[{"text":"A passkey authentication method.","type":"text"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyAuthenticationMethod","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyAuthenticationMethod/createdAt":{"kind":"symbol","role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/createdAt","abstract":[{"type":"text","text":"Creation date of the authentication method."}],"url":"\/documentation\/auth0\/passkeyauthenticationmethod\/createdat","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"createdAt"},{"kind":"text","text":": "},{"preciseIdentifier":"s:10Foundation4DateV","kind":"typeIdentifier","text":"Date"}],"title":"createdAt"},"doc://com.auth0.Auth0/s16SendableMetatypeP":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP","title":"Swift.SendableMetatype"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyAuthenticationMethod/Equatable-Implementations":{"title":"Equatable Implementations","kind":"article","url":"\/documentation\/auth0\/passkeyauthenticationmethod\/equatable-implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/Equatable-Implementations","role":"collectionGroup","abstract":[],"type":"topic"},"doc://com.auth0.Auth0/SQ":{"type":"unresolvable","title":"Swift.Equatable","identifier":"doc:\/\/com.auth0.Auth0\/SQ"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyAuthenticationMethod/credential":{"title":"credential","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/credential","abstract":[{"text":"Details of the passkey credential.","type":"text"}],"kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"credential"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"PasskeyCredential","preciseIdentifier":"s:5Auth017PasskeyCredentialV"}],"url":"\/documentation\/auth0\/passkeyauthenticationmethod\/credential","type":"topic"}}} \ No newline at end of file +{"metadata":{"symbolKind":"struct","title":"PasskeyAuthenticationMethod","externalID":"s:5Auth027PasskeyAuthenticationMethodV","roleHeading":"Structure","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasskeyAuthenticationMethod"}],"role":"symbol","navigatorTitle":[{"text":"PasskeyAuthenticationMethod","kind":"identifier"}]},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passkeyauthenticationmethod"]}],"relationshipsSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/s8CopyableP","doc:\/\/com.auth0.Auth0\/Se","doc:\/\/com.auth0.Auth0\/SQ","doc:\/\/com.auth0.Auth0\/s12IdentifiableP","doc:\/\/com.auth0.Auth0\/s8SendableP","doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP"],"title":"Conforms To","kind":"relationships","type":"conformsTo"}],"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/aaguid","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/createdAt","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/credential","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/id","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/relyingPartyIdentifier","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/type","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/userAgent","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/userIdentityId"],"title":"Instance Properties","generated":true,"anchor":"Instance-Properties"},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/Decodable-Implementations","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/Equatable-Implementations"],"generated":true,"title":"Default Implementations","anchor":"Default-Implementations"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"type":"text","text":"A passkey authentication method."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"PasskeyAuthenticationMethod","kind":"identifier"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"schemaVersion":{"minor":3,"major":0,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasskeyAuthenticationMethod/relyingPartyIdentifier":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/relyingPartyIdentifier","kind":"symbol","title":"relyingPartyIdentifier","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"relyingPartyIdentifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"role":"symbol","url":"\/documentation\/auth0\/passkeyauthenticationmethod\/relyingpartyidentifier","abstract":[{"text":"Relying party Id for the domain","type":"text"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyAuthenticationMethod/id":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/id","title":"id","type":"topic","role":"symbol","kind":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"id","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"abstract":[{"text":"Unique identifier of the authentication method.","type":"text"}],"url":"\/documentation\/auth0\/passkeyauthenticationmethod\/id"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyAuthenticationMethod/userAgent":{"url":"\/documentation\/auth0\/passkeyauthenticationmethod\/useragent","title":"userAgent","abstract":[{"text":"The user agent of the browser o device used to enroll the passkey.","type":"text"}],"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"userAgent","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/userAgent","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyAuthenticationMethod/credential":{"title":"credential","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/credential","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"credential"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"PasskeyCredential","preciseIdentifier":"s:5Auth017PasskeyCredentialV"}],"abstract":[{"type":"text","text":"Details of the passkey credential."}],"url":"\/documentation\/auth0\/passkeyauthenticationmethod\/credential"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyAuthenticationMethod/userIdentityId":{"title":"userIdentityId","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/userIdentityId","type":"topic","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"userIdentityId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"abstract":[{"type":"text","text":"Unique identifier of the user identity linked with the authentication method."}],"url":"\/documentation\/auth0\/passkeyauthenticationmethod\/useridentityid"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyAuthenticationMethod":{"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyAuthenticationMethod","kind":"identifier"}],"navigatorTitle":[{"text":"PasskeyAuthenticationMethod","kind":"identifier"}],"title":"PasskeyAuthenticationMethod","type":"topic","role":"symbol","abstract":[{"type":"text","text":"A passkey authentication method."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod","url":"\/documentation\/auth0\/passkeyauthenticationmethod"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyAuthenticationMethod/Decodable-Implementations":{"title":"Decodable Implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/Decodable-Implementations","type":"topic","role":"collectionGroup","kind":"article","abstract":[],"url":"\/documentation\/auth0\/passkeyauthenticationmethod\/decodable-implementations"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyAuthenticationMethod/type":{"title":"type","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/type","type":"topic","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"type"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"abstract":[{"type":"text","text":"Type of the authentication method. Equals to "},{"type":"codeVoice","code":"passkey"},{"type":"text","text":"."}],"url":"\/documentation\/auth0\/passkeyauthenticationmethod\/type"},"doc://com.auth0.Auth0/SQ":{"title":"Swift.Equatable","identifier":"doc:\/\/com.auth0.Auth0\/SQ","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyAuthenticationMethod/createdAt":{"title":"createdAt","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/createdAt","type":"topic","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"createdAt"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"}],"abstract":[{"type":"text","text":"Creation date of the authentication method."}],"url":"\/documentation\/auth0\/passkeyauthenticationmethod\/createdat"},"doc://com.auth0.Auth0/s8SendableP":{"title":"Swift.Sendable","identifier":"doc:\/\/com.auth0.Auth0\/s8SendableP","type":"unresolvable"},"doc://com.auth0.Auth0/s16SendableMetatypeP":{"title":"Swift.SendableMetatype","identifier":"doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyAuthenticationMethod/aaguid":{"kind":"symbol","abstract":[{"type":"text","text":"Authenticator Attestation GUID for the passkey provider"}],"type":"topic","url":"\/documentation\/auth0\/passkeyauthenticationmethod\/aaguid","title":"aaguid","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"aaguid"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/aaguid"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyAuthenticationMethod/Equatable-Implementations":{"title":"Equatable Implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/Equatable-Implementations","type":"topic","role":"collectionGroup","kind":"article","abstract":[],"url":"\/documentation\/auth0\/passkeyauthenticationmethod\/equatable-implementations"},"doc://com.auth0.Auth0/s12IdentifiableP":{"title":"Swift.Identifiable","identifier":"doc:\/\/com.auth0.Auth0\/s12IdentifiableP","type":"unresolvable"},"doc://com.auth0.Auth0/s8CopyableP":{"title":"Swift.Copyable","identifier":"doc:\/\/com.auth0.Auth0\/s8CopyableP","type":"unresolvable"},"doc://com.auth0.Auth0/Se":{"title":"Swift.Decodable","identifier":"doc:\/\/com.auth0.Auth0\/Se","type":"unresolvable"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/passkeyauthenticationmethod/!=(_:_:).json b/docs/data/documentation/auth0/passkeyauthenticationmethod/!=(_:_:).json index 220781f4a..a2b1c626e 100644 --- a/docs/data/documentation/auth0/passkeyauthenticationmethod/!=(_:_:).json +++ b/docs/data/documentation/auth0/passkeyauthenticationmethod/!=(_:_:).json @@ -1 +1 @@ -{"variants":[{"paths":["\/documentation\/auth0\/passkeyauthenticationmethod\/!=(_:_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"!="},{"kind":"text","text":" "},{"kind":"text","text":"("},{"kind":"internalParam","text":"lhs"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":", "},{"kind":"internalParam","text":"rhs"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"metadata":{"role":"symbol","symbolKind":"op","modules":[{"name":"Auth0","relatedModules":["Swift"]}],"title":"!=(_:_:)","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","text":"Self"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"externalID":"s:SQsE2neoiySbx_xtFZ::SYNTHESIZED::s:5Auth027PasskeyAuthenticationMethodV","extendedModule":"Swift","roleHeading":"Operator"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/!=(_:_:)"},"abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"Equatable.!=(_:_:)"},{"type":"text","text":"."}],"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod"]]},"kind":"symbol","schemaVersion":{"minor":3,"patch":0,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyAuthenticationMethod/!=(_:_:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/!=(_:_:)","abstract":[],"kind":"symbol","role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"url":"\/documentation\/auth0\/passkeyauthenticationmethod\/!=(_:_:)","type":"topic","title":"!=(_:_:)"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyAuthenticationMethod":{"role":"symbol","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod","type":"topic","navigatorTitle":[{"text":"PasskeyAuthenticationMethod","kind":"identifier"}],"title":"PasskeyAuthenticationMethod","url":"\/documentation\/auth0\/passkeyauthenticationmethod","abstract":[{"text":"A passkey authentication method.","type":"text"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyAuthenticationMethod","kind":"identifier"}]}}} \ No newline at end of file +{"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"!="},{"kind":"text","text":" "},{"kind":"text","text":"("},{"kind":"internalParam","text":"lhs"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":", "},{"kind":"internalParam","text":"rhs"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"platforms":["iOS"]}]}],"sections":[],"abstract":[{"text":"Inherited from ","type":"text"},{"code":"Equatable.!=(_:_:)","type":"codeVoice"},{"text":".","type":"text"}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passkeyauthenticationmethod\/!=(_:_:)"]}],"metadata":{"role":"symbol","modules":[{"name":"Auth0","relatedModules":["Swift"]}],"title":"!=(_:_:)","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"externalID":"s:SQsE2neoiySbx_xtFZ::SYNTHESIZED::s:5Auth027PasskeyAuthenticationMethodV","extendedModule":"Swift","roleHeading":"Operator","symbolKind":"op"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/!=(_:_:)"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasskeyAuthenticationMethod/!=(_:_:)":{"kind":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","text":"Self"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"Self"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"title":"!=(_:_:)","type":"topic","role":"symbol","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/!=(_:_:)","url":"\/documentation\/auth0\/passkeyauthenticationmethod\/!=(_:_:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyAuthenticationMethod":{"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyAuthenticationMethod","kind":"identifier"}],"navigatorTitle":[{"text":"PasskeyAuthenticationMethod","kind":"identifier"}],"title":"PasskeyAuthenticationMethod","type":"topic","role":"symbol","abstract":[{"type":"text","text":"A passkey authentication method."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod","url":"\/documentation\/auth0\/passkeyauthenticationmethod"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/passkeyauthenticationmethod/aaguid.json b/docs/data/documentation/auth0/passkeyauthenticationmethod/aaguid.json new file mode 100644 index 000000000..88e1a8c49 --- /dev/null +++ b/docs/data/documentation/auth0/passkeyauthenticationmethod/aaguid.json @@ -0,0 +1 @@ +{"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passkeyauthenticationmethod\/aaguid"]}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod"]]},"abstract":[{"type":"text","text":"Authenticator Attestation GUID for the passkey provider"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"roleHeading":"Instance Property","title":"aaguid","modules":[{"name":"Auth0"}],"symbolKind":"property","externalID":"s:5Auth027PasskeyAuthenticationMethodV6aaguidSSvp","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"aaguid","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}]},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"aaguid","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}]}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/aaguid","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyAuthenticationMethod/aaguid":{"kind":"symbol","abstract":[{"type":"text","text":"Authenticator Attestation GUID for the passkey provider"}],"type":"topic","url":"\/documentation\/auth0\/passkeyauthenticationmethod\/aaguid","title":"aaguid","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"aaguid"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/aaguid"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyAuthenticationMethod":{"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyAuthenticationMethod","kind":"identifier"}],"navigatorTitle":[{"text":"PasskeyAuthenticationMethod","kind":"identifier"}],"title":"PasskeyAuthenticationMethod","type":"topic","role":"symbol","abstract":[{"type":"text","text":"A passkey authentication method."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod","url":"\/documentation\/auth0\/passkeyauthenticationmethod"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/passkeyauthenticationmethod/createdat.json b/docs/data/documentation/auth0/passkeyauthenticationmethod/createdat.json index 527bc69f0..0ef3c6958 100644 --- a/docs/data/documentation/auth0/passkeyauthenticationmethod/createdat.json +++ b/docs/data/documentation/auth0/passkeyauthenticationmethod/createdat.json @@ -1 +1 @@ -{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/createdAt"},"metadata":{"role":"symbol","title":"createdAt","roleHeading":"Instance Property","externalID":"s:5Auth027PasskeyAuthenticationMethodV9createdAt10Foundation4DateVvp","modules":[{"name":"Auth0"}],"symbolKind":"property","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"createdAt","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Date","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DateV"}]},"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"createdAt","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Date","preciseIdentifier":"s:10Foundation4DateV","kind":"typeIdentifier"}]}]}],"abstract":[{"type":"text","text":"Creation date of the authentication method."}],"variants":[{"paths":["\/documentation\/auth0\/passkeyauthenticationmethod\/createdat"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod"]]},"schemaVersion":{"minor":3,"patch":0,"major":0},"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasskeyAuthenticationMethod":{"role":"symbol","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod","type":"topic","navigatorTitle":[{"text":"PasskeyAuthenticationMethod","kind":"identifier"}],"title":"PasskeyAuthenticationMethod","url":"\/documentation\/auth0\/passkeyauthenticationmethod","abstract":[{"text":"A passkey authentication method.","type":"text"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyAuthenticationMethod","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyAuthenticationMethod/createdAt":{"kind":"symbol","role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/createdAt","abstract":[{"type":"text","text":"Creation date of the authentication method."}],"url":"\/documentation\/auth0\/passkeyauthenticationmethod\/createdat","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"createdAt"},{"kind":"text","text":": "},{"preciseIdentifier":"s:10Foundation4DateV","kind":"typeIdentifier","text":"Date"}],"title":"createdAt"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"sections":[],"kind":"symbol","metadata":{"modules":[{"name":"Auth0"}],"externalID":"s:5Auth027PasskeyAuthenticationMethodV9createdAt10Foundation4DateVvp","title":"createdAt","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"createdAt","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Date","preciseIdentifier":"s:10Foundation4DateV","kind":"typeIdentifier"}],"roleHeading":"Instance Property","role":"symbol","symbolKind":"property"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/createdAt"},"variants":[{"paths":["\/documentation\/auth0\/passkeyauthenticationmethod\/createdat"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"createdAt"},{"kind":"text","text":": "},{"preciseIdentifier":"s:10Foundation4DateV","kind":"typeIdentifier","text":"Date"}]}],"kind":"declarations"}],"abstract":[{"type":"text","text":"Creation date of the authentication method."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasskeyAuthenticationMethod":{"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyAuthenticationMethod","kind":"identifier"}],"navigatorTitle":[{"text":"PasskeyAuthenticationMethod","kind":"identifier"}],"title":"PasskeyAuthenticationMethod","type":"topic","role":"symbol","abstract":[{"type":"text","text":"A passkey authentication method."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod","url":"\/documentation\/auth0\/passkeyauthenticationmethod"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyAuthenticationMethod/createdAt":{"title":"createdAt","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/createdAt","type":"topic","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"createdAt"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"}],"abstract":[{"type":"text","text":"Creation date of the authentication method."}],"url":"\/documentation\/auth0\/passkeyauthenticationmethod\/createdat"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/passkeyauthenticationmethod/credential.json b/docs/data/documentation/auth0/passkeyauthenticationmethod/credential.json index 159005c33..d1420831e 100644 --- a/docs/data/documentation/auth0/passkeyauthenticationmethod/credential.json +++ b/docs/data/documentation/auth0/passkeyauthenticationmethod/credential.json @@ -1 +1 @@ -{"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passkeyauthenticationmethod\/credential"]}],"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/credential","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Details of the passkey credential."}],"metadata":{"title":"credential","externalID":"s:5Auth027PasskeyAuthenticationMethodV10credentialAA0B10CredentialVvp","modules":[{"name":"Auth0"}],"symbolKind":"property","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"credential"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"PasskeyCredential","preciseIdentifier":"s:5Auth017PasskeyCredentialV"}],"roleHeading":"Instance Property"},"schemaVersion":{"patch":0,"minor":3,"major":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"credential"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth017PasskeyCredentialV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential","text":"PasskeyCredential"}]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasskeyAuthenticationMethod":{"role":"symbol","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod","type":"topic","navigatorTitle":[{"text":"PasskeyAuthenticationMethod","kind":"identifier"}],"title":"PasskeyAuthenticationMethod","url":"\/documentation\/auth0\/passkeyauthenticationmethod","abstract":[{"text":"A passkey authentication method.","type":"text"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyAuthenticationMethod","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyCredential":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"PasskeyCredential"}],"type":"topic","role":"symbol","url":"\/documentation\/auth0\/passkeycredential","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasskeyCredential"}],"abstract":[{"type":"text","text":"A passkey credential."}],"title":"PasskeyCredential","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyAuthenticationMethod/credential":{"title":"credential","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/credential","abstract":[{"text":"Details of the passkey credential.","type":"text"}],"kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"credential"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"PasskeyCredential","preciseIdentifier":"s:5Auth017PasskeyCredentialV"}],"url":"\/documentation\/auth0\/passkeyauthenticationmethod\/credential","type":"topic"}}} \ No newline at end of file +{"schemaVersion":{"patch":0,"major":0,"minor":3},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"credential","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth017PasskeyCredentialV","text":"PasskeyCredential","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential"}],"platforms":["iOS"]}]}],"sections":[],"abstract":[{"type":"text","text":"Details of the passkey credential."}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passkeyauthenticationmethod\/credential"]}],"metadata":{"role":"symbol","modules":[{"name":"Auth0"}],"title":"credential","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"credential"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"PasskeyCredential","preciseIdentifier":"s:5Auth017PasskeyCredentialV"}],"externalID":"s:5Auth027PasskeyAuthenticationMethodV10credentialAA0B10CredentialVvp","roleHeading":"Instance Property","symbolKind":"property"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/credential"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasskeyAuthenticationMethod":{"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyAuthenticationMethod","kind":"identifier"}],"navigatorTitle":[{"text":"PasskeyAuthenticationMethod","kind":"identifier"}],"title":"PasskeyAuthenticationMethod","type":"topic","role":"symbol","abstract":[{"type":"text","text":"A passkey authentication method."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod","url":"\/documentation\/auth0\/passkeyauthenticationmethod"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyAuthenticationMethod/credential":{"title":"credential","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/credential","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"credential"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"PasskeyCredential","preciseIdentifier":"s:5Auth017PasskeyCredentialV"}],"abstract":[{"type":"text","text":"Details of the passkey credential."}],"url":"\/documentation\/auth0\/passkeyauthenticationmethod\/credential"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyCredential":{"role":"symbol","title":"PasskeyCredential","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyCredential","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"PasskeyCredential"}],"abstract":[{"text":"A passkey credential.","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/passkeycredential","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/passkeyauthenticationmethod/decodable-implementations.json b/docs/data/documentation/auth0/passkeyauthenticationmethod/decodable-implementations.json index 619820f9a..47453ae65 100644 --- a/docs/data/documentation/auth0/passkeyauthenticationmethod/decodable-implementations.json +++ b/docs/data/documentation/auth0/passkeyauthenticationmethod/decodable-implementations.json @@ -1 +1 @@ -{"metadata":{"modules":[{"name":"Auth0"}],"roleHeading":"API Collection","title":"Decodable Implementations","role":"collectionGroup"},"kind":"article","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/Decodable-Implementations"},"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/init(from:)"],"title":"Initializers","generated":true,"anchor":"Initializers"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passkeyauthenticationmethod\/decodable-implementations"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod"]]},"sections":[],"schemaVersion":{"minor":3,"patch":0,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyAuthenticationMethod/init(from:)":{"title":"init(from:)","abstract":[{"code":"Decodable","type":"codeVoice"},{"type":"text","text":" initializer."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/init(from:)","role":"symbol","url":"\/documentation\/auth0\/passkeyauthenticationmethod\/init(from:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP","text":"Decoder"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"type":"topic","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyAuthenticationMethod":{"role":"symbol","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod","type":"topic","navigatorTitle":[{"text":"PasskeyAuthenticationMethod","kind":"identifier"}],"title":"PasskeyAuthenticationMethod","url":"\/documentation\/auth0\/passkeyauthenticationmethod","abstract":[{"text":"A passkey authentication method.","type":"text"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyAuthenticationMethod","kind":"identifier"}]}}} \ No newline at end of file +{"topicSections":[{"title":"Initializers","generated":true,"anchor":"Initializers","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/init(from:)"]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passkeyauthenticationmethod\/decodable-implementations"]}],"kind":"article","metadata":{"role":"collectionGroup","modules":[{"name":"Auth0"}],"roleHeading":"API Collection","title":"Decodable Implementations"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/Decodable-Implementations"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyAuthenticationMethod":{"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyAuthenticationMethod","kind":"identifier"}],"navigatorTitle":[{"text":"PasskeyAuthenticationMethod","kind":"identifier"}],"title":"PasskeyAuthenticationMethod","type":"topic","role":"symbol","abstract":[{"type":"text","text":"A passkey authentication method."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod","url":"\/documentation\/auth0\/passkeyauthenticationmethod"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyAuthenticationMethod/init(from:)":{"role":"symbol","title":"init(from:)","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"kind":"text","text":": "},{"text":"Decoder","preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"abstract":[{"type":"codeVoice","code":"Decodable"},{"type":"text","text":" initializer."}],"kind":"symbol","url":"\/documentation\/auth0\/passkeyauthenticationmethod\/init(from:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/init(from:)","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/passkeyauthenticationmethod/equatable-implementations.json b/docs/data/documentation/auth0/passkeyauthenticationmethod/equatable-implementations.json index 6639b312a..581f98aff 100644 --- a/docs/data/documentation/auth0/passkeyauthenticationmethod/equatable-implementations.json +++ b/docs/data/documentation/auth0/passkeyauthenticationmethod/equatable-implementations.json @@ -1 +1 @@ -{"sections":[],"schemaVersion":{"patch":0,"major":0,"minor":3},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod"]]},"kind":"article","metadata":{"modules":[{"name":"Auth0"}],"roleHeading":"API Collection","role":"collectionGroup","title":"Equatable Implementations"},"topicSections":[{"anchor":"Operators","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/!=(_:_:)"],"title":"Operators","generated":true}],"variants":[{"paths":["\/documentation\/auth0\/passkeyauthenticationmethod\/equatable-implementations"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/Equatable-Implementations"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasskeyAuthenticationMethod":{"role":"symbol","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod","type":"topic","navigatorTitle":[{"text":"PasskeyAuthenticationMethod","kind":"identifier"}],"title":"PasskeyAuthenticationMethod","url":"\/documentation\/auth0\/passkeyauthenticationmethod","abstract":[{"text":"A passkey authentication method.","type":"text"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyAuthenticationMethod","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyAuthenticationMethod/!=(_:_:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/!=(_:_:)","abstract":[],"kind":"symbol","role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"url":"\/documentation\/auth0\/passkeyauthenticationmethod\/!=(_:_:)","type":"topic","title":"!=(_:_:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passkeyauthenticationmethod\/equatable-implementations"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod"]]},"topicSections":[{"generated":true,"title":"Operators","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/!=(_:_:)"],"anchor":"Operators"}],"metadata":{"title":"Equatable Implementations","role":"collectionGroup","modules":[{"name":"Auth0"}],"roleHeading":"API Collection"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/Equatable-Implementations"},"kind":"article","references":{"doc://com.auth0.Auth0/documentation/Auth0/PasskeyAuthenticationMethod":{"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyAuthenticationMethod","kind":"identifier"}],"navigatorTitle":[{"text":"PasskeyAuthenticationMethod","kind":"identifier"}],"title":"PasskeyAuthenticationMethod","type":"topic","role":"symbol","abstract":[{"type":"text","text":"A passkey authentication method."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod","url":"\/documentation\/auth0\/passkeyauthenticationmethod"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyAuthenticationMethod/!=(_:_:)":{"kind":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","text":"Self"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"Self"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"title":"!=(_:_:)","type":"topic","role":"symbol","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/!=(_:_:)","url":"\/documentation\/auth0\/passkeyauthenticationmethod\/!=(_:_:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/passkeyauthenticationmethod/id.json b/docs/data/documentation/auth0/passkeyauthenticationmethod/id.json index e974316cf..1fffc5265 100644 --- a/docs/data/documentation/auth0/passkeyauthenticationmethod/id.json +++ b/docs/data/documentation/auth0/passkeyauthenticationmethod/id.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod"]]},"variants":[{"paths":["\/documentation\/auth0\/passkeyauthenticationmethod\/id"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"id","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}]}]}],"metadata":{"symbolKind":"property","modules":[{"name":"Auth0"}],"role":"symbol","roleHeading":"Instance Property","title":"id","externalID":"s:5Auth027PasskeyAuthenticationMethodV2idSSvp","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"id","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}]},"abstract":[{"type":"text","text":"Unique identifier of the authentication method."}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/id","interfaceLanguage":"swift"},"sections":[],"schemaVersion":{"minor":3,"major":0,"patch":0},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyAuthenticationMethod/id":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/id","kind":"symbol","abstract":[{"type":"text","text":"Unique identifier of the authentication method."}],"url":"\/documentation\/auth0\/passkeyauthenticationmethod\/id","role":"symbol","title":"id","type":"topic","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"id"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}]},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyAuthenticationMethod":{"role":"symbol","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod","type":"topic","navigatorTitle":[{"text":"PasskeyAuthenticationMethod","kind":"identifier"}],"title":"PasskeyAuthenticationMethod","url":"\/documentation\/auth0\/passkeyauthenticationmethod","abstract":[{"text":"A passkey authentication method.","type":"text"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyAuthenticationMethod","kind":"identifier"}]}}} \ No newline at end of file +{"abstract":[{"type":"text","text":"Unique identifier of the authentication method."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"id","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"platforms":["iOS"],"languages":["swift"]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passkeyauthenticationmethod\/id"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod"]]},"metadata":{"modules":[{"name":"Auth0"}],"symbolKind":"property","roleHeading":"Instance Property","title":"id","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"id"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"externalID":"s:5Auth027PasskeyAuthenticationMethodV2idSSvp"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/id"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyAuthenticationMethod":{"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyAuthenticationMethod","kind":"identifier"}],"navigatorTitle":[{"text":"PasskeyAuthenticationMethod","kind":"identifier"}],"title":"PasskeyAuthenticationMethod","type":"topic","role":"symbol","abstract":[{"type":"text","text":"A passkey authentication method."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod","url":"\/documentation\/auth0\/passkeyauthenticationmethod"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyAuthenticationMethod/id":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/id","title":"id","type":"topic","role":"symbol","kind":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"id","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"abstract":[{"text":"Unique identifier of the authentication method.","type":"text"}],"url":"\/documentation\/auth0\/passkeyauthenticationmethod\/id"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/passkeyauthenticationmethod/init(from:).json b/docs/data/documentation/auth0/passkeyauthenticationmethod/init(from:).json index dd5e636dd..06b71edee 100644 --- a/docs/data/documentation/auth0/passkeyauthenticationmethod/init(from:).json +++ b/docs/data/documentation/auth0/passkeyauthenticationmethod/init(from:).json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod"]]},"metadata":{"externalID":"s:5Auth027PasskeyAuthenticationMethodV4fromACs7Decoder_p_tKcfc","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier","text":"Decoder"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"title":"init(from:)","role":"symbol","symbolKind":"init","extendedModule":"Auth0","modules":[{"name":"Auth0"}],"roleHeading":"Initializer"},"schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/init(from:)","interfaceLanguage":"swift"},"sections":[],"abstract":[{"code":"Decodable","type":"codeVoice"},{"type":"text","text":" initializer."}],"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"init","kind":"keyword"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"decoder","kind":"internalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:s7DecoderP","text":"Decoder","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"languages":["swift"],"platforms":["iOS"]}]}],"variants":[{"paths":["\/documentation\/auth0\/passkeyauthenticationmethod\/init(from:)"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyAuthenticationMethod":{"role":"symbol","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod","type":"topic","navigatorTitle":[{"text":"PasskeyAuthenticationMethod","kind":"identifier"}],"title":"PasskeyAuthenticationMethod","url":"\/documentation\/auth0\/passkeyauthenticationmethod","abstract":[{"text":"A passkey authentication method.","type":"text"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyAuthenticationMethod","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyAuthenticationMethod/init(from:)":{"title":"init(from:)","abstract":[{"code":"Decodable","type":"codeVoice"},{"type":"text","text":" initializer."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/init(from:)","role":"symbol","url":"\/documentation\/auth0\/passkeyauthenticationmethod\/init(from:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP","text":"Decoder"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"type":"topic","kind":"symbol"}}} \ No newline at end of file +{"kind":"symbol","primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"init","kind":"keyword"},{"kind":"text","text":"("},{"text":"from","kind":"externalParam"},{"kind":"text","text":" "},{"text":"decoder","kind":"internalParam"},{"kind":"text","text":": "},{"text":"Decoder","preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}]}],"kind":"declarations"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passkeyauthenticationmethod\/init(from:)"]}],"sections":[],"schemaVersion":{"patch":0,"major":0,"minor":3},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/init(from:)","interfaceLanguage":"swift"},"abstract":[{"code":"Decodable","type":"codeVoice"},{"type":"text","text":" initializer."}],"metadata":{"roleHeading":"Initializer","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP","text":"Decoder"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"modules":[{"name":"Auth0"}],"role":"symbol","title":"init(from:)","externalID":"s:5Auth027PasskeyAuthenticationMethodV4fromACs7Decoder_p_tKcfc","extendedModule":"Auth0","symbolKind":"init"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyAuthenticationMethod":{"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyAuthenticationMethod","kind":"identifier"}],"navigatorTitle":[{"text":"PasskeyAuthenticationMethod","kind":"identifier"}],"title":"PasskeyAuthenticationMethod","type":"topic","role":"symbol","abstract":[{"type":"text","text":"A passkey authentication method."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod","url":"\/documentation\/auth0\/passkeyauthenticationmethod"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyAuthenticationMethod/init(from:)":{"role":"symbol","title":"init(from:)","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"kind":"text","text":": "},{"text":"Decoder","preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"abstract":[{"type":"codeVoice","code":"Decodable"},{"type":"text","text":" initializer."}],"kind":"symbol","url":"\/documentation\/auth0\/passkeyauthenticationmethod\/init(from:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/init(from:)","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/passkeyauthenticationmethod/relyingpartyidentifier.json b/docs/data/documentation/auth0/passkeyauthenticationmethod/relyingpartyidentifier.json new file mode 100644 index 000000000..bcc61a4cc --- /dev/null +++ b/docs/data/documentation/auth0/passkeyauthenticationmethod/relyingpartyidentifier.json @@ -0,0 +1 @@ +{"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passkeyauthenticationmethod\/relyingpartyidentifier"]}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod"]]},"abstract":[{"text":"Relying party Id for the domain","type":"text"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"roleHeading":"Instance Property","symbolKind":"property","title":"relyingPartyIdentifier","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"relyingPartyIdentifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"externalID":"s:5Auth027PasskeyAuthenticationMethodV22relyingPartyIdentifierSSvp","modules":[{"name":"Auth0"}]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"relyingPartyIdentifier","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"platforms":["iOS"],"languages":["swift"]}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/relyingPartyIdentifier"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasskeyAuthenticationMethod/relyingPartyIdentifier":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/relyingPartyIdentifier","kind":"symbol","title":"relyingPartyIdentifier","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"relyingPartyIdentifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"role":"symbol","url":"\/documentation\/auth0\/passkeyauthenticationmethod\/relyingpartyidentifier","abstract":[{"text":"Relying party Id for the domain","type":"text"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyAuthenticationMethod":{"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyAuthenticationMethod","kind":"identifier"}],"navigatorTitle":[{"text":"PasskeyAuthenticationMethod","kind":"identifier"}],"title":"PasskeyAuthenticationMethod","type":"topic","role":"symbol","abstract":[{"type":"text","text":"A passkey authentication method."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod","url":"\/documentation\/auth0\/passkeyauthenticationmethod"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/passkeyauthenticationmethod/type.json b/docs/data/documentation/auth0/passkeyauthenticationmethod/type.json index 2cee62cda..c8b273177 100644 --- a/docs/data/documentation/auth0/passkeyauthenticationmethod/type.json +++ b/docs/data/documentation/auth0/passkeyauthenticationmethod/type.json @@ -1 +1 @@ -{"kind":"symbol","sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/type"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passkeyauthenticationmethod\/type"]}],"metadata":{"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"type"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"modules":[{"name":"Auth0"}],"title":"type","externalID":"s:5Auth027PasskeyAuthenticationMethodV4typeSSvp","roleHeading":"Instance Property","symbolKind":"property","role":"symbol"},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"type"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"languages":["swift"]}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod"]]},"abstract":[{"type":"text","text":"Type of the authentication method. Equals to "},{"code":"passkey","type":"codeVoice"},{"type":"text","text":"."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasskeyAuthenticationMethod/type":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/type","role":"symbol","url":"\/documentation\/auth0\/passkeyauthenticationmethod\/type","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"type","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"title":"type","type":"topic","abstract":[{"type":"text","text":"Type of the authentication method. Equals to "},{"type":"codeVoice","code":"passkey"},{"type":"text","text":"."}]},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyAuthenticationMethod":{"role":"symbol","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod","type":"topic","navigatorTitle":[{"text":"PasskeyAuthenticationMethod","kind":"identifier"}],"title":"PasskeyAuthenticationMethod","url":"\/documentation\/auth0\/passkeyauthenticationmethod","abstract":[{"text":"A passkey authentication method.","type":"text"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyAuthenticationMethod","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"metadata":{"externalID":"s:5Auth027PasskeyAuthenticationMethodV4typeSSvp","symbolKind":"property","title":"type","role":"symbol","roleHeading":"Instance Property","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"type","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"modules":[{"name":"Auth0"}]},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passkeyauthenticationmethod\/type"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/type","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"text":"Type of the authentication method. Equals to ","type":"text"},{"code":"passkey","type":"codeVoice"},{"text":".","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod"]]},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"type","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}]}],"kind":"declarations"}],"schemaVersion":{"minor":3,"patch":0,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyAuthenticationMethod/type":{"title":"type","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/type","type":"topic","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"type"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"abstract":[{"type":"text","text":"Type of the authentication method. Equals to "},{"type":"codeVoice","code":"passkey"},{"type":"text","text":"."}],"url":"\/documentation\/auth0\/passkeyauthenticationmethod\/type"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyAuthenticationMethod":{"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyAuthenticationMethod","kind":"identifier"}],"navigatorTitle":[{"text":"PasskeyAuthenticationMethod","kind":"identifier"}],"title":"PasskeyAuthenticationMethod","type":"topic","role":"symbol","abstract":[{"type":"text","text":"A passkey authentication method."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod","url":"\/documentation\/auth0\/passkeyauthenticationmethod"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/passkeyauthenticationmethod/useragent.json b/docs/data/documentation/auth0/passkeyauthenticationmethod/useragent.json index 2d8eeb568..23093c528 100644 --- a/docs/data/documentation/auth0/passkeyauthenticationmethod/useragent.json +++ b/docs/data/documentation/auth0/passkeyauthenticationmethod/useragent.json @@ -1 +1 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/userAgent","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod"]]},"schemaVersion":{"major":0,"patch":0,"minor":3},"sections":[],"abstract":[{"text":"The user agent of the browser o device used to enroll the passkey.","type":"text"}],"metadata":{"modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","externalID":"s:5Auth027PasskeyAuthenticationMethodV9userAgentSSSgvp","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"userAgent"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"symbolKind":"property","role":"symbol","title":"userAgent"},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"userAgent","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passkeyauthenticationmethod\/useragent"]}],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/PasskeyAuthenticationMethod/userAgent":{"role":"symbol","kind":"symbol","abstract":[{"text":"The user agent of the browser o device used to enroll the passkey.","type":"text"}],"url":"\/documentation\/auth0\/passkeyauthenticationmethod\/useragent","type":"topic","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"userAgent"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/userAgent","title":"userAgent"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyAuthenticationMethod":{"role":"symbol","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod","type":"topic","navigatorTitle":[{"text":"PasskeyAuthenticationMethod","kind":"identifier"}],"title":"PasskeyAuthenticationMethod","url":"\/documentation\/auth0\/passkeyauthenticationmethod","abstract":[{"text":"A passkey authentication method.","type":"text"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyAuthenticationMethod","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"variants":[{"paths":["\/documentation\/auth0\/passkeyauthenticationmethod\/useragent"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod"]]},"abstract":[{"type":"text","text":"The user agent of the browser o device used to enroll the passkey."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"userAgent"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"languages":["swift"],"platforms":["iOS"]}]}],"schemaVersion":{"patch":0,"minor":3,"major":0},"kind":"symbol","sections":[],"metadata":{"externalID":"s:5Auth027PasskeyAuthenticationMethodV9userAgentSSSgvp","symbolKind":"property","title":"userAgent","roleHeading":"Instance Property","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"userAgent"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"modules":[{"name":"Auth0"}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/userAgent"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyAuthenticationMethod":{"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyAuthenticationMethod","kind":"identifier"}],"navigatorTitle":[{"text":"PasskeyAuthenticationMethod","kind":"identifier"}],"title":"PasskeyAuthenticationMethod","type":"topic","role":"symbol","abstract":[{"type":"text","text":"A passkey authentication method."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod","url":"\/documentation\/auth0\/passkeyauthenticationmethod"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyAuthenticationMethod/userAgent":{"url":"\/documentation\/auth0\/passkeyauthenticationmethod\/useragent","title":"userAgent","abstract":[{"text":"The user agent of the browser o device used to enroll the passkey.","type":"text"}],"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"userAgent","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/userAgent","role":"symbol","kind":"symbol","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/passkeyauthenticationmethod/useridentityid.json b/docs/data/documentation/auth0/passkeyauthenticationmethod/useridentityid.json index 9754c118f..a5cb96e84 100644 --- a/docs/data/documentation/auth0/passkeyauthenticationmethod/useridentityid.json +++ b/docs/data/documentation/auth0/passkeyauthenticationmethod/useridentityid.json @@ -1 +1 @@ -{"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod"]]},"variants":[{"paths":["\/documentation\/auth0\/passkeyauthenticationmethod\/useridentityid"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"title":"userIdentityId","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"userIdentityId","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"externalID":"s:5Auth027PasskeyAuthenticationMethodV14userIdentityIdSSvp","symbolKind":"property","role":"symbol"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/userIdentityId"},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"userIdentityId","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"languages":["swift"],"platforms":["iOS"]}]}],"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"type":"text","text":"Unique identifier of the user identity linked with the authentication method."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasskeyAuthenticationMethod":{"role":"symbol","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod","type":"topic","navigatorTitle":[{"text":"PasskeyAuthenticationMethod","kind":"identifier"}],"title":"PasskeyAuthenticationMethod","url":"\/documentation\/auth0\/passkeyauthenticationmethod","abstract":[{"text":"A passkey authentication method.","type":"text"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyAuthenticationMethod","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyAuthenticationMethod/userIdentityId":{"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"userIdentityId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/userIdentityId","url":"\/documentation\/auth0\/passkeyauthenticationmethod\/useridentityid","kind":"symbol","role":"symbol","title":"userIdentityId","abstract":[{"type":"text","text":"Unique identifier of the user identity linked with the authentication method."}],"type":"topic"}}} \ No newline at end of file +{"kind":"symbol","primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"userIdentityId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"platforms":["iOS"]}],"kind":"declarations"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passkeyauthenticationmethod\/useridentityid"]}],"sections":[],"schemaVersion":{"minor":3,"patch":0,"major":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/userIdentityId"},"abstract":[{"text":"Unique identifier of the user identity linked with the authentication method.","type":"text"}],"metadata":{"symbolKind":"property","modules":[{"name":"Auth0"}],"title":"userIdentityId","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"userIdentityId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"externalID":"s:5Auth027PasskeyAuthenticationMethodV14userIdentityIdSSvp","role":"symbol","roleHeading":"Instance Property"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasskeyAuthenticationMethod/userIdentityId":{"title":"userIdentityId","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod\/userIdentityId","type":"topic","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"userIdentityId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"abstract":[{"type":"text","text":"Unique identifier of the user identity linked with the authentication method."}],"url":"\/documentation\/auth0\/passkeyauthenticationmethod\/useridentityid"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyAuthenticationMethod":{"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyAuthenticationMethod","kind":"identifier"}],"navigatorTitle":[{"text":"PasskeyAuthenticationMethod","kind":"identifier"}],"title":"PasskeyAuthenticationMethod","type":"topic","role":"symbol","abstract":[{"type":"text","text":"A passkey authentication method."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyAuthenticationMethod","url":"\/documentation\/auth0\/passkeyauthenticationmethod"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/passkeycredential.json b/docs/data/documentation/auth0/passkeycredential.json index 6ec098340..36c259606 100644 --- a/docs/data/documentation/auth0/passkeycredential.json +++ b/docs/data/documentation/auth0/passkeycredential.json @@ -1 +1 @@ -{"relationshipsSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/s8CopyableP","doc:\/\/com.auth0.Auth0\/Se","doc:\/\/com.auth0.Auth0\/SQ","doc:\/\/com.auth0.Auth0\/s12IdentifiableP","doc:\/\/com.auth0.Auth0\/s8SendableP","doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP"],"title":"Conforms To","kind":"relationships","type":"conformsTo"}],"variants":[{"paths":["\/documentation\/auth0\/passkeycredential"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential"},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyCredential","kind":"identifier"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential\/deviceType","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential\/id","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential\/isBackedUp","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential\/publicKey","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential\/userHandle"],"title":"Instance Properties","generated":true,"anchor":"Instance-Properties"},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential\/Decodable-Implementations","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential\/Equatable-Implementations"],"title":"Default Implementations","generated":true,"anchor":"Default-Implementations"}],"metadata":{"title":"PasskeyCredential","role":"symbol","modules":[{"name":"Auth0"}],"roleHeading":"Structure","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyCredential","kind":"identifier"}],"navigatorTitle":[{"text":"PasskeyCredential","kind":"identifier"}],"externalID":"s:5Auth017PasskeyCredentialV","symbolKind":"struct"},"schemaVersion":{"minor":3,"patch":0,"major":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"abstract":[{"text":"A passkey credential.","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasskeyCredential":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"PasskeyCredential"}],"type":"topic","role":"symbol","url":"\/documentation\/auth0\/passkeycredential","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasskeyCredential"}],"abstract":[{"type":"text","text":"A passkey credential."}],"title":"PasskeyCredential","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential"},"doc://com.auth0.Auth0/Se":{"title":"Swift.Decodable","identifier":"doc:\/\/com.auth0.Auth0\/Se","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyCredential/userHandle":{"kind":"symbol","abstract":[{"text":"User handle associated with the passkey credential.","type":"text"}],"title":"userHandle","type":"topic","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"userHandle","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation4DataV","text":"Data","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential\/userHandle","url":"\/documentation\/auth0\/passkeycredential\/userhandle"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyCredential/id":{"title":"id","kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"id"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential\/id","abstract":[{"type":"text","text":"Unique identifier of the passkey credential."}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/passkeycredential\/id"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyCredential/isBackedUp":{"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"isBackedUp"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"kind":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential\/isBackedUp","title":"isBackedUp","url":"\/documentation\/auth0\/passkeycredential\/isbackedup","abstract":[{"type":"text","text":"Whether the passkey credential was backed up."}],"role":"symbol"},"doc://com.auth0.Auth0/s8SendableP":{"title":"Swift.Sendable","identifier":"doc:\/\/com.auth0.Auth0\/s8SendableP","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyCredential/Equatable-Implementations":{"title":"Equatable Implementations","kind":"article","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential\/Equatable-Implementations","abstract":[],"role":"collectionGroup","type":"topic","url":"\/documentation\/auth0\/passkeycredential\/equatable-implementations"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyCredential/Decodable-Implementations":{"title":"Decodable Implementations","kind":"article","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential\/Decodable-Implementations","abstract":[],"role":"collectionGroup","type":"topic","url":"\/documentation\/auth0\/passkeycredential\/decodable-implementations"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyCredential/deviceType":{"kind":"symbol","abstract":[{"text":"Kind of device the passkey credential is stored on as defined by backup eligibility.","type":"text"}],"title":"deviceType","url":"\/documentation\/auth0\/passkeycredential\/devicetype","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential\/deviceType","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"deviceType"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"PasskeyDeviceType","preciseIdentifier":"s:5Auth017PasskeyDeviceTypeO"}],"type":"topic"},"doc://com.auth0.Auth0/s12IdentifiableP":{"title":"Swift.Identifiable","identifier":"doc:\/\/com.auth0.Auth0\/s12IdentifiableP","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyCredential/publicKey":{"url":"\/documentation\/auth0\/passkeycredential\/publickey","role":"symbol","type":"topic","abstract":[{"type":"text","text":"Public key of the passkey credential."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential\/publicKey","title":"publicKey","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"publicKey","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Data","preciseIdentifier":"s:10Foundation4DataV","kind":"typeIdentifier"}]},"doc://com.auth0.Auth0/s16SendableMetatypeP":{"title":"Swift.SendableMetatype","identifier":"doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP","type":"unresolvable"},"doc://com.auth0.Auth0/s8CopyableP":{"title":"Swift.Copyable","identifier":"doc:\/\/com.auth0.Auth0\/s8CopyableP","type":"unresolvable"},"doc://com.auth0.Auth0/SQ":{"title":"Swift.Equatable","identifier":"doc:\/\/com.auth0.Auth0\/SQ","type":"unresolvable"}}} \ No newline at end of file +{"metadata":{"symbolKind":"struct","title":"PasskeyCredential","externalID":"s:5Auth017PasskeyCredentialV","roleHeading":"Structure","modules":[{"name":"Auth0"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyCredential","kind":"identifier"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"PasskeyCredential"}]},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passkeycredential"]}],"relationshipsSections":[{"title":"Conforms To","kind":"relationships","type":"conformsTo","identifiers":["doc:\/\/com.auth0.Auth0\/s8CopyableP","doc:\/\/com.auth0.Auth0\/Se","doc:\/\/com.auth0.Auth0\/SQ","doc:\/\/com.auth0.Auth0\/s12IdentifiableP","doc:\/\/com.auth0.Auth0\/s8SendableP","doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP"]}],"topicSections":[{"anchor":"Instance-Properties","title":"Instance Properties","generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential\/deviceType","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential\/id","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential\/isBackedUp","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential\/publicKey","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential\/userHandle"]},{"anchor":"Default-Implementations","title":"Default Implementations","generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential\/Decodable-Implementations","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential\/Equatable-Implementations"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential"},"kind":"symbol","abstract":[{"type":"text","text":"A passkey credential."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyCredential","kind":"identifier"}]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasskeyCredential":{"role":"symbol","title":"PasskeyCredential","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyCredential","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"PasskeyCredential"}],"abstract":[{"text":"A passkey credential.","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/passkeycredential","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyCredential/isBackedUp":{"role":"symbol","title":"isBackedUp","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"isBackedUp","kind":"identifier"},{"kind":"text","text":": "},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"abstract":[{"type":"text","text":"Whether the passkey credential was backed up."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential\/isBackedUp","url":"\/documentation\/auth0\/passkeycredential\/isbackedup","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyCredential/publicKey":{"title":"publicKey","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential\/publicKey","type":"topic","role":"symbol","kind":"symbol","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"publicKey"},{"kind":"text","text":": "},{"text":"Data","preciseIdentifier":"s:10Foundation4DataV","kind":"typeIdentifier"}],"abstract":[{"type":"text","text":"Public key of the passkey credential."}],"url":"\/documentation\/auth0\/passkeycredential\/publickey"},"doc://com.auth0.Auth0/s8CopyableP":{"title":"Swift.Copyable","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s8CopyableP"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyCredential/id":{"kind":"symbol","title":"id","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"id"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential\/id","abstract":[{"type":"text","text":"Unique identifier of the passkey credential."}],"url":"\/documentation\/auth0\/passkeycredential\/id"},"doc://com.auth0.Auth0/s16SendableMetatypeP":{"title":"Swift.SendableMetatype","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP"},"doc://com.auth0.Auth0/s12IdentifiableP":{"title":"Swift.Identifiable","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s12IdentifiableP"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyCredential/deviceType":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential\/deviceType","kind":"symbol","title":"deviceType","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"deviceType"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth017PasskeyDeviceTypeO","text":"PasskeyDeviceType"}],"role":"symbol","url":"\/documentation\/auth0\/passkeycredential\/devicetype","abstract":[{"type":"text","text":"Kind of device the passkey credential is stored on as defined by backup eligibility."}],"type":"topic"},"doc://com.auth0.Auth0/Se":{"title":"Swift.Decodable","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/Se"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyCredential/Decodable-Implementations":{"type":"topic","title":"Decodable Implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential\/Decodable-Implementations","kind":"article","abstract":[],"url":"\/documentation\/auth0\/passkeycredential\/decodable-implementations","role":"collectionGroup"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyCredential/userHandle":{"kind":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"userHandle","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Data","preciseIdentifier":"s:10Foundation4DataV","kind":"typeIdentifier"}],"title":"userHandle","type":"topic","role":"symbol","abstract":[{"type":"text","text":"User handle associated with the passkey credential."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential\/userHandle","url":"\/documentation\/auth0\/passkeycredential\/userhandle"},"doc://com.auth0.Auth0/s8SendableP":{"title":"Swift.Sendable","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s8SendableP"},"doc://com.auth0.Auth0/SQ":{"title":"Swift.Equatable","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/SQ"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyCredential/Equatable-Implementations":{"role":"collectionGroup","title":"Equatable Implementations","abstract":[],"kind":"article","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential\/Equatable-Implementations","url":"\/documentation\/auth0\/passkeycredential\/equatable-implementations","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/passkeycredential/!=(_:_:).json b/docs/data/documentation/auth0/passkeycredential/!=(_:_:).json index 9b049562c..71c8ef259 100644 --- a/docs/data/documentation/auth0/passkeycredential/!=(_:_:).json +++ b/docs/data/documentation/auth0/passkeycredential/!=(_:_:).json @@ -1 +1 @@ -{"abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"Equatable.!=(_:_:)"},{"type":"text","text":"."}],"metadata":{"modules":[{"relatedModules":["Swift"],"name":"Auth0"}],"extendedModule":"Swift","title":"!=(_:_:)","symbolKind":"op","roleHeading":"Operator","externalID":"s:SQsE2neoiySbx_xtFZ::SYNTHESIZED::s:5Auth017PasskeyCredentialV","role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}]},"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential\/!=(_:_:)"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential"]]},"schemaVersion":{"minor":3,"major":0,"patch":0},"variants":[{"paths":["\/documentation\/auth0\/passkeycredential\/!=(_:_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"!="},{"kind":"text","text":" "},{"kind":"text","text":"("},{"kind":"internalParam","text":"lhs"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":", "},{"kind":"internalParam","text":"rhs"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}]}],"kind":"declarations"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasskeyCredential/!=(_:_:)":{"kind":"symbol","role":"symbol","url":"\/documentation\/auth0\/passkeycredential\/!=(_:_:)","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential\/!=(_:_:)","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"type":"topic","title":"!=(_:_:)"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyCredential":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"PasskeyCredential"}],"type":"topic","role":"symbol","url":"\/documentation\/auth0\/passkeycredential","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasskeyCredential"}],"abstract":[{"type":"text","text":"A passkey credential."}],"title":"PasskeyCredential","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passkeycredential\/!=(_:_:)"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential"]]},"abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"Equatable.!=(_:_:)"},{"type":"text","text":"."}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"lhs","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"rhs","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}]}],"kind":"declarations"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","sections":[],"metadata":{"externalID":"s:SQsE2neoiySbx_xtFZ::SYNTHESIZED::s:5Auth017PasskeyCredentialV","extendedModule":"Swift","symbolKind":"op","title":"!=(_:_:)","roleHeading":"Operator","role":"symbol","fragments":[{"kind":"keyword","text":"static"},{"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"},{"text":"Self","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"modules":[{"name":"Auth0","relatedModules":["Swift"]}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential\/!=(_:_:)","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasskeyCredential/!=(_:_:)":{"type":"topic","abstract":[],"kind":"symbol","url":"\/documentation\/auth0\/passkeycredential\/!=(_:_:)","title":"!=(_:_:)","role":"symbol","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","text":"Self"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential\/!=(_:_:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyCredential":{"role":"symbol","title":"PasskeyCredential","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyCredential","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"PasskeyCredential"}],"abstract":[{"text":"A passkey credential.","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/passkeycredential","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/passkeycredential/decodable-implementations.json b/docs/data/documentation/auth0/passkeycredential/decodable-implementations.json index 861e62c8b..9159100a7 100644 --- a/docs/data/documentation/auth0/passkeycredential/decodable-implementations.json +++ b/docs/data/documentation/auth0/passkeycredential/decodable-implementations.json @@ -1 +1 @@ -{"metadata":{"roleHeading":"API Collection","role":"collectionGroup","modules":[{"name":"Auth0"}],"title":"Decodable Implementations"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passkeycredential\/decodable-implementations"]}],"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential\/init(from:)"],"generated":true,"title":"Initializers","anchor":"Initializers"}],"sections":[],"kind":"article","schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential\/Decodable-Implementations","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasskeyCredential/init(from:)":{"kind":"symbol","title":"init(from:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier","text":"Decoder"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential\/init(from:)","abstract":[{"type":"codeVoice","code":"Decodable"},{"type":"text","text":" initializer."}],"type":"topic","url":"\/documentation\/auth0\/passkeycredential\/init(from:)"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyCredential":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"PasskeyCredential"}],"type":"topic","role":"symbol","url":"\/documentation\/auth0\/passkeycredential","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasskeyCredential"}],"abstract":[{"type":"text","text":"A passkey credential."}],"title":"PasskeyCredential","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passkeycredential\/decodable-implementations"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential"]]},"topicSections":[{"generated":true,"anchor":"Initializers","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential\/init(from:)"],"title":"Initializers"}],"schemaVersion":{"minor":3,"patch":0,"major":0},"kind":"article","sections":[],"metadata":{"title":"Decodable Implementations","modules":[{"name":"Auth0"}],"roleHeading":"API Collection","role":"collectionGroup"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential\/Decodable-Implementations"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasskeyCredential":{"role":"symbol","title":"PasskeyCredential","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyCredential","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"PasskeyCredential"}],"abstract":[{"text":"A passkey credential.","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/passkeycredential","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyCredential/init(from:)":{"url":"\/documentation\/auth0\/passkeycredential\/init(from:)","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:s7DecoderP","text":"Decoder","kind":"typeIdentifier"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"title":"init(from:)","type":"topic","role":"symbol","abstract":[{"code":"Decodable","type":"codeVoice"},{"text":" initializer.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential\/init(from:)","kind":"symbol"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/passkeycredential/devicetype.json b/docs/data/documentation/auth0/passkeycredential/devicetype.json index 30351b3f1..0c144edc9 100644 --- a/docs/data/documentation/auth0/passkeycredential/devicetype.json +++ b/docs/data/documentation/auth0/passkeycredential/devicetype.json @@ -1 +1 @@ -{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential\/deviceType"},"abstract":[{"type":"text","text":"Kind of device the passkey credential is stored on as defined by backup eligibility."}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential"]]},"sections":[],"schemaVersion":{"patch":0,"minor":3,"major":0},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"deviceType","kind":"identifier"},{"text":": ","kind":"text"},{"text":"PasskeyDeviceType","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType","preciseIdentifier":"s:5Auth017PasskeyDeviceTypeO"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"variants":[{"paths":["\/documentation\/auth0\/passkeycredential\/devicetype"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","externalID":"s:5Auth017PasskeyCredentialV10deviceTypeAA0b6DeviceE0Ovp","title":"deviceType","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"deviceType","kind":"identifier"},{"text":": ","kind":"text"},{"text":"PasskeyDeviceType","preciseIdentifier":"s:5Auth017PasskeyDeviceTypeO","kind":"typeIdentifier"}],"symbolKind":"property"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasskeyDeviceType":{"type":"topic","kind":"symbol","url":"\/documentation\/auth0\/passkeydevicetype","abstract":[{"text":"Kind of device the passkey is stored on as defined by backup eligibility.","type":"text"}],"role":"symbol","title":"PasskeyDeviceType","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyDeviceType","kind":"identifier"}],"navigatorTitle":[{"text":"PasskeyDeviceType","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyCredential":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"PasskeyCredential"}],"type":"topic","role":"symbol","url":"\/documentation\/auth0\/passkeycredential","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasskeyCredential"}],"abstract":[{"type":"text","text":"A passkey credential."}],"title":"PasskeyCredential","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyCredential/deviceType":{"kind":"symbol","abstract":[{"text":"Kind of device the passkey credential is stored on as defined by backup eligibility.","type":"text"}],"title":"deviceType","url":"\/documentation\/auth0\/passkeycredential\/devicetype","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential\/deviceType","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"deviceType"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"PasskeyDeviceType","preciseIdentifier":"s:5Auth017PasskeyDeviceTypeO"}],"type":"topic"}}} \ No newline at end of file +{"abstract":[{"type":"text","text":"Kind of device the passkey credential is stored on as defined by backup eligibility."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"deviceType","kind":"identifier"},{"text":": ","kind":"text"},{"text":"PasskeyDeviceType","preciseIdentifier":"s:5Auth017PasskeyDeviceTypeO","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType"}]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passkeycredential\/devicetype"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential"]]},"metadata":{"modules":[{"name":"Auth0"}],"title":"deviceType","symbolKind":"property","roleHeading":"Instance Property","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"deviceType","kind":"identifier"},{"text":": ","kind":"text"},{"text":"PasskeyDeviceType","preciseIdentifier":"s:5Auth017PasskeyDeviceTypeO","kind":"typeIdentifier"}],"externalID":"s:5Auth017PasskeyCredentialV10deviceTypeAA0b6DeviceE0Ovp"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential\/deviceType","interfaceLanguage":"swift"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyDeviceType":{"navigatorTitle":[{"kind":"identifier","text":"PasskeyDeviceType"}],"kind":"symbol","url":"\/documentation\/auth0\/passkeydevicetype","role":"symbol","abstract":[{"text":"Kind of device the passkey is stored on as defined by backup eligibility.","type":"text"}],"type":"topic","fragments":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"text":"PasskeyDeviceType","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType","title":"PasskeyDeviceType"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyCredential":{"role":"symbol","title":"PasskeyCredential","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyCredential","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"PasskeyCredential"}],"abstract":[{"text":"A passkey credential.","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/passkeycredential","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyCredential/deviceType":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential\/deviceType","kind":"symbol","title":"deviceType","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"deviceType"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth017PasskeyDeviceTypeO","text":"PasskeyDeviceType"}],"role":"symbol","url":"\/documentation\/auth0\/passkeycredential\/devicetype","abstract":[{"type":"text","text":"Kind of device the passkey credential is stored on as defined by backup eligibility."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/passkeycredential/equatable-implementations.json b/docs/data/documentation/auth0/passkeycredential/equatable-implementations.json index d91d60e3a..5629000b5 100644 --- a/docs/data/documentation/auth0/passkeycredential/equatable-implementations.json +++ b/docs/data/documentation/auth0/passkeycredential/equatable-implementations.json @@ -1 +1 @@ -{"kind":"article","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential"]]},"topicSections":[{"generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential\/!=(_:_:)"],"anchor":"Operators","title":"Operators"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential\/Equatable-Implementations"},"sections":[],"metadata":{"role":"collectionGroup","modules":[{"name":"Auth0"}],"roleHeading":"API Collection","title":"Equatable Implementations"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passkeycredential\/equatable-implementations"]}],"schemaVersion":{"minor":3,"major":0,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasskeyCredential/!=(_:_:)":{"kind":"symbol","role":"symbol","url":"\/documentation\/auth0\/passkeycredential\/!=(_:_:)","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential\/!=(_:_:)","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"type":"topic","title":"!=(_:_:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyCredential":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"PasskeyCredential"}],"type":"topic","role":"symbol","url":"\/documentation\/auth0\/passkeycredential","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasskeyCredential"}],"abstract":[{"type":"text","text":"A passkey credential."}],"title":"PasskeyCredential","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential"}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passkeycredential\/equatable-implementations"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential"]]},"topicSections":[{"title":"Operators","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential\/!=(_:_:)"],"generated":true,"anchor":"Operators"}],"kind":"article","schemaVersion":{"minor":3,"major":0,"patch":0},"sections":[],"metadata":{"role":"collectionGroup","title":"Equatable Implementations","modules":[{"name":"Auth0"}],"roleHeading":"API Collection"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential\/Equatable-Implementations"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyCredential":{"role":"symbol","title":"PasskeyCredential","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyCredential","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"PasskeyCredential"}],"abstract":[{"text":"A passkey credential.","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/passkeycredential","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyCredential/!=(_:_:)":{"type":"topic","abstract":[],"kind":"symbol","url":"\/documentation\/auth0\/passkeycredential\/!=(_:_:)","title":"!=(_:_:)","role":"symbol","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","text":"Self"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential\/!=(_:_:)"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/passkeycredential/id.json b/docs/data/documentation/auth0/passkeycredential/id.json index a8b78a9eb..6ea3df829 100644 --- a/docs/data/documentation/auth0/passkeycredential/id.json +++ b/docs/data/documentation/auth0/passkeycredential/id.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential"]]},"sections":[],"metadata":{"role":"symbol","symbolKind":"property","externalID":"s:5Auth017PasskeyCredentialV2idSSvp","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"id","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"title":"id","roleHeading":"Instance Property","modules":[{"name":"Auth0"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential\/id","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"text":"Unique identifier of the passkey credential.","type":"text"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"id","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"platforms":["iOS"],"languages":["swift"]}]}],"variants":[{"paths":["\/documentation\/auth0\/passkeycredential\/id"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasskeyCredential/id":{"title":"id","kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"id"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential\/id","abstract":[{"type":"text","text":"Unique identifier of the passkey credential."}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/passkeycredential\/id"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyCredential":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"PasskeyCredential"}],"type":"topic","role":"symbol","url":"\/documentation\/auth0\/passkeycredential","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasskeyCredential"}],"abstract":[{"type":"text","text":"A passkey credential."}],"title":"PasskeyCredential","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"kind":"symbol","primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"id"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}]}],"kind":"declarations"}],"variants":[{"paths":["\/documentation\/auth0\/passkeycredential\/id"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"schemaVersion":{"patch":0,"minor":3,"major":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential\/id","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Unique identifier of the passkey credential."}],"metadata":{"roleHeading":"Instance Property","symbolKind":"property","role":"symbol","title":"id","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"id"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"externalID":"s:5Auth017PasskeyCredentialV2idSSvp","modules":[{"name":"Auth0"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyCredential":{"role":"symbol","title":"PasskeyCredential","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyCredential","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"PasskeyCredential"}],"abstract":[{"text":"A passkey credential.","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/passkeycredential","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyCredential/id":{"kind":"symbol","title":"id","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"id"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential\/id","abstract":[{"type":"text","text":"Unique identifier of the passkey credential."}],"url":"\/documentation\/auth0\/passkeycredential\/id"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/passkeycredential/init(from:).json b/docs/data/documentation/auth0/passkeycredential/init(from:).json index 0693f0552..4d383e783 100644 --- a/docs/data/documentation/auth0/passkeycredential/init(from:).json +++ b/docs/data/documentation/auth0/passkeycredential/init(from:).json @@ -1 +1 @@ -{"abstract":[{"code":"Decodable","type":"codeVoice"},{"text":" initializer.","type":"text"}],"sections":[],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential"]]},"metadata":{"roleHeading":"Initializer","title":"init(from:)","extendedModule":"Auth0","role":"symbol","modules":[{"name":"Auth0"}],"externalID":"s:5Auth017PasskeyCredentialV4fromACs7Decoder_p_tKcfc","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Decoder","preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"symbolKind":"init"},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"init","kind":"keyword"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"decoder","kind":"internalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:s7DecoderP","text":"Decoder","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}]}]}],"variants":[{"paths":["\/documentation\/auth0\/passkeycredential\/init(from:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential\/init(from:)","interfaceLanguage":"swift"},"schemaVersion":{"patch":0,"major":0,"minor":3},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasskeyCredential":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"PasskeyCredential"}],"type":"topic","role":"symbol","url":"\/documentation\/auth0\/passkeycredential","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasskeyCredential"}],"abstract":[{"type":"text","text":"A passkey credential."}],"title":"PasskeyCredential","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyCredential/init(from:)":{"kind":"symbol","title":"init(from:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier","text":"Decoder"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential\/init(from:)","abstract":[{"type":"codeVoice","code":"Decodable"},{"type":"text","text":" initializer."}],"type":"topic","url":"\/documentation\/auth0\/passkeycredential\/init(from:)"}}} \ No newline at end of file +{"abstract":[{"type":"codeVoice","code":"Decodable"},{"type":"text","text":" initializer."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":" "},{"kind":"internalParam","text":"decoder"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Decoder","preciseIdentifier":"s:s7DecoderP"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"platforms":["iOS"],"languages":["swift"]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passkeycredential\/init(from:)"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential"]]},"metadata":{"modules":[{"name":"Auth0"}],"title":"init(from:)","roleHeading":"Initializer","symbolKind":"init","role":"symbol","extendedModule":"Auth0","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:s7DecoderP","text":"Decoder","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"externalID":"s:5Auth017PasskeyCredentialV4fromACs7Decoder_p_tKcfc"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential\/init(from:)","interfaceLanguage":"swift"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyCredential/init(from:)":{"url":"\/documentation\/auth0\/passkeycredential\/init(from:)","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:s7DecoderP","text":"Decoder","kind":"typeIdentifier"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"title":"init(from:)","type":"topic","role":"symbol","abstract":[{"code":"Decodable","type":"codeVoice"},{"text":" initializer.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential\/init(from:)","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyCredential":{"role":"symbol","title":"PasskeyCredential","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyCredential","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"PasskeyCredential"}],"abstract":[{"text":"A passkey credential.","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/passkeycredential","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/passkeycredential/isbackedup.json b/docs/data/documentation/auth0/passkeycredential/isbackedup.json index 982dfceb8..0cb38c3f4 100644 --- a/docs/data/documentation/auth0/passkeycredential/isbackedup.json +++ b/docs/data/documentation/auth0/passkeycredential/isbackedup.json @@ -1 +1 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential\/isBackedUp","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential"]]},"schemaVersion":{"minor":3,"patch":0,"major":0},"abstract":[{"text":"Whether the passkey credential was backed up.","type":"text"}],"sections":[],"metadata":{"externalID":"s:5Auth017PasskeyCredentialV10isBackedUpSbvp","role":"symbol","symbolKind":"property","modules":[{"name":"Auth0"}],"title":"isBackedUp","roleHeading":"Instance Property","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"isBackedUp"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}]},"kind":"symbol","primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isBackedUp","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"languages":["swift"]}],"kind":"declarations"}],"variants":[{"paths":["\/documentation\/auth0\/passkeycredential\/isbackedup"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasskeyCredential":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"PasskeyCredential"}],"type":"topic","role":"symbol","url":"\/documentation\/auth0\/passkeycredential","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasskeyCredential"}],"abstract":[{"type":"text","text":"A passkey credential."}],"title":"PasskeyCredential","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyCredential/isBackedUp":{"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"isBackedUp"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"kind":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential\/isBackedUp","title":"isBackedUp","url":"\/documentation\/auth0\/passkeycredential\/isbackedup","abstract":[{"type":"text","text":"Whether the passkey credential was backed up."}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential"]]},"schemaVersion":{"major":0,"patch":0,"minor":3},"abstract":[{"text":"Whether the passkey credential was backed up.","type":"text"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passkeycredential\/isbackedup"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential\/isBackedUp"},"sections":[],"kind":"symbol","metadata":{"roleHeading":"Instance Property","symbolKind":"property","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"isBackedUp"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"modules":[{"name":"Auth0"}],"title":"isBackedUp","externalID":"s:5Auth017PasskeyCredentialV10isBackedUpSbvp"},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"isBackedUp","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasskeyCredential":{"role":"symbol","title":"PasskeyCredential","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyCredential","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"PasskeyCredential"}],"abstract":[{"text":"A passkey credential.","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/passkeycredential","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyCredential/isBackedUp":{"role":"symbol","title":"isBackedUp","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"isBackedUp","kind":"identifier"},{"kind":"text","text":": "},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"abstract":[{"type":"text","text":"Whether the passkey credential was backed up."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential\/isBackedUp","url":"\/documentation\/auth0\/passkeycredential\/isbackedup","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/passkeycredential/publickey.json b/docs/data/documentation/auth0/passkeycredential/publickey.json index 3943f8158..b19864238 100644 --- a/docs/data/documentation/auth0/passkeycredential/publickey.json +++ b/docs/data/documentation/auth0/passkeycredential/publickey.json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"publicKey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV","text":"Data"}]}]}],"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential\/publicKey","interfaceLanguage":"swift"},"sections":[],"metadata":{"symbolKind":"property","externalID":"s:5Auth017PasskeyCredentialV9publicKey10Foundation4DataVvp","roleHeading":"Instance Property","title":"publicKey","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"publicKey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV","text":"Data"}],"modules":[{"name":"Auth0"}],"role":"symbol"},"abstract":[{"text":"Public key of the passkey credential.","type":"text"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passkeycredential\/publickey"]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasskeyCredential":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"PasskeyCredential"}],"type":"topic","role":"symbol","url":"\/documentation\/auth0\/passkeycredential","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasskeyCredential"}],"abstract":[{"type":"text","text":"A passkey credential."}],"title":"PasskeyCredential","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyCredential/publicKey":{"url":"\/documentation\/auth0\/passkeycredential\/publickey","role":"symbol","type":"topic","abstract":[{"type":"text","text":"Public key of the passkey credential."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential\/publicKey","title":"publicKey","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"publicKey","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Data","preciseIdentifier":"s:10Foundation4DataV","kind":"typeIdentifier"}]}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential"]]},"metadata":{"symbolKind":"property","modules":[{"name":"Auth0"}],"title":"publicKey","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"publicKey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV","text":"Data"}],"externalID":"s:5Auth017PasskeyCredentialV9publicKey10Foundation4DataVvp","role":"symbol","roleHeading":"Instance Property"},"sections":[],"abstract":[{"type":"text","text":"Public key of the passkey credential."}],"variants":[{"paths":["\/documentation\/auth0\/passkeycredential\/publickey"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential\/publicKey","interfaceLanguage":"swift"},"kind":"symbol","schemaVersion":{"minor":3,"patch":0,"major":0},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"publicKey"},{"kind":"text","text":": "},{"text":"Data","preciseIdentifier":"s:10Foundation4DataV","kind":"typeIdentifier"}]}],"kind":"declarations"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasskeyCredential/publicKey":{"title":"publicKey","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential\/publicKey","type":"topic","role":"symbol","kind":"symbol","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"publicKey"},{"kind":"text","text":": "},{"text":"Data","preciseIdentifier":"s:10Foundation4DataV","kind":"typeIdentifier"}],"abstract":[{"type":"text","text":"Public key of the passkey credential."}],"url":"\/documentation\/auth0\/passkeycredential\/publickey"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyCredential":{"role":"symbol","title":"PasskeyCredential","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyCredential","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"PasskeyCredential"}],"abstract":[{"text":"A passkey credential.","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/passkeycredential","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/passkeycredential/userhandle.json b/docs/data/documentation/auth0/passkeycredential/userhandle.json index 6d10893a1..6099300d2 100644 --- a/docs/data/documentation/auth0/passkeycredential/userhandle.json +++ b/docs/data/documentation/auth0/passkeycredential/userhandle.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential"]]},"abstract":[{"text":"User handle associated with the passkey credential.","type":"text"}],"sections":[],"metadata":{"symbolKind":"property","role":"symbol","title":"userHandle","externalID":"s:5Auth017PasskeyCredentialV10userHandle10Foundation4DataVvp","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"userHandle"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV","text":"Data"}],"modules":[{"name":"Auth0"}],"roleHeading":"Instance Property"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential\/userHandle"},"kind":"symbol","primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"userHandle","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation4DataV","text":"Data","kind":"typeIdentifier"}],"platforms":["iOS"]}],"kind":"declarations"}],"variants":[{"paths":["\/documentation\/auth0\/passkeycredential\/userhandle"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasskeyCredential":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"PasskeyCredential"}],"type":"topic","role":"symbol","url":"\/documentation\/auth0\/passkeycredential","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasskeyCredential"}],"abstract":[{"type":"text","text":"A passkey credential."}],"title":"PasskeyCredential","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyCredential/userHandle":{"kind":"symbol","abstract":[{"text":"User handle associated with the passkey credential.","type":"text"}],"title":"userHandle","type":"topic","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"userHandle","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation4DataV","text":"Data","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential\/userHandle","url":"\/documentation\/auth0\/passkeycredential\/userhandle"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"abstract":[{"type":"text","text":"User handle associated with the passkey credential."}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"userHandle","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Data","preciseIdentifier":"s:10Foundation4DataV","kind":"typeIdentifier"}]}],"kind":"declarations"}],"variants":[{"paths":["\/documentation\/auth0\/passkeycredential\/userhandle"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential"]]},"metadata":{"modules":[{"name":"Auth0"}],"symbolKind":"property","roleHeading":"Instance Property","title":"userHandle","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"userHandle","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Data","preciseIdentifier":"s:10Foundation4DataV","kind":"typeIdentifier"}],"externalID":"s:5Auth017PasskeyCredentialV10userHandle10Foundation4DataVvp"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential\/userHandle"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyCredential/userHandle":{"kind":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"userHandle","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Data","preciseIdentifier":"s:10Foundation4DataV","kind":"typeIdentifier"}],"title":"userHandle","type":"topic","role":"symbol","abstract":[{"type":"text","text":"User handle associated with the passkey credential."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential\/userHandle","url":"\/documentation\/auth0\/passkeycredential\/userhandle"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyCredential":{"role":"symbol","title":"PasskeyCredential","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyCredential","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"PasskeyCredential"}],"abstract":[{"text":"A passkey credential.","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/passkeycredential","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyCredential","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/passkeydevicetype.json b/docs/data/documentation/auth0/passkeydevicetype.json index 9b1d7db76..b5ee2a95c 100644 --- a/docs/data/documentation/auth0/passkeydevicetype.json +++ b/docs/data/documentation/auth0/passkeydevicetype.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"metadata":{"modules":[{"name":"Auth0"}],"roleHeading":"Enumeration","symbolKind":"enum","navigatorTitle":[{"text":"PasskeyDeviceType","kind":"identifier"}],"title":"PasskeyDeviceType","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyDeviceType","kind":"identifier"}],"role":"symbol","externalID":"s:5Auth017PasskeyDeviceTypeO"},"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType"},"abstract":[{"text":"Kind of device the passkey is stored on as defined by backup eligibility.","type":"text"}],"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType\/multiDevice","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType\/singleDevice"],"title":"Enumeration Cases","generated":true,"anchor":"Enumeration-Cases"},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType\/init(rawValue:)"],"title":"Initializers","generated":true,"anchor":"Initializers"},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType\/Equatable-Implementations","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType\/RawRepresentable-Implementations"],"title":"Default Implementations","generated":true,"anchor":"Default-Implementations"}],"relationshipsSections":[{"type":"conformsTo","identifiers":["doc:\/\/com.auth0.Auth0\/Se","doc:\/\/com.auth0.Auth0\/SQ","doc:\/\/com.auth0.Auth0\/SH","doc:\/\/com.auth0.Auth0\/SY","doc:\/\/com.auth0.Auth0\/s8SendableP","doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP"],"kind":"relationships","title":"Conforms To"}],"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasskeyDeviceType"}]}],"kind":"declarations"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passkeydevicetype"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasskeyDeviceType/Equatable-Implementations":{"url":"\/documentation\/auth0\/passkeydevicetype\/equatable-implementations","title":"Equatable Implementations","abstract":[],"type":"topic","kind":"article","role":"collectionGroup","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType\/Equatable-Implementations"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyDeviceType/init(rawValue:)":{"kind":"symbol","abstract":[],"type":"topic","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType\/init(rawValue:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"?("},{"kind":"externalParam","text":"rawValue"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":")"}],"url":"\/documentation\/auth0\/passkeydevicetype\/init(rawvalue:)","title":"init(rawValue:)"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyDeviceType/singleDevice":{"type":"topic","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"singleDevice","kind":"identifier"}],"url":"\/documentation\/auth0\/passkeydevicetype\/singledevice","title":"PasskeyDeviceType.singleDevice","role":"symbol","abstract":[{"text":"Passkey that cannot be backed up and synced to another device.","type":"text"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType\/singleDevice"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyDeviceType/multiDevice":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType\/multiDevice","abstract":[{"text":"Passkey that can be backed up and synced to another device, when enabled by the user.","type":"text"}],"url":"\/documentation\/auth0\/passkeydevicetype\/multidevice","title":"PasskeyDeviceType.multiDevice","role":"symbol","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"multiDevice"}],"type":"topic"},"doc://com.auth0.Auth0/s16SendableMetatypeP":{"type":"unresolvable","title":"Swift.SendableMetatype","identifier":"doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP"},"doc://com.auth0.Auth0/s8SendableP":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s8SendableP","title":"Swift.Sendable"},"doc://com.auth0.Auth0/SH":{"type":"unresolvable","title":"Swift.Hashable","identifier":"doc:\/\/com.auth0.Auth0\/SH"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyDeviceType/RawRepresentable-Implementations":{"kind":"article","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType\/RawRepresentable-Implementations","abstract":[],"url":"\/documentation\/auth0\/passkeydevicetype\/rawrepresentable-implementations","title":"RawRepresentable Implementations","role":"collectionGroup","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyDeviceType":{"type":"topic","kind":"symbol","url":"\/documentation\/auth0\/passkeydevicetype","abstract":[{"text":"Kind of device the passkey is stored on as defined by backup eligibility.","type":"text"}],"role":"symbol","title":"PasskeyDeviceType","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyDeviceType","kind":"identifier"}],"navigatorTitle":[{"text":"PasskeyDeviceType","kind":"identifier"}]},"doc://com.auth0.Auth0/Se":{"type":"unresolvable","title":"Swift.Decodable","identifier":"doc:\/\/com.auth0.Auth0\/Se"},"doc://com.auth0.Auth0/SQ":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/SQ","title":"Swift.Equatable"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/SY":{"type":"unresolvable","title":"Swift.RawRepresentable","identifier":"doc:\/\/com.auth0.Auth0\/SY"}}} \ No newline at end of file +{"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"text":"PasskeyDeviceType","kind":"identifier"}],"platforms":["iOS"]}]}],"relationshipsSections":[{"title":"Conforms To","identifiers":["doc:\/\/com.auth0.Auth0\/Se","doc:\/\/com.auth0.Auth0\/SQ","doc:\/\/com.auth0.Auth0\/SH","doc:\/\/com.auth0.Auth0\/SY","doc:\/\/com.auth0.Auth0\/s8SendableP","doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP"],"type":"conformsTo","kind":"relationships"}],"topicSections":[{"title":"Enumeration Cases","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType\/multiDevice","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType\/singleDevice"],"anchor":"Enumeration-Cases","generated":true},{"title":"Initializers","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType\/init(rawValue:)"],"anchor":"Initializers","generated":true},{"title":"Default Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType\/Equatable-Implementations","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType\/RawRepresentable-Implementations"],"anchor":"Default-Implementations","generated":true}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passkeydevicetype"]}],"sections":[],"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\/PasskeyDeviceType"},"abstract":[{"text":"Kind of device the passkey is stored on as defined by backup eligibility.","type":"text"}],"metadata":{"roleHeading":"Enumeration","navigatorTitle":[{"text":"PasskeyDeviceType","kind":"identifier"}],"symbolKind":"enum","role":"symbol","title":"PasskeyDeviceType","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasskeyDeviceType"}],"externalID":"s:5Auth017PasskeyDeviceTypeO","modules":[{"name":"Auth0"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasskeyDeviceType/multiDevice":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType\/multiDevice","type":"topic","title":"PasskeyDeviceType.multiDevice","role":"symbol","kind":"symbol","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"multiDevice","kind":"identifier"}],"abstract":[{"type":"text","text":"Passkey that can be backed up and synced to another device, when enabled by the user."}],"url":"\/documentation\/auth0\/passkeydevicetype\/multidevice"},"doc://com.auth0.Auth0/SH":{"type":"unresolvable","title":"Swift.Hashable","identifier":"doc:\/\/com.auth0.Auth0\/SH"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyDeviceType/init(rawValue:)":{"title":"init(rawValue:)","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType\/init(rawValue:)","role":"symbol","kind":"symbol","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"?("},{"kind":"externalParam","text":"rawValue"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":")"}],"abstract":[],"url":"\/documentation\/auth0\/passkeydevicetype\/init(rawvalue:)"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyDeviceType/Equatable-Implementations":{"kind":"article","title":"Equatable Implementations","role":"collectionGroup","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType\/Equatable-Implementations","abstract":[],"url":"\/documentation\/auth0\/passkeydevicetype\/equatable-implementations"},"doc://com.auth0.Auth0/SY":{"title":"Swift.RawRepresentable","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/SY"},"doc://com.auth0.Auth0/SQ":{"title":"Swift.Equatable","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/SQ"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/s8SendableP":{"title":"Swift.Sendable","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s8SendableP"},"doc://com.auth0.Auth0/s16SendableMetatypeP":{"title":"Swift.SendableMetatype","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyDeviceType/RawRepresentable-Implementations":{"kind":"article","title":"RawRepresentable Implementations","role":"collectionGroup","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType\/RawRepresentable-Implementations","abstract":[],"url":"\/documentation\/auth0\/passkeydevicetype\/rawrepresentable-implementations"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyDeviceType/singleDevice":{"type":"topic","abstract":[{"type":"text","text":"Passkey that cannot be backed up and synced to another device."}],"kind":"symbol","title":"PasskeyDeviceType.singleDevice","url":"\/documentation\/auth0\/passkeydevicetype\/singledevice","role":"symbol","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"singleDevice","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType\/singleDevice"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyDeviceType":{"navigatorTitle":[{"kind":"identifier","text":"PasskeyDeviceType"}],"kind":"symbol","url":"\/documentation\/auth0\/passkeydevicetype","role":"symbol","abstract":[{"text":"Kind of device the passkey is stored on as defined by backup eligibility.","type":"text"}],"type":"topic","fragments":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"text":"PasskeyDeviceType","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType","title":"PasskeyDeviceType"},"doc://com.auth0.Auth0/Se":{"title":"Swift.Decodable","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/Se"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/passkeydevicetype/!=(_:_:).json b/docs/data/documentation/auth0/passkeydevicetype/!=(_:_:).json index 986eff023..3b93e545e 100644 --- a/docs/data/documentation/auth0/passkeydevicetype/!=(_:_:).json +++ b/docs/data/documentation/auth0/passkeydevicetype/!=(_:_:).json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType"]]},"metadata":{"externalID":"s:SQsE2neoiySbx_xtFZ::SYNTHESIZED::s:5Auth017PasskeyDeviceTypeO","extendedModule":"Swift","title":"!=(_:_:)","modules":[{"relatedModules":["Swift"],"name":"Auth0"}],"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","text":"Self"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"symbolKind":"op","roleHeading":"Operator","role":"symbol"},"kind":"symbol","abstract":[{"text":"Inherited from ","type":"text"},{"code":"Equatable.!=(_:_:)","type":"codeVoice"},{"text":".","type":"text"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType\/!=(_:_:)"},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"lhs","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"internalParam","text":"rhs"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}]}],"kind":"declarations"}],"schemaVersion":{"minor":3,"patch":0,"major":0},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passkeydevicetype\/!=(_:_:)"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasskeyDeviceType/!=(_:_:)":{"title":"!=(_:_:)","role":"symbol","abstract":[],"type":"topic","url":"\/documentation\/auth0\/passkeydevicetype\/!=(_:_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType\/!=(_:_:)","kind":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}]},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyDeviceType":{"type":"topic","kind":"symbol","url":"\/documentation\/auth0\/passkeydevicetype","abstract":[{"text":"Kind of device the passkey is stored on as defined by backup eligibility.","type":"text"}],"role":"symbol","title":"PasskeyDeviceType","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyDeviceType","kind":"identifier"}],"navigatorTitle":[{"text":"PasskeyDeviceType","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"Equatable.!=(_:_:)"},{"type":"text","text":"."}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"!="},{"kind":"text","text":" "},{"kind":"text","text":"("},{"kind":"internalParam","text":"lhs"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":", "},{"kind":"internalParam","text":"rhs"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}]}],"kind":"declarations"}],"variants":[{"paths":["\/documentation\/auth0\/passkeydevicetype\/!=(_:_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType"]]},"metadata":{"modules":[{"relatedModules":["Swift"],"name":"Auth0"}],"title":"!=(_:_:)","roleHeading":"Operator","symbolKind":"op","role":"symbol","extendedModule":"Swift","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","text":"Self"},{"text":", ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"externalID":"s:SQsE2neoiySbx_xtFZ::SYNTHESIZED::s:5Auth017PasskeyDeviceTypeO"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType\/!=(_:_:)","interfaceLanguage":"swift"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/PasskeyDeviceType/!=(_:_:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType\/!=(_:_:)","kind":"symbol","title":"!=(_:_:)","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"!="},{"kind":"text","text":" "},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"role":"symbol","url":"\/documentation\/auth0\/passkeydevicetype\/!=(_:_:)","abstract":[],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyDeviceType":{"navigatorTitle":[{"kind":"identifier","text":"PasskeyDeviceType"}],"kind":"symbol","url":"\/documentation\/auth0\/passkeydevicetype","role":"symbol","abstract":[{"text":"Kind of device the passkey is stored on as defined by backup eligibility.","type":"text"}],"type":"topic","fragments":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"text":"PasskeyDeviceType","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType","title":"PasskeyDeviceType"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/passkeydevicetype/equatable-implementations.json b/docs/data/documentation/auth0/passkeydevicetype/equatable-implementations.json index 8ad181e74..d5e4e0159 100644 --- a/docs/data/documentation/auth0/passkeydevicetype/equatable-implementations.json +++ b/docs/data/documentation/auth0/passkeydevicetype/equatable-implementations.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType"]]},"kind":"article","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType\/Equatable-Implementations","interfaceLanguage":"swift"},"sections":[],"topicSections":[{"generated":true,"title":"Operators","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType\/!=(_:_:)"],"anchor":"Operators"}],"metadata":{"title":"Equatable Implementations","modules":[{"name":"Auth0"}],"roleHeading":"API Collection","role":"collectionGroup"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passkeydevicetype\/equatable-implementations"]}],"schemaVersion":{"patch":0,"minor":3,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasskeyDeviceType/!=(_:_:)":{"title":"!=(_:_:)","role":"symbol","abstract":[],"type":"topic","url":"\/documentation\/auth0\/passkeydevicetype\/!=(_:_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType\/!=(_:_:)","kind":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyDeviceType":{"type":"topic","kind":"symbol","url":"\/documentation\/auth0\/passkeydevicetype","abstract":[{"text":"Kind of device the passkey is stored on as defined by backup eligibility.","type":"text"}],"role":"symbol","title":"PasskeyDeviceType","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyDeviceType","kind":"identifier"}],"navigatorTitle":[{"text":"PasskeyDeviceType","kind":"identifier"}]}}} \ No newline at end of file +{"topicSections":[{"title":"Operators","generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType\/!=(_:_:)"],"anchor":"Operators"}],"kind":"article","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType\/Equatable-Implementations","interfaceLanguage":"swift"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passkeydevicetype\/equatable-implementations"]}],"sections":[],"metadata":{"roleHeading":"API Collection","role":"collectionGroup","title":"Equatable Implementations","modules":[{"name":"Auth0"}]},"schemaVersion":{"minor":3,"major":0,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasskeyDeviceType":{"navigatorTitle":[{"kind":"identifier","text":"PasskeyDeviceType"}],"kind":"symbol","url":"\/documentation\/auth0\/passkeydevicetype","role":"symbol","abstract":[{"text":"Kind of device the passkey is stored on as defined by backup eligibility.","type":"text"}],"type":"topic","fragments":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"text":"PasskeyDeviceType","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType","title":"PasskeyDeviceType"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyDeviceType/!=(_:_:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType\/!=(_:_:)","kind":"symbol","title":"!=(_:_:)","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"!="},{"kind":"text","text":" "},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"role":"symbol","url":"\/documentation\/auth0\/passkeydevicetype\/!=(_:_:)","abstract":[],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/passkeydevicetype/hash(into:).json b/docs/data/documentation/auth0/passkeydevicetype/hash(into:).json index 198abbf04..1b1bab971 100644 --- a/docs/data/documentation/auth0/passkeydevicetype/hash(into:).json +++ b/docs/data/documentation/auth0/passkeydevicetype/hash(into:).json @@ -1 +1 @@ -{"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"hash"},{"kind":"text","text":"("},{"kind":"externalParam","text":"into"},{"kind":"text","text":" "},{"kind":"internalParam","text":"hasher"},{"kind":"text","text":": "},{"kind":"keyword","text":"inout"},{"kind":"text","text":" "},{"kind":"typeIdentifier","text":"Hasher","preciseIdentifier":"s:s6HasherV"},{"kind":"text","text":")"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"metadata":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"hash","kind":"identifier"},{"text":"(","kind":"text"},{"text":"into","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"inout","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Hasher","preciseIdentifier":"s:s6HasherV","kind":"typeIdentifier"},{"text":")","kind":"text"}],"externalID":"s:SYsSHRzSH8RawValueSYRpzrlE4hash4intoys6HasherVz_tF::SYNTHESIZED::s:5Auth017PasskeyDeviceTypeO","conformance":{"conformancePrefix":[{"type":"text","text":"Conforms when"}],"availabilityPrefix":[{"type":"text","text":"Available when"}],"constraints":[{"code":"Self","type":"codeVoice"},{"type":"text","text":" conforms to "},{"code":"Hashable","type":"codeVoice"},{"type":"text","text":" and "},{"code":"RawValue","type":"codeVoice"},{"type":"text","text":" conforms to "},{"code":"Hashable","type":"codeVoice"},{"type":"text","text":"."}]},"title":"hash(into:)","role":"symbol","extendedModule":"Swift","symbolKind":"method","roleHeading":"Instance Method","modules":[{"relatedModules":["Swift"],"name":"Auth0"}]},"sections":[],"schemaVersion":{"minor":3,"major":0,"patch":0},"variants":[{"paths":["\/documentation\/auth0\/passkeydevicetype\/hash(into:)"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType\/hash(into:)","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"RawRepresentable.hash(into:)"},{"type":"text","text":"."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasskeyDeviceType":{"type":"topic","kind":"symbol","url":"\/documentation\/auth0\/passkeydevicetype","abstract":[{"text":"Kind of device the passkey is stored on as defined by backup eligibility.","type":"text"}],"role":"symbol","title":"PasskeyDeviceType","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyDeviceType","kind":"identifier"}],"navigatorTitle":[{"text":"PasskeyDeviceType","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyDeviceType/hash(into:)":{"kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"hash"},{"kind":"text","text":"("},{"kind":"externalParam","text":"into"},{"kind":"text","text":": "},{"kind":"keyword","text":"inout"},{"kind":"text","text":" "},{"preciseIdentifier":"s:s6HasherV","kind":"typeIdentifier","text":"Hasher"},{"kind":"text","text":")"}],"title":"hash(into:)","url":"\/documentation\/auth0\/passkeydevicetype\/hash(into:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType\/hash(into:)","conformance":{"conformancePrefix":[{"text":"Conforms when","type":"text"}],"availabilityPrefix":[{"text":"Available when","type":"text"}],"constraints":[{"type":"codeVoice","code":"Self"},{"text":" conforms to ","type":"text"},{"type":"codeVoice","code":"Hashable"},{"text":" and ","type":"text"},{"type":"codeVoice","code":"RawValue"},{"text":" conforms to ","type":"text"},{"type":"codeVoice","code":"Hashable"},{"text":".","type":"text"}]},"type":"topic","abstract":[]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType"]]},"metadata":{"roleHeading":"Instance Method","symbolKind":"method","modules":[{"relatedModules":["Swift"],"name":"Auth0"}],"title":"hash(into:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"hash"},{"kind":"text","text":"("},{"kind":"externalParam","text":"into"},{"kind":"text","text":": "},{"kind":"keyword","text":"inout"},{"kind":"text","text":" "},{"preciseIdentifier":"s:s6HasherV","kind":"typeIdentifier","text":"Hasher"},{"kind":"text","text":")"}],"externalID":"s:SYsSHRzSH8RawValueSYRpzrlE4hash4intoys6HasherVz_tF::SYNTHESIZED::s:5Auth017PasskeyDeviceTypeO","role":"symbol","conformance":{"constraints":[{"type":"codeVoice","code":"Self"},{"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":"."}],"conformancePrefix":[{"type":"text","text":"Conforms when"}],"availabilityPrefix":[{"type":"text","text":"Available when"}]},"extendedModule":"Swift"},"sections":[],"abstract":[{"type":"text","text":"Inherited from "},{"code":"RawRepresentable.hash(into:)","type":"codeVoice"},{"type":"text","text":"."}],"variants":[{"paths":["\/documentation\/auth0\/passkeydevicetype\/hash(into:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType\/hash(into:)"},"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"hash"},{"kind":"text","text":"("},{"kind":"externalParam","text":"into"},{"kind":"text","text":" "},{"kind":"internalParam","text":"hasher"},{"kind":"text","text":": "},{"kind":"keyword","text":"inout"},{"kind":"text","text":" "},{"kind":"typeIdentifier","preciseIdentifier":"s:s6HasherV","text":"Hasher"},{"kind":"text","text":")"}]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasskeyDeviceType/hash(into:)":{"url":"\/documentation\/auth0\/passkeydevicetype\/hash(into:)","title":"hash(into:)","abstract":[],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"hash"},{"kind":"text","text":"("},{"kind":"externalParam","text":"into"},{"kind":"text","text":": "},{"kind":"keyword","text":"inout"},{"kind":"text","text":" "},{"kind":"typeIdentifier","text":"Hasher","preciseIdentifier":"s:s6HasherV"},{"kind":"text","text":")"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType\/hash(into:)","role":"symbol","kind":"symbol","conformance":{"constraints":[{"type":"codeVoice","code":"Self"},{"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"}]},"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyDeviceType":{"navigatorTitle":[{"kind":"identifier","text":"PasskeyDeviceType"}],"kind":"symbol","url":"\/documentation\/auth0\/passkeydevicetype","role":"symbol","abstract":[{"text":"Kind of device the passkey is stored on as defined by backup eligibility.","type":"text"}],"type":"topic","fragments":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"text":"PasskeyDeviceType","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType","title":"PasskeyDeviceType"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/passkeydevicetype/hashvalue.json b/docs/data/documentation/auth0/passkeydevicetype/hashvalue.json index a97a5c709..7890afa98 100644 --- a/docs/data/documentation/auth0/passkeydevicetype/hashvalue.json +++ b/docs/data/documentation/auth0/passkeydevicetype/hashvalue.json @@ -1 +1 @@ -{"schemaVersion":{"patch":0,"major":0,"minor":3},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType\/hashValue","interfaceLanguage":"swift"},"metadata":{"symbolKind":"property","extendedModule":"Swift","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"hashValue","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"}],"roleHeading":"Instance Property","role":"symbol","modules":[{"name":"Auth0","relatedModules":["Swift"]}],"conformance":{"constraints":[{"type":"codeVoice","code":"Self"},{"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"}]},"title":"hashValue","externalID":"s:SYsSHRzSH8RawValueSYRpzrlE04hashB0Sivp::SYNTHESIZED::s:5Auth017PasskeyDeviceTypeO"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType"]]},"variants":[{"paths":["\/documentation\/auth0\/passkeydevicetype\/hashvalue"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"kind":"symbol","abstract":[{"text":"Inherited from ","type":"text"},{"code":"RawRepresentable.hashValue","type":"codeVoice"},{"text":".","type":"text"}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"hashValue","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Int","preciseIdentifier":"s:Si","kind":"typeIdentifier"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}]}],"kind":"declarations"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyDeviceType":{"type":"topic","kind":"symbol","url":"\/documentation\/auth0\/passkeydevicetype","abstract":[{"text":"Kind of device the passkey is stored on as defined by backup eligibility.","type":"text"}],"role":"symbol","title":"PasskeyDeviceType","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyDeviceType","kind":"identifier"}],"navigatorTitle":[{"text":"PasskeyDeviceType","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyDeviceType/hashValue":{"title":"hashValue","abstract":[],"url":"\/documentation\/auth0\/passkeydevicetype\/hashvalue","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType\/hashValue","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"hashValue"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"}],"role":"symbol","conformance":{"conformancePrefix":[{"type":"text","text":"Conforms when"}],"constraints":[{"type":"codeVoice","code":"Self"},{"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"}]},"type":"topic"}}} \ No newline at end of file +{"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType\/hashValue"},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"hashValue"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passkeydevicetype\/hashvalue"]}],"kind":"symbol","metadata":{"roleHeading":"Instance Property","symbolKind":"property","modules":[{"name":"Auth0","relatedModules":["Swift"]}],"title":"hashValue","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"hashValue"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"}],"externalID":"s:SYsSHRzSH8RawValueSYRpzrlE04hashB0Sivp::SYNTHESIZED::s:5Auth017PasskeyDeviceTypeO","role":"symbol","conformance":{"constraints":[{"code":"Self","type":"codeVoice"},{"text":" conforms to ","type":"text"},{"code":"Hashable","type":"codeVoice"},{"text":" and ","type":"text"},{"code":"RawValue","type":"codeVoice"},{"text":" conforms to ","type":"text"},{"code":"Hashable","type":"codeVoice"},{"text":".","type":"text"}],"conformancePrefix":[{"text":"Conforms when","type":"text"}],"availabilityPrefix":[{"text":"Available when","type":"text"}]},"extendedModule":"Swift"},"schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"RawRepresentable.hashValue"},{"type":"text","text":"."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasskeyDeviceType/hashValue":{"title":"hashValue","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType\/hashValue","type":"topic","role":"symbol","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"hashValue","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Int","preciseIdentifier":"s:Si","kind":"typeIdentifier"}],"abstract":[],"conformance":{"availabilityPrefix":[{"type":"text","text":"Available when"}],"constraints":[{"type":"codeVoice","code":"Self"},{"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":"."}],"conformancePrefix":[{"type":"text","text":"Conforms when"}]},"url":"\/documentation\/auth0\/passkeydevicetype\/hashvalue"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyDeviceType":{"navigatorTitle":[{"kind":"identifier","text":"PasskeyDeviceType"}],"kind":"symbol","url":"\/documentation\/auth0\/passkeydevicetype","role":"symbol","abstract":[{"text":"Kind of device the passkey is stored on as defined by backup eligibility.","type":"text"}],"type":"topic","fragments":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"text":"PasskeyDeviceType","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType","title":"PasskeyDeviceType"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/passkeydevicetype/init(from:).json b/docs/data/documentation/auth0/passkeydevicetype/init(from:).json index 1b31dc0a9..65d64f3bb 100644 --- a/docs/data/documentation/auth0/passkeydevicetype/init(from:).json +++ b/docs/data/documentation/auth0/passkeydevicetype/init(from:).json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"init","kind":"keyword"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"decoder","kind":"internalParam"},{"text":": any ","kind":"text"},{"text":"Decoder","kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"languages":["swift"]}]}],"sections":[],"kind":"symbol","schemaVersion":{"patch":0,"major":0,"minor":3},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType\/init(from:)","interfaceLanguage":"swift"},"metadata":{"title":"init(from:)","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":": any ","kind":"text"},{"text":"Decoder","preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"extendedModule":"Swift","externalID":"s:SYsSeRzSS8RawValueSYRtzrlE4fromxs7Decoder_p_tKcfc::SYNTHESIZED::s:5Auth017PasskeyDeviceTypeO","role":"symbol","modules":[{"name":"Auth0","relatedModules":["Swift"]}],"conformance":{"constraints":[{"type":"codeVoice","code":"Self"},{"type":"text","text":" conforms to "},{"type":"codeVoice","code":"Decodable"},{"type":"text","text":" and "},{"type":"codeVoice","code":"RawValue"},{"type":"text","text":" is "},{"code":"String","type":"codeVoice"},{"text":".","type":"text"}],"availabilityPrefix":[{"type":"text","text":"Available when"}],"conformancePrefix":[{"type":"text","text":"Conforms when"}]},"roleHeading":"Initializer","symbolKind":"init"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passkeydevicetype\/init(from:)"]}],"abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"RawRepresentable.init(from:)"},{"type":"text","text":"."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasskeyDeviceType/init(from:)":{"kind":"symbol","abstract":[],"type":"topic","title":"init(from:)","role":"symbol","url":"\/documentation\/auth0\/passkeydevicetype\/init(from:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": any "},{"preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier","text":"Decoder"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType\/init(from:)","conformance":{"conformancePrefix":[{"text":"Conforms when","type":"text"}],"constraints":[{"code":"Self","type":"codeVoice"},{"text":" conforms to ","type":"text"},{"code":"Decodable","type":"codeVoice"},{"text":" and ","type":"text"},{"code":"RawValue","type":"codeVoice"},{"text":" is ","type":"text"},{"code":"String","type":"codeVoice"},{"text":".","type":"text"}],"availabilityPrefix":[{"text":"Available when","type":"text"}]}},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyDeviceType":{"type":"topic","kind":"symbol","url":"\/documentation\/auth0\/passkeydevicetype","abstract":[{"text":"Kind of device the passkey is stored on as defined by backup eligibility.","type":"text"}],"role":"symbol","title":"PasskeyDeviceType","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyDeviceType","kind":"identifier"}],"navigatorTitle":[{"text":"PasskeyDeviceType","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"sections":[],"kind":"symbol","metadata":{"modules":[{"name":"Auth0","relatedModules":["Swift"]}],"externalID":"s:SYsSeRzSS8RawValueSYRtzrlE4fromxs7Decoder_p_tKcfc::SYNTHESIZED::s:5Auth017PasskeyDeviceTypeO","title":"init(from:)","extendedModule":"Swift","roleHeading":"Initializer","conformance":{"availabilityPrefix":[{"text":"Available when","type":"text"}],"conformancePrefix":[{"text":"Conforms when","type":"text"}],"constraints":[{"code":"Self","type":"codeVoice"},{"text":" conforms to ","type":"text"},{"code":"Decodable","type":"codeVoice"},{"text":" and ","type":"text"},{"code":"RawValue","type":"codeVoice"},{"text":" is ","type":"text"},{"code":"String","type":"codeVoice"},{"text":".","type":"text"}]},"fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": any "},{"kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP","text":"Decoder"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"role":"symbol","symbolKind":"init"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType\/init(from:)","interfaceLanguage":"swift"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passkeydevicetype\/init(from:)"]}],"schemaVersion":{"patch":0,"minor":3,"major":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"init","kind":"keyword"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"decoder","kind":"internalParam"},{"text":": any ","kind":"text"},{"text":"Decoder","preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"platforms":["iOS"],"languages":["swift"]}]}],"abstract":[{"type":"text","text":"Inherited from "},{"code":"RawRepresentable.init(from:)","type":"codeVoice"},{"type":"text","text":"."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyDeviceType":{"navigatorTitle":[{"kind":"identifier","text":"PasskeyDeviceType"}],"kind":"symbol","url":"\/documentation\/auth0\/passkeydevicetype","role":"symbol","abstract":[{"text":"Kind of device the passkey is stored on as defined by backup eligibility.","type":"text"}],"type":"topic","fragments":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"text":"PasskeyDeviceType","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType","title":"PasskeyDeviceType"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyDeviceType/init(from:)":{"type":"topic","abstract":[],"kind":"symbol","title":"init(from:)","url":"\/documentation\/auth0\/passkeydevicetype\/init(from:)","role":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":": any ","kind":"text"},{"preciseIdentifier":"s:s7DecoderP","text":"Decoder","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"conformance":{"constraints":[{"type":"codeVoice","code":"Self"},{"type":"text","text":" conforms to "},{"code":"Decodable","type":"codeVoice"},{"type":"text","text":" and "},{"type":"codeVoice","code":"RawValue"},{"type":"text","text":" is "},{"type":"codeVoice","code":"String"},{"type":"text","text":"."}],"availabilityPrefix":[{"text":"Available when","type":"text"}],"conformancePrefix":[{"type":"text","text":"Conforms when"}]},"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType\/init(from:)"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/passkeydevicetype/init(rawvalue:).json b/docs/data/documentation/auth0/passkeydevicetype/init(rawvalue:).json index 749818ee7..158ab1d0b 100644 --- a/docs/data/documentation/auth0/passkeydevicetype/init(rawvalue:).json +++ b/docs/data/documentation/auth0/passkeydevicetype/init(rawvalue:).json @@ -1 +1 @@ -{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType\/init(rawValue:)"},"sections":[],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"init","kind":"keyword"},{"text":"?(","kind":"text"},{"text":"rawValue","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":")","kind":"text"}]}]}],"abstract":[{"text":"Inherited from ","type":"text"},{"code":"RawRepresentable.init(rawValue:)","type":"codeVoice"},{"text":".","type":"text"}],"metadata":{"externalID":"s:5Auth017PasskeyDeviceTypeO8rawValueACSgSS_tcfc","symbolKind":"init","fragments":[{"text":"init","kind":"identifier"},{"text":"?(","kind":"text"},{"text":"rawValue","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":")","kind":"text"}],"modules":[{"name":"Auth0"}],"roleHeading":"Initializer","role":"symbol","title":"init(rawValue:)"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passkeydevicetype\/init(rawvalue:)"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasskeyDeviceType":{"type":"topic","kind":"symbol","url":"\/documentation\/auth0\/passkeydevicetype","abstract":[{"text":"Kind of device the passkey is stored on as defined by backup eligibility.","type":"text"}],"role":"symbol","title":"PasskeyDeviceType","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyDeviceType","kind":"identifier"}],"navigatorTitle":[{"text":"PasskeyDeviceType","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyDeviceType/init(rawValue:)":{"kind":"symbol","abstract":[],"type":"topic","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType\/init(rawValue:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"?("},{"kind":"externalParam","text":"rawValue"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":")"}],"url":"\/documentation\/auth0\/passkeydevicetype\/init(rawvalue:)","title":"init(rawValue:)"}}} \ No newline at end of file +{"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType\/init(rawValue:)","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"init"},{"kind":"text","text":"?("},{"kind":"externalParam","text":"rawValue"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":")"}]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passkeydevicetype\/init(rawvalue:)"]}],"kind":"symbol","metadata":{"modules":[{"name":"Auth0"}],"title":"init(rawValue:)","externalID":"s:5Auth017PasskeyDeviceTypeO8rawValueACSgSS_tcfc","role":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"?(","kind":"text"},{"text":"rawValue","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":")","kind":"text"}],"symbolKind":"init","roleHeading":"Initializer"},"schemaVersion":{"minor":3,"major":0,"patch":0},"abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"RawRepresentable.init(rawValue:)"},{"type":"text","text":"."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyDeviceType":{"navigatorTitle":[{"kind":"identifier","text":"PasskeyDeviceType"}],"kind":"symbol","url":"\/documentation\/auth0\/passkeydevicetype","role":"symbol","abstract":[{"text":"Kind of device the passkey is stored on as defined by backup eligibility.","type":"text"}],"type":"topic","fragments":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"text":"PasskeyDeviceType","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType","title":"PasskeyDeviceType"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyDeviceType/init(rawValue:)":{"title":"init(rawValue:)","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType\/init(rawValue:)","role":"symbol","kind":"symbol","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"?("},{"kind":"externalParam","text":"rawValue"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":")"}],"abstract":[],"url":"\/documentation\/auth0\/passkeydevicetype\/init(rawvalue:)"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/passkeydevicetype/multidevice.json b/docs/data/documentation/auth0/passkeydevicetype/multidevice.json index e0fdba38a..145096940 100644 --- a/docs/data/documentation/auth0/passkeydevicetype/multidevice.json +++ b/docs/data/documentation/auth0/passkeydevicetype/multidevice.json @@ -1 +1 @@ -{"schemaVersion":{"minor":3,"patch":0,"major":0},"sections":[],"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"multiDevice","kind":"identifier"}]}]}],"abstract":[{"type":"text","text":"Passkey that can be backed up and synced to another device, when enabled by the user."}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType\/multiDevice","interfaceLanguage":"swift"},"metadata":{"roleHeading":"Case","symbolKind":"case","title":"PasskeyDeviceType.multiDevice","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"multiDevice","kind":"identifier"}],"externalID":"s:5Auth017PasskeyDeviceTypeO05multiC0yA2CmF","modules":[{"name":"Auth0"}],"role":"symbol"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType"]]},"variants":[{"paths":["\/documentation\/auth0\/passkeydevicetype\/multidevice"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasskeyDeviceType/multiDevice":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType\/multiDevice","abstract":[{"text":"Passkey that can be backed up and synced to another device, when enabled by the user.","type":"text"}],"url":"\/documentation\/auth0\/passkeydevicetype\/multidevice","title":"PasskeyDeviceType.multiDevice","role":"symbol","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"multiDevice"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyDeviceType":{"type":"topic","kind":"symbol","url":"\/documentation\/auth0\/passkeydevicetype","abstract":[{"text":"Kind of device the passkey is stored on as defined by backup eligibility.","type":"text"}],"role":"symbol","title":"PasskeyDeviceType","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyDeviceType","kind":"identifier"}],"navigatorTitle":[{"text":"PasskeyDeviceType","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType\/multiDevice","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"multiDevice"}]}]}],"variants":[{"paths":["\/documentation\/auth0\/passkeydevicetype\/multidevice"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","metadata":{"modules":[{"name":"Auth0"}],"title":"PasskeyDeviceType.multiDevice","externalID":"s:5Auth017PasskeyDeviceTypeO05multiC0yA2CmF","role":"symbol","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"multiDevice"}],"symbolKind":"case","roleHeading":"Case"},"schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"type":"text","text":"Passkey that can be backed up and synced to another device, when enabled by the user."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasskeyDeviceType/multiDevice":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType\/multiDevice","type":"topic","title":"PasskeyDeviceType.multiDevice","role":"symbol","kind":"symbol","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"multiDevice","kind":"identifier"}],"abstract":[{"type":"text","text":"Passkey that can be backed up and synced to another device, when enabled by the user."}],"url":"\/documentation\/auth0\/passkeydevicetype\/multidevice"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyDeviceType":{"navigatorTitle":[{"kind":"identifier","text":"PasskeyDeviceType"}],"kind":"symbol","url":"\/documentation\/auth0\/passkeydevicetype","role":"symbol","abstract":[{"text":"Kind of device the passkey is stored on as defined by backup eligibility.","type":"text"}],"type":"topic","fragments":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"text":"PasskeyDeviceType","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType","title":"PasskeyDeviceType"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/passkeydevicetype/rawrepresentable-implementations.json b/docs/data/documentation/auth0/passkeydevicetype/rawrepresentable-implementations.json index b753afdeb..c79d0b2d1 100644 --- a/docs/data/documentation/auth0/passkeydevicetype/rawrepresentable-implementations.json +++ b/docs/data/documentation/auth0/passkeydevicetype/rawrepresentable-implementations.json @@ -1 +1 @@ -{"metadata":{"role":"collectionGroup","modules":[{"name":"Auth0"}],"roleHeading":"API Collection","title":"RawRepresentable Implementations"},"topicSections":[{"anchor":"Initializers","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType\/init(from:)"],"title":"Initializers","generated":true},{"anchor":"Instance-Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType\/hashValue"],"title":"Instance Properties","generated":true},{"anchor":"Instance-Methods","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType\/hash(into:)"],"title":"Instance Methods","generated":true}],"schemaVersion":{"patch":0,"minor":3,"major":0},"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType\/RawRepresentable-Implementations"},"kind":"article","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType"]]},"variants":[{"paths":["\/documentation\/auth0\/passkeydevicetype\/rawrepresentable-implementations"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasskeyDeviceType":{"type":"topic","kind":"symbol","url":"\/documentation\/auth0\/passkeydevicetype","abstract":[{"text":"Kind of device the passkey is stored on as defined by backup eligibility.","type":"text"}],"role":"symbol","title":"PasskeyDeviceType","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyDeviceType","kind":"identifier"}],"navigatorTitle":[{"text":"PasskeyDeviceType","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyDeviceType/hashValue":{"title":"hashValue","abstract":[],"url":"\/documentation\/auth0\/passkeydevicetype\/hashvalue","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType\/hashValue","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"hashValue"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"}],"role":"symbol","conformance":{"conformancePrefix":[{"type":"text","text":"Conforms when"}],"constraints":[{"type":"codeVoice","code":"Self"},{"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"}]},"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyDeviceType/hash(into:)":{"kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"hash"},{"kind":"text","text":"("},{"kind":"externalParam","text":"into"},{"kind":"text","text":": "},{"kind":"keyword","text":"inout"},{"kind":"text","text":" "},{"preciseIdentifier":"s:s6HasherV","kind":"typeIdentifier","text":"Hasher"},{"kind":"text","text":")"}],"title":"hash(into:)","url":"\/documentation\/auth0\/passkeydevicetype\/hash(into:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType\/hash(into:)","conformance":{"conformancePrefix":[{"text":"Conforms when","type":"text"}],"availabilityPrefix":[{"text":"Available when","type":"text"}],"constraints":[{"type":"codeVoice","code":"Self"},{"text":" conforms to ","type":"text"},{"type":"codeVoice","code":"Hashable"},{"text":" and ","type":"text"},{"type":"codeVoice","code":"RawValue"},{"text":" conforms to ","type":"text"},{"type":"codeVoice","code":"Hashable"},{"text":".","type":"text"}]},"type":"topic","abstract":[]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyDeviceType/init(from:)":{"kind":"symbol","abstract":[],"type":"topic","title":"init(from:)","role":"symbol","url":"\/documentation\/auth0\/passkeydevicetype\/init(from:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": any "},{"preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier","text":"Decoder"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType\/init(from:)","conformance":{"conformancePrefix":[{"text":"Conforms when","type":"text"}],"constraints":[{"code":"Self","type":"codeVoice"},{"text":" conforms to ","type":"text"},{"code":"Decodable","type":"codeVoice"},{"text":" and ","type":"text"},{"code":"RawValue","type":"codeVoice"},{"text":" is ","type":"text"},{"code":"String","type":"codeVoice"},{"text":".","type":"text"}],"availabilityPrefix":[{"text":"Available when","type":"text"}]}}}} \ No newline at end of file +{"kind":"article","topicSections":[{"title":"Initializers","generated":true,"anchor":"Initializers","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType\/init(from:)"]},{"title":"Instance Properties","generated":true,"anchor":"Instance-Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType\/hashValue"]},{"title":"Instance Methods","generated":true,"anchor":"Instance-Methods","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType\/hash(into:)"]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passkeydevicetype\/rawrepresentable-implementations"]}],"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType\/RawRepresentable-Implementations","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType"]]},"metadata":{"modules":[{"name":"Auth0"}],"role":"collectionGroup","title":"RawRepresentable Implementations","roleHeading":"API Collection"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasskeyDeviceType":{"navigatorTitle":[{"kind":"identifier","text":"PasskeyDeviceType"}],"kind":"symbol","url":"\/documentation\/auth0\/passkeydevicetype","role":"symbol","abstract":[{"text":"Kind of device the passkey is stored on as defined by backup eligibility.","type":"text"}],"type":"topic","fragments":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"text":"PasskeyDeviceType","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType","title":"PasskeyDeviceType"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyDeviceType/hashValue":{"title":"hashValue","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType\/hashValue","type":"topic","role":"symbol","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"hashValue","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Int","preciseIdentifier":"s:Si","kind":"typeIdentifier"}],"abstract":[],"conformance":{"availabilityPrefix":[{"type":"text","text":"Available when"}],"constraints":[{"type":"codeVoice","code":"Self"},{"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":"."}],"conformancePrefix":[{"type":"text","text":"Conforms when"}]},"url":"\/documentation\/auth0\/passkeydevicetype\/hashvalue"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyDeviceType/init(from:)":{"type":"topic","abstract":[],"kind":"symbol","title":"init(from:)","url":"\/documentation\/auth0\/passkeydevicetype\/init(from:)","role":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":": any ","kind":"text"},{"preciseIdentifier":"s:s7DecoderP","text":"Decoder","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"conformance":{"constraints":[{"type":"codeVoice","code":"Self"},{"type":"text","text":" conforms to "},{"code":"Decodable","type":"codeVoice"},{"type":"text","text":" and "},{"type":"codeVoice","code":"RawValue"},{"type":"text","text":" is "},{"type":"codeVoice","code":"String"},{"type":"text","text":"."}],"availabilityPrefix":[{"text":"Available when","type":"text"}],"conformancePrefix":[{"type":"text","text":"Conforms when"}]},"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType\/init(from:)"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyDeviceType/hash(into:)":{"url":"\/documentation\/auth0\/passkeydevicetype\/hash(into:)","title":"hash(into:)","abstract":[],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"hash"},{"kind":"text","text":"("},{"kind":"externalParam","text":"into"},{"kind":"text","text":": "},{"kind":"keyword","text":"inout"},{"kind":"text","text":" "},{"kind":"typeIdentifier","text":"Hasher","preciseIdentifier":"s:s6HasherV"},{"kind":"text","text":")"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType\/hash(into:)","role":"symbol","kind":"symbol","conformance":{"constraints":[{"type":"codeVoice","code":"Self"},{"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"}]},"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/passkeydevicetype/singledevice.json b/docs/data/documentation/auth0/passkeydevicetype/singledevice.json index 85fdfe075..8eeffbc75 100644 --- a/docs/data/documentation/auth0/passkeydevicetype/singledevice.json +++ b/docs/data/documentation/auth0/passkeydevicetype/singledevice.json @@ -1 +1 @@ -{"metadata":{"externalID":"s:5Auth017PasskeyDeviceTypeO06singleC0yA2CmF","symbolKind":"case","modules":[{"name":"Auth0"}],"role":"symbol","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"singleDevice"}],"roleHeading":"Case","title":"PasskeyDeviceType.singleDevice"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType"]]},"abstract":[{"text":"Passkey that cannot be backed up and synced to another device.","type":"text"}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passkeydevicetype\/singledevice"]}],"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType\/singleDevice"},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"singleDevice","kind":"identifier"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasskeyDeviceType":{"type":"topic","kind":"symbol","url":"\/documentation\/auth0\/passkeydevicetype","abstract":[{"text":"Kind of device the passkey is stored on as defined by backup eligibility.","type":"text"}],"role":"symbol","title":"PasskeyDeviceType","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyDeviceType","kind":"identifier"}],"navigatorTitle":[{"text":"PasskeyDeviceType","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyDeviceType/singleDevice":{"type":"topic","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"singleDevice","kind":"identifier"}],"url":"\/documentation\/auth0\/passkeydevicetype\/singledevice","title":"PasskeyDeviceType.singleDevice","role":"symbol","abstract":[{"text":"Passkey that cannot be backed up and synced to another device.","type":"text"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType\/singleDevice"}}} \ No newline at end of file +{"variants":[{"paths":["\/documentation\/auth0\/passkeydevicetype\/singledevice"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType"]]},"abstract":[{"type":"text","text":"Passkey that cannot be backed up and synced to another device."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"singleDevice"}],"languages":["swift"],"platforms":["iOS"]}]}],"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"metadata":{"externalID":"s:5Auth017PasskeyDeviceTypeO06singleC0yA2CmF","symbolKind":"case","title":"PasskeyDeviceType.singleDevice","role":"symbol","roleHeading":"Case","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"singleDevice","kind":"identifier"}],"modules":[{"name":"Auth0"}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType\/singleDevice"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyDeviceType/singleDevice":{"type":"topic","abstract":[{"type":"text","text":"Passkey that cannot be backed up and synced to another device."}],"kind":"symbol","title":"PasskeyDeviceType.singleDevice","url":"\/documentation\/auth0\/passkeydevicetype\/singledevice","role":"symbol","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"singleDevice","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType\/singleDevice"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyDeviceType":{"navigatorTitle":[{"kind":"identifier","text":"PasskeyDeviceType"}],"kind":"symbol","url":"\/documentation\/auth0\/passkeydevicetype","role":"symbol","abstract":[{"text":"Kind of device the passkey is stored on as defined by backup eligibility.","type":"text"}],"type":"topic","fragments":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"text":"PasskeyDeviceType","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyDeviceType","title":"PasskeyDeviceType"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/passkeyenrollmentchallenge.json b/docs/data/documentation/auth0/passkeyenrollmentchallenge.json index 63c2ad855..a27cf73aa 100644 --- a/docs/data/documentation/auth0/passkeyenrollmentchallenge.json +++ b/docs/data/documentation/auth0/passkeyenrollmentchallenge.json @@ -1 +1 @@ -{"metadata":{"symbolKind":"struct","externalID":"s:5Auth026PasskeyEnrollmentChallengeV","navigatorTitle":[{"kind":"identifier","text":"PasskeyEnrollmentChallenge"}],"role":"symbol","modules":[{"name":"Auth0"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyEnrollmentChallenge","kind":"identifier"}],"roleHeading":"Structure","title":"PasskeyEnrollmentChallenge"},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasskeyEnrollmentChallenge"}]}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"kind":"symbol","topicSections":[{"title":"Instance Properties","anchor":"Instance-Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge\/authenticationMethodId","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge\/authenticationSession","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge\/challengeData","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge\/relyingPartyId","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge\/userId","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge\/userName"],"generated":true},{"title":"Default Implementations","anchor":"Default-Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge\/Decodable-Implementations"],"generated":true}],"abstract":[{"type":"text","text":"A passkey enrollment challenge."}],"variants":[{"paths":["\/documentation\/auth0\/passkeyenrollmentchallenge"],"traits":[{"interfaceLanguage":"swift"}]}],"relationshipsSections":[{"kind":"relationships","title":"Conforms To","identifiers":["doc:\/\/com.auth0.Auth0\/s8CopyableP","doc:\/\/com.auth0.Auth0\/Se"],"type":"conformsTo"}],"sections":[],"schemaVersion":{"patch":0,"minor":3,"major":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasskeyEnrollmentChallenge/userName":{"abstract":[{"type":"text","text":"A user identifier, like the user’s email."}],"role":"symbol","url":"\/documentation\/auth0\/passkeyenrollmentchallenge\/username","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge\/userName","title":"userName","kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"userName"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}]},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyEnrollmentChallenge/authenticationMethodId":{"url":"\/documentation\/auth0\/passkeyenrollmentchallenge\/authenticationmethodid","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge\/authenticationMethodId","type":"topic","abstract":[{"text":"Unique identifier of the authentication method.","type":"text"}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticationMethodId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"role":"symbol","title":"authenticationMethodId","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyEnrollmentChallenge/challengeData":{"kind":"symbol","url":"\/documentation\/auth0\/passkeyenrollmentchallenge\/challengedata","type":"topic","title":"challengeData","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge\/challengeData","abstract":[{"text":"Enrollment challenge data.","type":"text"}],"fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"challengeData","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Data","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV"}],"role":"symbol"},"doc://com.auth0.Auth0/s8CopyableP":{"type":"unresolvable","title":"Swift.Copyable","identifier":"doc:\/\/com.auth0.Auth0\/s8CopyableP"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyEnrollmentChallenge":{"title":"PasskeyEnrollmentChallenge","role":"symbol","url":"\/documentation\/auth0\/passkeyenrollmentchallenge","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyEnrollmentChallenge","kind":"identifier"}],"type":"topic","navigatorTitle":[{"text":"PasskeyEnrollmentChallenge","kind":"identifier"}],"abstract":[{"type":"text","text":"A passkey enrollment challenge."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyEnrollmentChallenge/authenticationSession":{"title":"authenticationSession","role":"symbol","url":"\/documentation\/auth0\/passkeyenrollmentchallenge\/authenticationsession","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authenticationSession","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"type":"topic","abstract":[{"type":"text","text":"Unique identifier of the Auth0 session."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge\/authenticationSession","kind":"symbol"},"doc://com.auth0.Auth0/Se":{"identifier":"doc:\/\/com.auth0.Auth0\/Se","title":"Swift.Decodable","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyEnrollmentChallenge/relyingPartyId":{"role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"relyingPartyId","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"kind":"symbol","title":"relyingPartyId","url":"\/documentation\/auth0\/passkeyenrollmentchallenge\/relyingpartyid","abstract":[{"type":"text","text":"Custom domain configured in the Auth0 tenant."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge\/relyingPartyId","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyEnrollmentChallenge/userId":{"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"userId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV","text":"Data"}],"kind":"symbol","type":"topic","abstract":[{"type":"text","text":"Generated unique identifier of the user."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge\/userId","title":"userId","url":"\/documentation\/auth0\/passkeyenrollmentchallenge\/userid","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyEnrollmentChallenge/Decodable-Implementations":{"url":"\/documentation\/auth0\/passkeyenrollmentchallenge\/decodable-implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge\/Decodable-Implementations","kind":"article","role":"collectionGroup","type":"topic","abstract":[],"title":"Decodable Implementations"}}} \ No newline at end of file +{"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasskeyEnrollmentChallenge"}]}]}],"relationshipsSections":[{"title":"Conforms To","type":"conformsTo","identifiers":["doc:\/\/com.auth0.Auth0\/s8CopyableP","doc:\/\/com.auth0.Auth0\/Se"],"kind":"relationships"}],"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge\/authenticationMethodId","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge\/authenticationSession","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge\/challengeData","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge\/relyingPartyId","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge\/userId","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge\/userName"],"anchor":"Instance-Properties","title":"Instance Properties","generated":true},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge\/Decodable-Implementations"],"anchor":"Default-Implementations","title":"Default Implementations","generated":true}],"variants":[{"paths":["\/documentation\/auth0\/passkeyenrollmentchallenge"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"schemaVersion":{"patch":0,"minor":3,"major":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"abstract":[{"type":"text","text":"A passkey enrollment challenge."}],"metadata":{"roleHeading":"Structure","navigatorTitle":[{"kind":"identifier","text":"PasskeyEnrollmentChallenge"}],"symbolKind":"struct","title":"PasskeyEnrollmentChallenge","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyEnrollmentChallenge","kind":"identifier"}],"externalID":"s:5Auth026PasskeyEnrollmentChallengeV","modules":[{"name":"Auth0"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasskeyEnrollmentChallenge/Decodable-Implementations":{"type":"topic","abstract":[],"title":"Decodable Implementations","kind":"article","url":"\/documentation\/auth0\/passkeyenrollmentchallenge\/decodable-implementations","role":"collectionGroup","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge\/Decodable-Implementations"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyEnrollmentChallenge/authenticationMethodId":{"type":"topic","abstract":[{"type":"text","text":"Unique identifier of the authentication method."}],"title":"authenticationMethodId","kind":"symbol","url":"\/documentation\/auth0\/passkeyenrollmentchallenge\/authenticationmethodid","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authenticationMethodId","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge\/authenticationMethodId"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyEnrollmentChallenge/userName":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge\/userName","title":"userName","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"userName","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"role":"symbol","url":"\/documentation\/auth0\/passkeyenrollmentchallenge\/username","abstract":[{"type":"text","text":"A user identifier, like the user’s email."}],"type":"topic"},"doc://com.auth0.Auth0/s8CopyableP":{"title":"Swift.Copyable","identifier":"doc:\/\/com.auth0.Auth0\/s8CopyableP","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyEnrollmentChallenge/relyingPartyId":{"type":"topic","abstract":[{"type":"text","text":"Custom domain configured in the Auth0 tenant."}],"title":"relyingPartyId","kind":"symbol","url":"\/documentation\/auth0\/passkeyenrollmentchallenge\/relyingpartyid","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"relyingPartyId","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge\/relyingPartyId"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyEnrollmentChallenge":{"role":"symbol","title":"PasskeyEnrollmentChallenge","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyEnrollmentChallenge","kind":"identifier"}],"navigatorTitle":[{"text":"PasskeyEnrollmentChallenge","kind":"identifier"}],"abstract":[{"type":"text","text":"A passkey enrollment challenge."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge","url":"\/documentation\/auth0\/passkeyenrollmentchallenge","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyEnrollmentChallenge/userId":{"type":"topic","abstract":[{"type":"text","text":"Generated unique identifier of the user."}],"title":"userId","kind":"symbol","url":"\/documentation\/auth0\/passkeyenrollmentchallenge\/userid","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"userId","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Data","preciseIdentifier":"s:10Foundation4DataV","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge\/userId"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyEnrollmentChallenge/authenticationSession":{"type":"topic","abstract":[{"type":"text","text":"Unique identifier of the Auth0 session."}],"title":"authenticationSession","kind":"symbol","url":"\/documentation\/auth0\/passkeyenrollmentchallenge\/authenticationsession","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authenticationSession","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge\/authenticationSession"},"doc://com.auth0.Auth0/Se":{"title":"Swift.Decodable","identifier":"doc:\/\/com.auth0.Auth0\/Se","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyEnrollmentChallenge/challengeData":{"type":"topic","abstract":[{"type":"text","text":"Enrollment challenge data."}],"title":"challengeData","kind":"symbol","url":"\/documentation\/auth0\/passkeyenrollmentchallenge\/challengedata","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"challengeData","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Data","preciseIdentifier":"s:10Foundation4DataV","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge\/challengeData"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/passkeyenrollmentchallenge/authenticationmethodid.json b/docs/data/documentation/auth0/passkeyenrollmentchallenge/authenticationmethodid.json index 130e10eac..2a177b46e 100644 --- a/docs/data/documentation/auth0/passkeyenrollmentchallenge/authenticationmethodid.json +++ b/docs/data/documentation/auth0/passkeyenrollmentchallenge/authenticationmethodid.json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authenticationMethodId","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}]}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge\/authenticationMethodId"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge"]]},"abstract":[{"type":"text","text":"Unique identifier of the authentication method."}],"schemaVersion":{"minor":3,"patch":0,"major":0},"variants":[{"paths":["\/documentation\/auth0\/passkeyenrollmentchallenge\/authenticationmethodid"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","metadata":{"externalID":"s:5Auth026PasskeyEnrollmentChallengeV22authenticationMethodIdSSvp","modules":[{"name":"Auth0"}],"role":"symbol","title":"authenticationMethodId","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticationMethodId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"roleHeading":"Instance Property","symbolKind":"property"},"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyEnrollmentChallenge":{"title":"PasskeyEnrollmentChallenge","role":"symbol","url":"\/documentation\/auth0\/passkeyenrollmentchallenge","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyEnrollmentChallenge","kind":"identifier"}],"type":"topic","navigatorTitle":[{"text":"PasskeyEnrollmentChallenge","kind":"identifier"}],"abstract":[{"type":"text","text":"A passkey enrollment challenge."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyEnrollmentChallenge/authenticationMethodId":{"url":"\/documentation\/auth0\/passkeyenrollmentchallenge\/authenticationmethodid","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge\/authenticationMethodId","type":"topic","abstract":[{"text":"Unique identifier of the authentication method.","type":"text"}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticationMethodId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"role":"symbol","title":"authenticationMethodId","kind":"symbol"}}} \ No newline at end of file +{"metadata":{"symbolKind":"property","title":"authenticationMethodId","externalID":"s:5Auth026PasskeyEnrollmentChallengeV22authenticationMethodIdSSvp","roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticationMethodId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"role":"symbol"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passkeyenrollmentchallenge\/authenticationmethodid"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge\/authenticationMethodId","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"type":"text","text":"Unique identifier of the authentication method."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge"]]},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticationMethodId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}]}],"kind":"declarations"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasskeyEnrollmentChallenge":{"role":"symbol","title":"PasskeyEnrollmentChallenge","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyEnrollmentChallenge","kind":"identifier"}],"navigatorTitle":[{"text":"PasskeyEnrollmentChallenge","kind":"identifier"}],"abstract":[{"type":"text","text":"A passkey enrollment challenge."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge","url":"\/documentation\/auth0\/passkeyenrollmentchallenge","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyEnrollmentChallenge/authenticationMethodId":{"type":"topic","abstract":[{"type":"text","text":"Unique identifier of the authentication method."}],"title":"authenticationMethodId","kind":"symbol","url":"\/documentation\/auth0\/passkeyenrollmentchallenge\/authenticationmethodid","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authenticationMethodId","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge\/authenticationMethodId"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/passkeyenrollmentchallenge/authenticationsession.json b/docs/data/documentation/auth0/passkeyenrollmentchallenge/authenticationsession.json index eabd590f8..8a41cb74b 100644 --- a/docs/data/documentation/auth0/passkeyenrollmentchallenge/authenticationsession.json +++ b/docs/data/documentation/auth0/passkeyenrollmentchallenge/authenticationsession.json @@ -1 +1 @@ -{"abstract":[{"type":"text","text":"Unique identifier of the Auth0 session."}],"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge\/authenticationSession"},"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticationSession"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"platforms":["iOS"]}],"kind":"declarations"}],"variants":[{"paths":["\/documentation\/auth0\/passkeyenrollmentchallenge\/authenticationsession"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge"]]},"metadata":{"modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticationSession"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"symbolKind":"property","externalID":"s:5Auth026PasskeyEnrollmentChallengeV21authenticationSessionSSvp","title":"authenticationSession","role":"symbol","roleHeading":"Instance Property"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyEnrollmentChallenge/authenticationSession":{"title":"authenticationSession","role":"symbol","url":"\/documentation\/auth0\/passkeyenrollmentchallenge\/authenticationsession","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authenticationSession","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"type":"topic","abstract":[{"type":"text","text":"Unique identifier of the Auth0 session."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge\/authenticationSession","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyEnrollmentChallenge":{"title":"PasskeyEnrollmentChallenge","role":"symbol","url":"\/documentation\/auth0\/passkeyenrollmentchallenge","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyEnrollmentChallenge","kind":"identifier"}],"type":"topic","navigatorTitle":[{"text":"PasskeyEnrollmentChallenge","kind":"identifier"}],"abstract":[{"type":"text","text":"A passkey enrollment challenge."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge","kind":"symbol"}}} \ No newline at end of file +{"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authenticationSession","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"languages":["swift"],"platforms":["iOS"]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passkeyenrollmentchallenge\/authenticationsession"]}],"sections":[],"schemaVersion":{"patch":0,"minor":3,"major":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge\/authenticationSession","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge"]]},"abstract":[{"type":"text","text":"Unique identifier of the Auth0 session."}],"metadata":{"role":"symbol","modules":[{"name":"Auth0"}],"title":"authenticationSession","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authenticationSession","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"externalID":"s:5Auth026PasskeyEnrollmentChallengeV21authenticationSessionSSvp","roleHeading":"Instance Property","symbolKind":"property"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasskeyEnrollmentChallenge/authenticationSession":{"type":"topic","abstract":[{"type":"text","text":"Unique identifier of the Auth0 session."}],"title":"authenticationSession","kind":"symbol","url":"\/documentation\/auth0\/passkeyenrollmentchallenge\/authenticationsession","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authenticationSession","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge\/authenticationSession"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyEnrollmentChallenge":{"role":"symbol","title":"PasskeyEnrollmentChallenge","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyEnrollmentChallenge","kind":"identifier"}],"navigatorTitle":[{"text":"PasskeyEnrollmentChallenge","kind":"identifier"}],"abstract":[{"type":"text","text":"A passkey enrollment challenge."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge","url":"\/documentation\/auth0\/passkeyenrollmentchallenge","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/passkeyenrollmentchallenge/challengedata.json b/docs/data/documentation/auth0/passkeyenrollmentchallenge/challengedata.json index 945b6306f..ea88ece62 100644 --- a/docs/data/documentation/auth0/passkeyenrollmentchallenge/challengedata.json +++ b/docs/data/documentation/auth0/passkeyenrollmentchallenge/challengedata.json @@ -1 +1 @@ -{"schemaVersion":{"minor":3,"patch":0,"major":0},"metadata":{"symbolKind":"property","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"challengeData"},{"kind":"text","text":": "},{"preciseIdentifier":"s:10Foundation4DataV","kind":"typeIdentifier","text":"Data"}],"roleHeading":"Instance Property","title":"challengeData","externalID":"s:5Auth026PasskeyEnrollmentChallengeV13challengeData10Foundation0F0Vvp","role":"symbol"},"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"challengeData"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"}],"platforms":["iOS"]}],"kind":"declarations"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge\/challengeData"},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge"]]},"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passkeyenrollmentchallenge\/challengedata"]}],"abstract":[{"type":"text","text":"Enrollment challenge data."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasskeyEnrollmentChallenge":{"title":"PasskeyEnrollmentChallenge","role":"symbol","url":"\/documentation\/auth0\/passkeyenrollmentchallenge","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyEnrollmentChallenge","kind":"identifier"}],"type":"topic","navigatorTitle":[{"text":"PasskeyEnrollmentChallenge","kind":"identifier"}],"abstract":[{"type":"text","text":"A passkey enrollment challenge."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyEnrollmentChallenge/challengeData":{"kind":"symbol","url":"\/documentation\/auth0\/passkeyenrollmentchallenge\/challengedata","type":"topic","title":"challengeData","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge\/challengeData","abstract":[{"text":"Enrollment challenge data.","type":"text"}],"fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"challengeData","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Data","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"metadata":{"symbolKind":"property","roleHeading":"Instance Property","title":"challengeData","externalID":"s:5Auth026PasskeyEnrollmentChallengeV13challengeData10Foundation0F0Vvp","modules":[{"name":"Auth0"}],"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"challengeData","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Data","preciseIdentifier":"s:10Foundation4DataV","kind":"typeIdentifier"}],"role":"symbol"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passkeyenrollmentchallenge\/challengedata"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge\/challengeData"},"kind":"symbol","abstract":[{"type":"text","text":"Enrollment challenge data."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"challengeData","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Data","preciseIdentifier":"s:10Foundation4DataV","kind":"typeIdentifier"}],"languages":["swift"],"platforms":["iOS"]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasskeyEnrollmentChallenge/challengeData":{"type":"topic","abstract":[{"type":"text","text":"Enrollment challenge data."}],"title":"challengeData","kind":"symbol","url":"\/documentation\/auth0\/passkeyenrollmentchallenge\/challengedata","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"challengeData","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Data","preciseIdentifier":"s:10Foundation4DataV","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge\/challengeData"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyEnrollmentChallenge":{"role":"symbol","title":"PasskeyEnrollmentChallenge","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyEnrollmentChallenge","kind":"identifier"}],"navigatorTitle":[{"text":"PasskeyEnrollmentChallenge","kind":"identifier"}],"abstract":[{"type":"text","text":"A passkey enrollment challenge."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge","url":"\/documentation\/auth0\/passkeyenrollmentchallenge","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/passkeyenrollmentchallenge/decodable-implementations.json b/docs/data/documentation/auth0/passkeyenrollmentchallenge/decodable-implementations.json index 6a7e41e34..58718bc4c 100644 --- a/docs/data/documentation/auth0/passkeyenrollmentchallenge/decodable-implementations.json +++ b/docs/data/documentation/auth0/passkeyenrollmentchallenge/decodable-implementations.json @@ -1 +1 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge\/Decodable-Implementations","interfaceLanguage":"swift"},"schemaVersion":{"minor":3,"major":0,"patch":0},"variants":[{"paths":["\/documentation\/auth0\/passkeyenrollmentchallenge\/decodable-implementations"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"kind":"article","topicSections":[{"title":"Initializers","generated":true,"anchor":"Initializers","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge\/init(from:)"]}],"metadata":{"roleHeading":"API Collection","role":"collectionGroup","modules":[{"name":"Auth0"}],"title":"Decodable Implementations"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyEnrollmentChallenge":{"title":"PasskeyEnrollmentChallenge","role":"symbol","url":"\/documentation\/auth0\/passkeyenrollmentchallenge","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyEnrollmentChallenge","kind":"identifier"}],"type":"topic","navigatorTitle":[{"text":"PasskeyEnrollmentChallenge","kind":"identifier"}],"abstract":[{"type":"text","text":"A passkey enrollment challenge."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyEnrollmentChallenge/init(from:)":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge\/init(from:)","kind":"symbol","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Decoder","preciseIdentifier":"s:s7DecoderP"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"type":"topic","title":"init(from:)","url":"\/documentation\/auth0\/passkeyenrollmentchallenge\/init(from:)","abstract":[{"type":"codeVoice","code":"Decodable"},{"text":" initializer.","type":"text"}]}}} \ No newline at end of file +{"variants":[{"paths":["\/documentation\/auth0\/passkeyenrollmentchallenge\/decodable-implementations"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge"]]},"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge\/init(from:)"],"title":"Initializers","generated":true,"anchor":"Initializers"}],"kind":"article","schemaVersion":{"patch":0,"major":0,"minor":3},"sections":[],"metadata":{"modules":[{"name":"Auth0"}],"roleHeading":"API Collection","role":"collectionGroup","title":"Decodable Implementations"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge\/Decodable-Implementations","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasskeyEnrollmentChallenge":{"role":"symbol","title":"PasskeyEnrollmentChallenge","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyEnrollmentChallenge","kind":"identifier"}],"navigatorTitle":[{"text":"PasskeyEnrollmentChallenge","kind":"identifier"}],"abstract":[{"type":"text","text":"A passkey enrollment challenge."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge","url":"\/documentation\/auth0\/passkeyenrollmentchallenge","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyEnrollmentChallenge/init(from:)":{"kind":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Decoder","preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"title":"init(from:)","type":"topic","role":"symbol","abstract":[{"type":"codeVoice","code":"Decodable"},{"type":"text","text":" initializer."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge\/init(from:)","url":"\/documentation\/auth0\/passkeyenrollmentchallenge\/init(from:)"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/passkeyenrollmentchallenge/init(from:).json b/docs/data/documentation/auth0/passkeyenrollmentchallenge/init(from:).json index 361281f66..3000a2284 100644 --- a/docs/data/documentation/auth0/passkeyenrollmentchallenge/init(from:).json +++ b/docs/data/documentation/auth0/passkeyenrollmentchallenge/init(from:).json @@ -1 +1 @@ -{"schemaVersion":{"patch":0,"major":0,"minor":3},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge\/init(from:)"},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge"]]},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passkeyenrollmentchallenge\/init(from:)"]}],"metadata":{"fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:s7DecoderP","text":"Decoder","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"title":"init(from:)","modules":[{"name":"Auth0"}],"extendedModule":"Auth0","symbolKind":"init","roleHeading":"Initializer","role":"symbol","externalID":"s:5Auth026PasskeyEnrollmentChallengeV4fromACs7Decoder_p_tKcfc"},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":" "},{"kind":"internalParam","text":"decoder"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Decoder","preciseIdentifier":"s:s7DecoderP"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}]}]}],"abstract":[{"type":"codeVoice","code":"Decodable"},{"text":" initializer.","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasskeyEnrollmentChallenge/init(from:)":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge\/init(from:)","kind":"symbol","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Decoder","preciseIdentifier":"s:s7DecoderP"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"type":"topic","title":"init(from:)","url":"\/documentation\/auth0\/passkeyenrollmentchallenge\/init(from:)","abstract":[{"type":"codeVoice","code":"Decodable"},{"text":" initializer.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyEnrollmentChallenge":{"title":"PasskeyEnrollmentChallenge","role":"symbol","url":"\/documentation\/auth0\/passkeyenrollmentchallenge","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyEnrollmentChallenge","kind":"identifier"}],"type":"topic","navigatorTitle":[{"text":"PasskeyEnrollmentChallenge","kind":"identifier"}],"abstract":[{"type":"text","text":"A passkey enrollment challenge."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge","kind":"symbol"}}} \ No newline at end of file +{"metadata":{"symbolKind":"init","roleHeading":"Initializer","externalID":"s:5Auth026PasskeyEnrollmentChallengeV4fromACs7Decoder_p_tKcfc","extendedModule":"Auth0","title":"init(from:)","modules":[{"name":"Auth0"}],"fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:s7DecoderP","text":"Decoder","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"role":"symbol"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passkeyenrollmentchallenge\/init(from:)"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge\/init(from:)"},"kind":"symbol","abstract":[{"type":"codeVoice","code":"Decodable"},{"type":"text","text":" initializer."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge"]]},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"init","kind":"keyword"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"decoder","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"Decoder","preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}]}],"kind":"declarations"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasskeyEnrollmentChallenge/init(from:)":{"kind":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Decoder","preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"title":"init(from:)","type":"topic","role":"symbol","abstract":[{"type":"codeVoice","code":"Decodable"},{"type":"text","text":" initializer."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge\/init(from:)","url":"\/documentation\/auth0\/passkeyenrollmentchallenge\/init(from:)"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyEnrollmentChallenge":{"role":"symbol","title":"PasskeyEnrollmentChallenge","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyEnrollmentChallenge","kind":"identifier"}],"navigatorTitle":[{"text":"PasskeyEnrollmentChallenge","kind":"identifier"}],"abstract":[{"type":"text","text":"A passkey enrollment challenge."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge","url":"\/documentation\/auth0\/passkeyenrollmentchallenge","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/passkeyenrollmentchallenge/relyingpartyid.json b/docs/data/documentation/auth0/passkeyenrollmentchallenge/relyingpartyid.json index ff946ad8b..e8cbd8ba7 100644 --- a/docs/data/documentation/auth0/passkeyenrollmentchallenge/relyingpartyid.json +++ b/docs/data/documentation/auth0/passkeyenrollmentchallenge/relyingpartyid.json @@ -1 +1 @@ -{"metadata":{"role":"symbol","externalID":"s:5Auth026PasskeyEnrollmentChallengeV14relyingPartyIdSSvp","title":"relyingPartyId","modules":[{"name":"Auth0"}],"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"relyingPartyId","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"roleHeading":"Instance Property","symbolKind":"property"},"kind":"symbol","abstract":[{"type":"text","text":"Custom domain configured in the Auth0 tenant."}],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"relyingPartyId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passkeyenrollmentchallenge\/relyingpartyid"]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge"]]},"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge\/relyingPartyId","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasskeyEnrollmentChallenge/relyingPartyId":{"role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"relyingPartyId","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"kind":"symbol","title":"relyingPartyId","url":"\/documentation\/auth0\/passkeyenrollmentchallenge\/relyingpartyid","abstract":[{"type":"text","text":"Custom domain configured in the Auth0 tenant."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge\/relyingPartyId","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyEnrollmentChallenge":{"title":"PasskeyEnrollmentChallenge","role":"symbol","url":"\/documentation\/auth0\/passkeyenrollmentchallenge","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyEnrollmentChallenge","kind":"identifier"}],"type":"topic","navigatorTitle":[{"text":"PasskeyEnrollmentChallenge","kind":"identifier"}],"abstract":[{"type":"text","text":"A passkey enrollment challenge."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"metadata":{"symbolKind":"property","roleHeading":"Instance Property","title":"relyingPartyId","externalID":"s:5Auth026PasskeyEnrollmentChallengeV14relyingPartyIdSSvp","modules":[{"name":"Auth0"}],"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"relyingPartyId","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"role":"symbol"},"sections":[],"variants":[{"paths":["\/documentation\/auth0\/passkeyenrollmentchallenge\/relyingpartyid"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge\/relyingPartyId"},"kind":"symbol","abstract":[{"type":"text","text":"Custom domain configured in the Auth0 tenant."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge"]]},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"relyingPartyId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyEnrollmentChallenge":{"role":"symbol","title":"PasskeyEnrollmentChallenge","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyEnrollmentChallenge","kind":"identifier"}],"navigatorTitle":[{"text":"PasskeyEnrollmentChallenge","kind":"identifier"}],"abstract":[{"type":"text","text":"A passkey enrollment challenge."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge","url":"\/documentation\/auth0\/passkeyenrollmentchallenge","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyEnrollmentChallenge/relyingPartyId":{"type":"topic","abstract":[{"type":"text","text":"Custom domain configured in the Auth0 tenant."}],"title":"relyingPartyId","kind":"symbol","url":"\/documentation\/auth0\/passkeyenrollmentchallenge\/relyingpartyid","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"relyingPartyId","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge\/relyingPartyId"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/passkeyenrollmentchallenge/userid.json b/docs/data/documentation/auth0/passkeyenrollmentchallenge/userid.json index 121730e04..1771b4e42 100644 --- a/docs/data/documentation/auth0/passkeyenrollmentchallenge/userid.json +++ b/docs/data/documentation/auth0/passkeyenrollmentchallenge/userid.json @@ -1 +1 @@ -{"metadata":{"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"userId","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Data","preciseIdentifier":"s:10Foundation4DataV","kind":"typeIdentifier"}],"role":"symbol","symbolKind":"property","roleHeading":"Instance Property","externalID":"s:5Auth026PasskeyEnrollmentChallengeV6userId10Foundation4DataVvp","title":"userId","modules":[{"name":"Auth0"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge\/userId","interfaceLanguage":"swift"},"variants":[{"paths":["\/documentation\/auth0\/passkeyenrollmentchallenge\/userid"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","abstract":[{"text":"Generated unique identifier of the user.","type":"text"}],"sections":[],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"userId","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Data","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV"}],"languages":["swift"]}],"kind":"declarations"}],"schemaVersion":{"minor":3,"patch":0,"major":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyEnrollmentChallenge/userId":{"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"userId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV","text":"Data"}],"kind":"symbol","type":"topic","abstract":[{"type":"text","text":"Generated unique identifier of the user."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge\/userId","title":"userId","url":"\/documentation\/auth0\/passkeyenrollmentchallenge\/userid","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyEnrollmentChallenge":{"title":"PasskeyEnrollmentChallenge","role":"symbol","url":"\/documentation\/auth0\/passkeyenrollmentchallenge","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyEnrollmentChallenge","kind":"identifier"}],"type":"topic","navigatorTitle":[{"text":"PasskeyEnrollmentChallenge","kind":"identifier"}],"abstract":[{"type":"text","text":"A passkey enrollment challenge."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge","kind":"symbol"}}} \ No newline at end of file +{"metadata":{"symbolKind":"property","roleHeading":"Instance Property","externalID":"s:5Auth026PasskeyEnrollmentChallengeV6userId10Foundation4DataVvp","title":"userId","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"userId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"}],"role":"symbol"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passkeyenrollmentchallenge\/userid"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge\/userId","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"text":"Generated unique identifier of the user.","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"userId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"}],"platforms":["iOS"]}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasskeyEnrollmentChallenge/userId":{"type":"topic","abstract":[{"type":"text","text":"Generated unique identifier of the user."}],"title":"userId","kind":"symbol","url":"\/documentation\/auth0\/passkeyenrollmentchallenge\/userid","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"userId","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Data","preciseIdentifier":"s:10Foundation4DataV","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge\/userId"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyEnrollmentChallenge":{"role":"symbol","title":"PasskeyEnrollmentChallenge","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyEnrollmentChallenge","kind":"identifier"}],"navigatorTitle":[{"text":"PasskeyEnrollmentChallenge","kind":"identifier"}],"abstract":[{"type":"text","text":"A passkey enrollment challenge."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge","url":"\/documentation\/auth0\/passkeyenrollmentchallenge","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/passkeyenrollmentchallenge/username.json b/docs/data/documentation/auth0/passkeyenrollmentchallenge/username.json index ec5b33b3b..13afbf78f 100644 --- a/docs/data/documentation/auth0/passkeyenrollmentchallenge/username.json +++ b/docs/data/documentation/auth0/passkeyenrollmentchallenge/username.json @@ -1 +1 @@ -{"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge\/userName","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge"]]},"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"userName"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"languages":["swift"],"platforms":["iOS"]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passkeyenrollmentchallenge\/username"]}],"abstract":[{"text":"A user identifier, like the user’s email.","type":"text"}],"schemaVersion":{"minor":3,"patch":0,"major":0},"metadata":{"role":"symbol","modules":[{"name":"Auth0"}],"title":"userName","roleHeading":"Instance Property","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"userName","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"externalID":"s:5Auth026PasskeyEnrollmentChallengeV8userNameSSvp","symbolKind":"property"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasskeyEnrollmentChallenge":{"title":"PasskeyEnrollmentChallenge","role":"symbol","url":"\/documentation\/auth0\/passkeyenrollmentchallenge","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyEnrollmentChallenge","kind":"identifier"}],"type":"topic","navigatorTitle":[{"text":"PasskeyEnrollmentChallenge","kind":"identifier"}],"abstract":[{"type":"text","text":"A passkey enrollment challenge."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyEnrollmentChallenge/userName":{"abstract":[{"type":"text","text":"A user identifier, like the user’s email."}],"role":"symbol","url":"\/documentation\/auth0\/passkeyenrollmentchallenge\/username","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge\/userName","title":"userName","kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"userName"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge\/userName","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"userName"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}]}]}],"variants":[{"paths":["\/documentation\/auth0\/passkeyenrollmentchallenge\/username"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","metadata":{"modules":[{"name":"Auth0"}],"title":"userName","externalID":"s:5Auth026PasskeyEnrollmentChallengeV8userNameSSvp","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"userName"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"roleHeading":"Instance Property","symbolKind":"property"},"schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"type":"text","text":"A user identifier, like the user’s email."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyEnrollmentChallenge/userName":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge\/userName","title":"userName","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"userName","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"role":"symbol","url":"\/documentation\/auth0\/passkeyenrollmentchallenge\/username","abstract":[{"type":"text","text":"A user identifier, like the user’s email."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyEnrollmentChallenge":{"role":"symbol","title":"PasskeyEnrollmentChallenge","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyEnrollmentChallenge","kind":"identifier"}],"navigatorTitle":[{"text":"PasskeyEnrollmentChallenge","kind":"identifier"}],"abstract":[{"type":"text","text":"A passkey enrollment challenge."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyEnrollmentChallenge","url":"\/documentation\/auth0\/passkeyenrollmentchallenge","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/passkeyloginchallenge.json b/docs/data/documentation/auth0/passkeyloginchallenge.json index 9bd9c5b10..4f3eff669 100644 --- a/docs/data/documentation/auth0/passkeyloginchallenge.json +++ b/docs/data/documentation/auth0/passkeyloginchallenge.json @@ -1 +1 @@ -{"abstract":[{"type":"text","text":"A passkey login challenge."}],"kind":"symbol","schemaVersion":{"patch":0,"minor":3,"major":0},"topicSections":[{"title":"Instance Properties","generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge\/authenticationSession","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge\/challengeData","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge\/relyingPartyId"],"anchor":"Instance-Properties"},{"title":"Default Implementations","generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge\/Decodable-Implementations"],"anchor":"Default-Implementations"}],"sections":[],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasskeyLoginChallenge"}]}],"kind":"declarations"}],"relationshipsSections":[{"title":"Conforms To","type":"conformsTo","identifiers":["doc:\/\/com.auth0.Auth0\/s8CopyableP","doc:\/\/com.auth0.Auth0\/Se","doc:\/\/com.auth0.Auth0\/s8SendableP","doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP"],"kind":"relationships"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passkeyloginchallenge"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"metadata":{"roleHeading":"Structure","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeyLoginChallenge","kind":"identifier"}],"navigatorTitle":[{"text":"PasskeyLoginChallenge","kind":"identifier"}],"symbolKind":"struct","modules":[{"name":"Auth0"}],"role":"symbol","externalID":"s:5Auth021PasskeyLoginChallengeV","title":"PasskeyLoginChallenge"},"references":{"doc://com.auth0.Auth0/Se":{"title":"Swift.Decodable","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/Se"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyLoginChallenge/relyingPartyId":{"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"relyingPartyId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"type":"topic","url":"\/documentation\/auth0\/passkeyloginchallenge\/relyingpartyid","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge\/relyingPartyId","abstract":[{"type":"text","text":"Custom domain configured in the Auth0 tenant."}],"title":"relyingPartyId","kind":"symbol","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyLoginChallenge":{"title":"PasskeyLoginChallenge","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasskeyLoginChallenge"}],"navigatorTitle":[{"kind":"identifier","text":"PasskeyLoginChallenge"}],"abstract":[{"text":"A passkey login challenge.","type":"text"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge","url":"\/documentation\/auth0\/passkeyloginchallenge","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyLoginChallenge/challengeData":{"url":"\/documentation\/auth0\/passkeyloginchallenge\/challengedata","kind":"symbol","title":"challengeData","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge\/challengeData","abstract":[{"type":"text","text":"Login challenge data."}],"role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"challengeData","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Data","preciseIdentifier":"s:10Foundation4DataV","kind":"typeIdentifier"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyLoginChallenge/authenticationSession":{"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticationSession"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"url":"\/documentation\/auth0\/passkeyloginchallenge\/authenticationsession","type":"topic","kind":"symbol","abstract":[{"type":"text","text":"Unique identifier of the Auth0 session."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge\/authenticationSession","title":"authenticationSession","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyLoginChallenge/Decodable-Implementations":{"role":"collectionGroup","title":"Decodable Implementations","kind":"article","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge\/Decodable-Implementations","type":"topic","abstract":[],"url":"\/documentation\/auth0\/passkeyloginchallenge\/decodable-implementations"},"doc://com.auth0.Auth0/s8SendableP":{"title":"Swift.Sendable","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s8SendableP"},"doc://com.auth0.Auth0/s16SendableMetatypeP":{"type":"unresolvable","title":"Swift.SendableMetatype","identifier":"doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP"},"doc://com.auth0.Auth0/s8CopyableP":{"title":"Swift.Copyable","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s8CopyableP"}}} \ No newline at end of file +{"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge"},"kind":"symbol","metadata":{"externalID":"s:5Auth021PasskeyLoginChallengeV","modules":[{"name":"Auth0"}],"role":"symbol","roleHeading":"Structure","symbolKind":"struct","navigatorTitle":[{"text":"PasskeyLoginChallenge","kind":"identifier"}],"title":"PasskeyLoginChallenge","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasskeyLoginChallenge"}]},"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge\/authenticationSession","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge\/challengeData","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge\/relyingPartyId"],"anchor":"Instance-Properties","title":"Instance Properties","generated":true},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge\/Decodable-Implementations"],"anchor":"Default-Implementations","title":"Default Implementations","generated":true}],"relationshipsSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/s8CopyableP","doc:\/\/com.auth0.Auth0\/Se","doc:\/\/com.auth0.Auth0\/s8SendableP","doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP"],"title":"Conforms To","type":"conformsTo","kind":"relationships"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passkeyloginchallenge"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"schemaVersion":{"patch":0,"minor":3,"major":0},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"PasskeyLoginChallenge","kind":"identifier"}]}],"kind":"declarations"}],"abstract":[{"type":"text","text":"A passkey login challenge."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasskeyLoginChallenge/Decodable-Implementations":{"role":"collectionGroup","title":"Decodable Implementations","abstract":[],"kind":"article","url":"\/documentation\/auth0\/passkeyloginchallenge\/decodable-implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge\/Decodable-Implementations","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyLoginChallenge":{"title":"PasskeyLoginChallenge","role":"symbol","navigatorTitle":[{"text":"PasskeyLoginChallenge","kind":"identifier"}],"kind":"symbol","abstract":[{"text":"A passkey login challenge.","type":"text"}],"url":"\/documentation\/auth0\/passkeyloginchallenge","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"PasskeyLoginChallenge"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyLoginChallenge/authenticationSession":{"type":"topic","title":"authenticationSession","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge\/authenticationSession","kind":"symbol","abstract":[{"type":"text","text":"Unique identifier of the Auth0 session."}],"url":"\/documentation\/auth0\/passkeyloginchallenge\/authenticationsession","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authenticationSession","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}]},"doc://com.auth0.Auth0/s8SendableP":{"title":"Swift.Sendable","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s8SendableP"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","type":"topic"},"doc://com.auth0.Auth0/s8CopyableP":{"title":"Swift.Copyable","identifier":"doc:\/\/com.auth0.Auth0\/s8CopyableP","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyLoginChallenge/relyingPartyId":{"kind":"symbol","title":"relyingPartyId","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"relyingPartyId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge\/relyingPartyId","abstract":[{"type":"text","text":"Custom domain configured in the Auth0 tenant."}],"url":"\/documentation\/auth0\/passkeyloginchallenge\/relyingpartyid"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyLoginChallenge/challengeData":{"url":"\/documentation\/auth0\/passkeyloginchallenge\/challengedata","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"challengeData"},{"kind":"text","text":": "},{"preciseIdentifier":"s:10Foundation4DataV","kind":"typeIdentifier","text":"Data"}],"title":"challengeData","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Login challenge data."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge\/challengeData","kind":"symbol"},"doc://com.auth0.Auth0/s16SendableMetatypeP":{"title":"Swift.SendableMetatype","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP"},"doc://com.auth0.Auth0/Se":{"title":"Swift.Decodable","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/Se"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/passkeyloginchallenge/authenticationsession.json b/docs/data/documentation/auth0/passkeyloginchallenge/authenticationsession.json index 300db16f8..efd494c7f 100644 --- a/docs/data/documentation/auth0/passkeyloginchallenge/authenticationsession.json +++ b/docs/data/documentation/auth0/passkeyloginchallenge/authenticationsession.json @@ -1 +1 @@ -{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge\/authenticationSession"},"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"type":"text","text":"Unique identifier of the Auth0 session."}],"sections":[],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authenticationSession","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"languages":["swift"]}],"kind":"declarations"}],"metadata":{"symbolKind":"property","modules":[{"name":"Auth0"}],"externalID":"s:5Auth021PasskeyLoginChallengeV21authenticationSessionSSvp","title":"authenticationSession","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authenticationSession","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"roleHeading":"Instance Property","role":"symbol"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passkeyloginchallenge\/authenticationsession"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasskeyLoginChallenge":{"title":"PasskeyLoginChallenge","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasskeyLoginChallenge"}],"navigatorTitle":[{"kind":"identifier","text":"PasskeyLoginChallenge"}],"abstract":[{"text":"A passkey login challenge.","type":"text"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge","url":"\/documentation\/auth0\/passkeyloginchallenge","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyLoginChallenge/authenticationSession":{"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticationSession"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"url":"\/documentation\/auth0\/passkeyloginchallenge\/authenticationsession","type":"topic","kind":"symbol","abstract":[{"type":"text","text":"Unique identifier of the Auth0 session."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge\/authenticationSession","title":"authenticationSession","role":"symbol"}}} \ No newline at end of file +{"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticationSession"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}]}]}],"sections":[],"abstract":[{"type":"text","text":"Unique identifier of the Auth0 session."}],"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/passkeyloginchallenge\/authenticationsession"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"role":"symbol","title":"authenticationSession","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticationSession"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"externalID":"s:5Auth021PasskeyLoginChallengeV21authenticationSessionSSvp","roleHeading":"Instance Property","symbolKind":"property"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge\/authenticationSession","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasskeyLoginChallenge/authenticationSession":{"type":"topic","title":"authenticationSession","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge\/authenticationSession","kind":"symbol","abstract":[{"type":"text","text":"Unique identifier of the Auth0 session."}],"url":"\/documentation\/auth0\/passkeyloginchallenge\/authenticationsession","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authenticationSession","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyLoginChallenge":{"title":"PasskeyLoginChallenge","role":"symbol","navigatorTitle":[{"text":"PasskeyLoginChallenge","kind":"identifier"}],"kind":"symbol","abstract":[{"text":"A passkey login challenge.","type":"text"}],"url":"\/documentation\/auth0\/passkeyloginchallenge","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"PasskeyLoginChallenge"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/passkeyloginchallenge/challengedata.json b/docs/data/documentation/auth0/passkeyloginchallenge/challengedata.json index 5be5846a2..b941f9722 100644 --- a/docs/data/documentation/auth0/passkeyloginchallenge/challengedata.json +++ b/docs/data/documentation/auth0/passkeyloginchallenge/challengedata.json @@ -1 +1 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge\/challengeData","interfaceLanguage":"swift"},"schemaVersion":{"patch":0,"minor":3,"major":0},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge"]]},"variants":[{"paths":["\/documentation\/auth0\/passkeyloginchallenge\/challengedata"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"type":"text","text":"Login challenge data."}],"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"challengeData"},{"kind":"text","text":": "},{"preciseIdentifier":"s:10Foundation4DataV","kind":"typeIdentifier","text":"Data"}],"platforms":["iOS"]}]}],"metadata":{"modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","role":"symbol","title":"challengeData","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"challengeData","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Data","preciseIdentifier":"s:10Foundation4DataV","kind":"typeIdentifier"}],"symbolKind":"property","externalID":"s:5Auth021PasskeyLoginChallengeV13challengeData10Foundation0F0Vvp"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasskeyLoginChallenge/challengeData":{"url":"\/documentation\/auth0\/passkeyloginchallenge\/challengedata","kind":"symbol","title":"challengeData","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge\/challengeData","abstract":[{"type":"text","text":"Login challenge data."}],"role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"challengeData","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Data","preciseIdentifier":"s:10Foundation4DataV","kind":"typeIdentifier"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyLoginChallenge":{"title":"PasskeyLoginChallenge","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasskeyLoginChallenge"}],"navigatorTitle":[{"kind":"identifier","text":"PasskeyLoginChallenge"}],"abstract":[{"text":"A passkey login challenge.","type":"text"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge","url":"\/documentation\/auth0\/passkeyloginchallenge","type":"topic"}}} \ No newline at end of file +{"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge\/challengeData","interfaceLanguage":"swift"},"metadata":{"externalID":"s:5Auth021PasskeyLoginChallengeV13challengeData10Foundation0F0Vvp","modules":[{"name":"Auth0"}],"title":"challengeData","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"challengeData","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation4DataV","text":"Data","kind":"typeIdentifier"}],"roleHeading":"Instance Property","role":"symbol","symbolKind":"property"},"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passkeyloginchallenge\/challengedata"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge"]]},"schemaVersion":{"patch":0,"major":0,"minor":3},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"challengeData","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation4DataV","text":"Data","kind":"typeIdentifier"}],"platforms":["iOS"]}]}],"abstract":[{"text":"Login challenge data.","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasskeyLoginChallenge/challengeData":{"url":"\/documentation\/auth0\/passkeyloginchallenge\/challengedata","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"challengeData"},{"kind":"text","text":": "},{"preciseIdentifier":"s:10Foundation4DataV","kind":"typeIdentifier","text":"Data"}],"title":"challengeData","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Login challenge data."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge\/challengeData","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyLoginChallenge":{"title":"PasskeyLoginChallenge","role":"symbol","navigatorTitle":[{"text":"PasskeyLoginChallenge","kind":"identifier"}],"kind":"symbol","abstract":[{"text":"A passkey login challenge.","type":"text"}],"url":"\/documentation\/auth0\/passkeyloginchallenge","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"PasskeyLoginChallenge"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/passkeyloginchallenge/decodable-implementations.json b/docs/data/documentation/auth0/passkeyloginchallenge/decodable-implementations.json index a0c708df5..72b882182 100644 --- a/docs/data/documentation/auth0/passkeyloginchallenge/decodable-implementations.json +++ b/docs/data/documentation/auth0/passkeyloginchallenge/decodable-implementations.json @@ -1 +1 @@ -{"metadata":{"role":"collectionGroup","roleHeading":"API Collection","modules":[{"name":"Auth0"}],"title":"Decodable Implementations"},"schemaVersion":{"major":0,"patch":0,"minor":3},"topicSections":[{"anchor":"Initializers","generated":true,"title":"Initializers","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge\/init(from:)"]}],"kind":"article","variants":[{"paths":["\/documentation\/auth0\/passkeyloginchallenge\/decodable-implementations"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge\/Decodable-Implementations","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyLoginChallenge/init(from:)":{"kind":"symbol","type":"topic","title":"init(from:)","abstract":[{"type":"codeVoice","code":"Decodable"},{"type":"text","text":" initializer."}],"fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Decoder","preciseIdentifier":"s:s7DecoderP"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"role":"symbol","url":"\/documentation\/auth0\/passkeyloginchallenge\/init(from:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge\/init(from:)"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyLoginChallenge":{"title":"PasskeyLoginChallenge","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasskeyLoginChallenge"}],"navigatorTitle":[{"kind":"identifier","text":"PasskeyLoginChallenge"}],"abstract":[{"text":"A passkey login challenge.","type":"text"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge","url":"\/documentation\/auth0\/passkeyloginchallenge","type":"topic"}}} \ No newline at end of file +{"variants":[{"paths":["\/documentation\/auth0\/passkeyloginchallenge\/decodable-implementations"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"minor":3,"major":0,"patch":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge"]]},"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge\/init(from:)"],"anchor":"Initializers","title":"Initializers","generated":true}],"metadata":{"role":"collectionGroup","roleHeading":"API Collection","modules":[{"name":"Auth0"}],"title":"Decodable Implementations"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge\/Decodable-Implementations"},"kind":"article","references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyLoginChallenge":{"title":"PasskeyLoginChallenge","role":"symbol","navigatorTitle":[{"text":"PasskeyLoginChallenge","kind":"identifier"}],"kind":"symbol","abstract":[{"text":"A passkey login challenge.","type":"text"}],"url":"\/documentation\/auth0\/passkeyloginchallenge","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"PasskeyLoginChallenge"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyLoginChallenge/init(from:)":{"url":"\/documentation\/auth0\/passkeyloginchallenge\/init(from:)","title":"init(from:)","abstract":[{"type":"codeVoice","code":"Decodable"},{"type":"text","text":" initializer."}],"fragments":[{"kind":"identifier","text":"init"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"from"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:s7DecoderP","text":"Decoder","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"kind":"keyword","text":"throws"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge\/init(from:)","role":"symbol","kind":"symbol","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/passkeyloginchallenge/init(from:).json b/docs/data/documentation/auth0/passkeyloginchallenge/init(from:).json index 6b1c0b101..3653f31ef 100644 --- a/docs/data/documentation/auth0/passkeyloginchallenge/init(from:).json +++ b/docs/data/documentation/auth0/passkeyloginchallenge/init(from:).json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":" "},{"kind":"internalParam","text":"decoder"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP","text":"Decoder"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"platforms":["iOS"]}]}],"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge\/init(from:)","interfaceLanguage":"swift"},"schemaVersion":{"minor":3,"patch":0,"major":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge"]]},"metadata":{"roleHeading":"Initializer","modules":[{"name":"Auth0"}],"role":"symbol","externalID":"s:5Auth021PasskeyLoginChallengeV4fromACs7Decoder_p_tKcfc","title":"init(from:)","extendedModule":"Auth0","symbolKind":"init","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Decoder","preciseIdentifier":"s:s7DecoderP"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}]},"sections":[],"abstract":[{"type":"codeVoice","code":"Decodable"},{"type":"text","text":" initializer."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passkeyloginchallenge\/init(from:)"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasskeyLoginChallenge":{"title":"PasskeyLoginChallenge","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasskeyLoginChallenge"}],"navigatorTitle":[{"kind":"identifier","text":"PasskeyLoginChallenge"}],"abstract":[{"text":"A passkey login challenge.","type":"text"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge","url":"\/documentation\/auth0\/passkeyloginchallenge","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyLoginChallenge/init(from:)":{"kind":"symbol","type":"topic","title":"init(from:)","abstract":[{"type":"codeVoice","code":"Decodable"},{"type":"text","text":" initializer."}],"fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Decoder","preciseIdentifier":"s:s7DecoderP"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"role":"symbol","url":"\/documentation\/auth0\/passkeyloginchallenge\/init(from:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge\/init(from:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"sections":[],"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge\/init(from:)"},"metadata":{"externalID":"s:5Auth021PasskeyLoginChallengeV4fromACs7Decoder_p_tKcfc","modules":[{"name":"Auth0"}],"title":"init(from:)","extendedModule":"Auth0","roleHeading":"Initializer","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP","text":"Decoder"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"role":"symbol","symbolKind":"init"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passkeyloginchallenge\/init(from:)"]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":" "},{"kind":"internalParam","text":"decoder"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Decoder","preciseIdentifier":"s:s7DecoderP"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"platforms":["iOS"],"languages":["swift"]}]}],"abstract":[{"code":"Decodable","type":"codeVoice"},{"type":"text","text":" initializer."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasskeyLoginChallenge":{"title":"PasskeyLoginChallenge","role":"symbol","navigatorTitle":[{"text":"PasskeyLoginChallenge","kind":"identifier"}],"kind":"symbol","abstract":[{"text":"A passkey login challenge.","type":"text"}],"url":"\/documentation\/auth0\/passkeyloginchallenge","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"PasskeyLoginChallenge"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyLoginChallenge/init(from:)":{"url":"\/documentation\/auth0\/passkeyloginchallenge\/init(from:)","title":"init(from:)","abstract":[{"type":"codeVoice","code":"Decodable"},{"type":"text","text":" initializer."}],"fragments":[{"kind":"identifier","text":"init"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"from"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:s7DecoderP","text":"Decoder","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"kind":"keyword","text":"throws"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge\/init(from:)","role":"symbol","kind":"symbol","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/passkeyloginchallenge/relyingpartyid.json b/docs/data/documentation/auth0/passkeyloginchallenge/relyingpartyid.json index 618222662..8160c60c1 100644 --- a/docs/data/documentation/auth0/passkeyloginchallenge/relyingpartyid.json +++ b/docs/data/documentation/auth0/passkeyloginchallenge/relyingpartyid.json @@ -1 +1 @@ -{"schemaVersion":{"minor":3,"patch":0,"major":0},"sections":[],"metadata":{"title":"relyingPartyId","roleHeading":"Instance Property","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"relyingPartyId","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"externalID":"s:5Auth021PasskeyLoginChallengeV14relyingPartyIdSSvp","role":"symbol","modules":[{"name":"Auth0"}],"symbolKind":"property"},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge"]]},"variants":[{"paths":["\/documentation\/auth0\/passkeyloginchallenge\/relyingpartyid"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"type":"text","text":"Custom domain configured in the Auth0 tenant."}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge\/relyingPartyId","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"relyingPartyId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"languages":["swift"]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasskeyLoginChallenge":{"title":"PasskeyLoginChallenge","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasskeyLoginChallenge"}],"navigatorTitle":[{"kind":"identifier","text":"PasskeyLoginChallenge"}],"abstract":[{"text":"A passkey login challenge.","type":"text"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge","url":"\/documentation\/auth0\/passkeyloginchallenge","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyLoginChallenge/relyingPartyId":{"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"relyingPartyId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"type":"topic","url":"\/documentation\/auth0\/passkeyloginchallenge\/relyingpartyid","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge\/relyingPartyId","abstract":[{"type":"text","text":"Custom domain configured in the Auth0 tenant."}],"title":"relyingPartyId","kind":"symbol","role":"symbol"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge"]]},"metadata":{"symbolKind":"property","modules":[{"name":"Auth0"}],"title":"relyingPartyId","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"relyingPartyId","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"externalID":"s:5Auth021PasskeyLoginChallengeV14relyingPartyIdSSvp","role":"symbol","roleHeading":"Instance Property"},"sections":[],"abstract":[{"type":"text","text":"Custom domain configured in the Auth0 tenant."}],"variants":[{"paths":["\/documentation\/auth0\/passkeyloginchallenge\/relyingpartyid"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge\/relyingPartyId","interfaceLanguage":"swift"},"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"relyingPartyId","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyLoginChallenge":{"title":"PasskeyLoginChallenge","role":"symbol","navigatorTitle":[{"text":"PasskeyLoginChallenge","kind":"identifier"}],"kind":"symbol","abstract":[{"text":"A passkey login challenge.","type":"text"}],"url":"\/documentation\/auth0\/passkeyloginchallenge","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"PasskeyLoginChallenge"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeyLoginChallenge/relyingPartyId":{"kind":"symbol","title":"relyingPartyId","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"relyingPartyId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeyLoginChallenge\/relyingPartyId","abstract":[{"type":"text","text":"Custom domain configured in the Auth0 tenant."}],"url":"\/documentation\/auth0\/passkeyloginchallenge\/relyingpartyid"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/passkeysignupchallenge.json b/docs/data/documentation/auth0/passkeysignupchallenge.json index eed6bd2a3..b66920acf 100644 --- a/docs/data/documentation/auth0/passkeysignupchallenge.json +++ b/docs/data/documentation/auth0/passkeysignupchallenge.json @@ -1 +1 @@ -{"relationshipsSections":[{"title":"Conforms To","identifiers":["doc:\/\/com.auth0.Auth0\/s8CopyableP","doc:\/\/com.auth0.Auth0\/Se","doc:\/\/com.auth0.Auth0\/s8SendableP","doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP"],"type":"conformsTo","kind":"relationships"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge"},"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"type":"text","text":"A passkey signup challenge."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasskeySignupChallenge"}],"platforms":["iOS"]}]}],"topicSections":[{"title":"Instance Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge\/authenticationSession","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge\/challengeData","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge\/relyingPartyId","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge\/userId","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge\/userName"],"generated":true,"anchor":"Instance-Properties"},{"title":"Default Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge\/Decodable-Implementations"],"generated":true,"anchor":"Default-Implementations"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passkeysignupchallenge"]}],"sections":[],"metadata":{"symbolKind":"struct","externalID":"s:5Auth022PasskeySignupChallengeV","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeySignupChallenge","kind":"identifier"}],"navigatorTitle":[{"text":"PasskeySignupChallenge","kind":"identifier"}],"roleHeading":"Structure","title":"PasskeySignupChallenge","modules":[{"name":"Auth0"}],"role":"symbol"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasskeySignupChallenge/relyingPartyId":{"role":"symbol","url":"\/documentation\/auth0\/passkeysignupchallenge\/relyingpartyid","type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge\/relyingPartyId","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"relyingPartyId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"title":"relyingPartyId","abstract":[{"text":"Custom domain configured in the Auth0 tenant.","type":"text"}]},"doc://com.auth0.Auth0/Se":{"identifier":"doc:\/\/com.auth0.Auth0\/Se","type":"unresolvable","title":"Swift.Decodable"},"doc://com.auth0.Auth0/s8SendableP":{"identifier":"doc:\/\/com.auth0.Auth0\/s8SendableP","type":"unresolvable","title":"Swift.Sendable"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeySignupChallenge/userId":{"role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"userId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge\/userId","abstract":[{"text":"Generated unique identifier of the user.","type":"text"}],"kind":"symbol","title":"userId","type":"topic","url":"\/documentation\/auth0\/passkeysignupchallenge\/userid"},"doc://com.auth0.Auth0/s16SendableMetatypeP":{"identifier":"doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP","type":"unresolvable","title":"Swift.SendableMetatype"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeySignupChallenge/Decodable-Implementations":{"title":"Decodable Implementations","kind":"article","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge\/Decodable-Implementations","abstract":[],"role":"collectionGroup","type":"topic","url":"\/documentation\/auth0\/passkeysignupchallenge\/decodable-implementations"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/s8CopyableP":{"title":"Swift.Copyable","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s8CopyableP"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeySignupChallenge":{"type":"topic","abstract":[{"type":"text","text":"A passkey signup challenge."}],"kind":"symbol","title":"PasskeySignupChallenge","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge","role":"symbol","url":"\/documentation\/auth0\/passkeysignupchallenge","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasskeySignupChallenge"}],"navigatorTitle":[{"kind":"identifier","text":"PasskeySignupChallenge"}]},"doc://com.auth0.Auth0/documentation/Auth0/PasskeySignupChallenge/challengeData":{"title":"challengeData","kind":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"challengeData","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Data","preciseIdentifier":"s:10Foundation4DataV","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge\/challengeData","abstract":[{"type":"text","text":"Signup challenge data."}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/passkeysignupchallenge\/challengedata"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeySignupChallenge/authenticationSession":{"url":"\/documentation\/auth0\/passkeysignupchallenge\/authenticationsession","role":"symbol","title":"authenticationSession","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticationSession"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge\/authenticationSession","kind":"symbol","type":"topic","abstract":[{"text":"Unique identifier of the Auth0 session.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/PasskeySignupChallenge/userName":{"url":"\/documentation\/auth0\/passkeysignupchallenge\/username","title":"userName","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge\/userName","kind":"symbol","type":"topic","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"userName","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"abstract":[{"type":"text","text":"A user identifier, like the user’s email."}],"role":"symbol"}}} \ No newline at end of file +{"topicSections":[{"anchor":"Instance-Properties","title":"Instance Properties","generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge\/authenticationSession","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge\/challengeData","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge\/relyingPartyId","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge\/userId","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge\/userName"]},{"anchor":"Default-Implementations","title":"Default Implementations","generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge\/Decodable-Implementations"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"metadata":{"roleHeading":"Structure","navigatorTitle":[{"text":"PasskeySignupChallenge","kind":"identifier"}],"symbolKind":"struct","title":"PasskeySignupChallenge","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeySignupChallenge","kind":"identifier"}],"externalID":"s:5Auth022PasskeySignupChallengeV","modules":[{"name":"Auth0"}]},"sections":[],"abstract":[{"text":"A passkey signup challenge.","type":"text"}],"relationshipsSections":[{"title":"Conforms To","type":"conformsTo","kind":"relationships","identifiers":["doc:\/\/com.auth0.Auth0\/s8CopyableP","doc:\/\/com.auth0.Auth0\/Se","doc:\/\/com.auth0.Auth0\/s8SendableP","doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP"]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passkeysignupchallenge"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge","interfaceLanguage":"swift"},"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasskeySignupChallenge","kind":"identifier"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"references":{"doc://com.auth0.Auth0/s16SendableMetatypeP":{"title":"Swift.SendableMetatype","identifier":"doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeySignupChallenge/userName":{"url":"\/documentation\/auth0\/passkeysignupchallenge\/username","title":"userName","abstract":[{"type":"text","text":"A user identifier, like the user’s email."}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"userName"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge\/userName","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeySignupChallenge/challengeData":{"url":"\/documentation\/auth0\/passkeysignupchallenge\/challengedata","title":"challengeData","abstract":[{"type":"text","text":"Signup challenge data."}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"challengeData"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge\/challengeData","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/Se":{"title":"Swift.Decodable","identifier":"doc:\/\/com.auth0.Auth0\/Se","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeySignupChallenge":{"title":"PasskeySignupChallenge","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge","role":"symbol","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"PasskeySignupChallenge","kind":"identifier"}],"abstract":[{"text":"A passkey signup challenge.","type":"text"}],"url":"\/documentation\/auth0\/passkeysignupchallenge","navigatorTitle":[{"text":"PasskeySignupChallenge","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/PasskeySignupChallenge/Decodable-Implementations":{"url":"\/documentation\/auth0\/passkeysignupchallenge\/decodable-implementations","title":"Decodable Implementations","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge\/Decodable-Implementations","role":"collectionGroup","kind":"article","type":"topic"},"doc://com.auth0.Auth0/s8CopyableP":{"title":"Swift.Copyable","identifier":"doc:\/\/com.auth0.Auth0\/s8CopyableP","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeySignupChallenge/authenticationSession":{"url":"\/documentation\/auth0\/passkeysignupchallenge\/authenticationsession","title":"authenticationSession","abstract":[{"type":"text","text":"Unique identifier of the Auth0 session."}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticationSession"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge\/authenticationSession","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/s8SendableP":{"title":"Swift.Sendable","identifier":"doc:\/\/com.auth0.Auth0\/s8SendableP","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeySignupChallenge/relyingPartyId":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge\/relyingPartyId","title":"relyingPartyId","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"relyingPartyId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"role":"symbol","url":"\/documentation\/auth0\/passkeysignupchallenge\/relyingpartyid","abstract":[{"type":"text","text":"Custom domain configured in the Auth0 tenant."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeySignupChallenge/userId":{"url":"\/documentation\/auth0\/passkeysignupchallenge\/userid","title":"userId","abstract":[{"text":"Generated unique identifier of the user.","type":"text"}],"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"userId"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV","text":"Data"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge\/userId","role":"symbol","kind":"symbol","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/passkeysignupchallenge/authenticationsession.json b/docs/data/documentation/auth0/passkeysignupchallenge/authenticationsession.json index e62f30f3b..69952e6f4 100644 --- a/docs/data/documentation/auth0/passkeysignupchallenge/authenticationsession.json +++ b/docs/data/documentation/auth0/passkeysignupchallenge/authenticationsession.json @@ -1 +1 @@ -{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge\/authenticationSession"},"abstract":[{"text":"Unique identifier of the Auth0 session.","type":"text"}],"kind":"symbol","metadata":{"externalID":"s:5Auth022PasskeySignupChallengeV21authenticationSessionSSvp","role":"symbol","modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authenticationSession","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"symbolKind":"property","title":"authenticationSession"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge"]]},"schemaVersion":{"patch":0,"minor":3,"major":0},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticationSession"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"languages":["swift"]}],"kind":"declarations"}],"variants":[{"paths":["\/documentation\/auth0\/passkeysignupchallenge\/authenticationsession"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasskeySignupChallenge":{"type":"topic","abstract":[{"type":"text","text":"A passkey signup challenge."}],"kind":"symbol","title":"PasskeySignupChallenge","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge","role":"symbol","url":"\/documentation\/auth0\/passkeysignupchallenge","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasskeySignupChallenge"}],"navigatorTitle":[{"kind":"identifier","text":"PasskeySignupChallenge"}]},"doc://com.auth0.Auth0/documentation/Auth0/PasskeySignupChallenge/authenticationSession":{"url":"\/documentation\/auth0\/passkeysignupchallenge\/authenticationsession","role":"symbol","title":"authenticationSession","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticationSession"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge\/authenticationSession","kind":"symbol","type":"topic","abstract":[{"text":"Unique identifier of the Auth0 session.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"schemaVersion":{"patch":0,"minor":3,"major":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticationSession"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}]}]}],"sections":[],"abstract":[{"type":"text","text":"Unique identifier of the Auth0 session."}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passkeysignupchallenge\/authenticationsession"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge\/authenticationSession","interfaceLanguage":"swift"},"metadata":{"role":"symbol","title":"authenticationSession","modules":[{"name":"Auth0"}],"fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticationSession"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"externalID":"s:5Auth022PasskeySignupChallengeV21authenticationSessionSSvp","roleHeading":"Instance Property","symbolKind":"property"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasskeySignupChallenge":{"title":"PasskeySignupChallenge","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge","role":"symbol","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"PasskeySignupChallenge","kind":"identifier"}],"abstract":[{"text":"A passkey signup challenge.","type":"text"}],"url":"\/documentation\/auth0\/passkeysignupchallenge","navigatorTitle":[{"text":"PasskeySignupChallenge","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeySignupChallenge/authenticationSession":{"url":"\/documentation\/auth0\/passkeysignupchallenge\/authenticationsession","title":"authenticationSession","abstract":[{"type":"text","text":"Unique identifier of the Auth0 session."}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticationSession"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge\/authenticationSession","role":"symbol","kind":"symbol","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/passkeysignupchallenge/challengedata.json b/docs/data/documentation/auth0/passkeysignupchallenge/challengedata.json index e35bb9b82..899792f6d 100644 --- a/docs/data/documentation/auth0/passkeysignupchallenge/challengedata.json +++ b/docs/data/documentation/auth0/passkeysignupchallenge/challengedata.json @@ -1 +1 @@ -{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge\/challengeData"},"schemaVersion":{"major":0,"patch":0,"minor":3},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"challengeData"},{"kind":"text","text":": "},{"preciseIdentifier":"s:10Foundation4DataV","kind":"typeIdentifier","text":"Data"}]}],"kind":"declarations"}],"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge"]]},"abstract":[{"text":"Signup challenge data.","type":"text"}],"variants":[{"paths":["\/documentation\/auth0\/passkeysignupchallenge\/challengedata"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"role":"symbol","externalID":"s:5Auth022PasskeySignupChallengeV13challengeData10Foundation0F0Vvp","roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"title":"challengeData","symbolKind":"property","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"challengeData"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"}]},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/PasskeySignupChallenge":{"type":"topic","abstract":[{"type":"text","text":"A passkey signup challenge."}],"kind":"symbol","title":"PasskeySignupChallenge","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge","role":"symbol","url":"\/documentation\/auth0\/passkeysignupchallenge","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasskeySignupChallenge"}],"navigatorTitle":[{"kind":"identifier","text":"PasskeySignupChallenge"}]},"doc://com.auth0.Auth0/documentation/Auth0/PasskeySignupChallenge/challengeData":{"title":"challengeData","kind":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"challengeData","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Data","preciseIdentifier":"s:10Foundation4DataV","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge\/challengeData","abstract":[{"type":"text","text":"Signup challenge data."}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/passkeysignupchallenge\/challengedata"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"metadata":{"symbolKind":"property","roleHeading":"Instance Property","externalID":"s:5Auth022PasskeySignupChallengeV13challengeData10Foundation0F0Vvp","title":"challengeData","modules":[{"name":"Auth0"}],"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"challengeData","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Data","preciseIdentifier":"s:10Foundation4DataV","kind":"typeIdentifier"}],"role":"symbol"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passkeysignupchallenge\/challengedata"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge\/challengeData","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"type":"text","text":"Signup challenge data."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"challengeData","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Data","preciseIdentifier":"s:10Foundation4DataV","kind":"typeIdentifier"}],"platforms":["iOS"],"languages":["swift"]}]}],"schemaVersion":{"patch":0,"minor":3,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasskeySignupChallenge":{"title":"PasskeySignupChallenge","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge","role":"symbol","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"PasskeySignupChallenge","kind":"identifier"}],"abstract":[{"text":"A passkey signup challenge.","type":"text"}],"url":"\/documentation\/auth0\/passkeysignupchallenge","navigatorTitle":[{"text":"PasskeySignupChallenge","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/PasskeySignupChallenge/challengeData":{"url":"\/documentation\/auth0\/passkeysignupchallenge\/challengedata","title":"challengeData","abstract":[{"type":"text","text":"Signup challenge data."}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"challengeData"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge\/challengeData","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/passkeysignupchallenge/decodable-implementations.json b/docs/data/documentation/auth0/passkeysignupchallenge/decodable-implementations.json index d29216d0d..575042ba4 100644 --- a/docs/data/documentation/auth0/passkeysignupchallenge/decodable-implementations.json +++ b/docs/data/documentation/auth0/passkeysignupchallenge/decodable-implementations.json @@ -1 +1 @@ -{"metadata":{"modules":[{"name":"Auth0"}],"roleHeading":"API Collection","title":"Decodable Implementations","role":"collectionGroup"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge\/Decodable-Implementations","interfaceLanguage":"swift"},"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"kind":"article","topicSections":[{"anchor":"Initializers","generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge\/init(from:)"],"title":"Initializers"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passkeysignupchallenge\/decodable-implementations"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasskeySignupChallenge":{"type":"topic","abstract":[{"type":"text","text":"A passkey signup challenge."}],"kind":"symbol","title":"PasskeySignupChallenge","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge","role":"symbol","url":"\/documentation\/auth0\/passkeysignupchallenge","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasskeySignupChallenge"}],"navigatorTitle":[{"kind":"identifier","text":"PasskeySignupChallenge"}]},"doc://com.auth0.Auth0/documentation/Auth0/PasskeySignupChallenge/init(from:)":{"url":"\/documentation\/auth0\/passkeysignupchallenge\/init(from:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge\/init(from:)","kind":"symbol","abstract":[{"type":"codeVoice","code":"Decodable"},{"text":" initializer.","type":"text"}],"type":"topic","title":"init(from:)","role":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Decoder","preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passkeysignupchallenge\/decodable-implementations"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge"]]},"topicSections":[{"title":"Initializers","generated":true,"anchor":"Initializers","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge\/init(from:)"]}],"kind":"article","schemaVersion":{"patch":0,"major":0,"minor":3},"sections":[],"metadata":{"role":"collectionGroup","title":"Decodable Implementations","roleHeading":"API Collection","modules":[{"name":"Auth0"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge\/Decodable-Implementations","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeySignupChallenge/init(from:)":{"type":"topic","title":"init(from:)","url":"\/documentation\/auth0\/passkeysignupchallenge\/init(from:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge\/init(from:)","abstract":[{"code":"Decodable","type":"codeVoice"},{"text":" initializer.","type":"text"}],"role":"symbol","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Decoder","preciseIdentifier":"s:s7DecoderP"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}]},"doc://com.auth0.Auth0/documentation/Auth0/PasskeySignupChallenge":{"title":"PasskeySignupChallenge","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge","role":"symbol","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"PasskeySignupChallenge","kind":"identifier"}],"abstract":[{"text":"A passkey signup challenge.","type":"text"}],"url":"\/documentation\/auth0\/passkeysignupchallenge","navigatorTitle":[{"text":"PasskeySignupChallenge","kind":"identifier"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/passkeysignupchallenge/init(from:).json b/docs/data/documentation/auth0/passkeysignupchallenge/init(from:).json index 719a5ffd4..ab5b72a49 100644 --- a/docs/data/documentation/auth0/passkeysignupchallenge/init(from:).json +++ b/docs/data/documentation/auth0/passkeysignupchallenge/init(from:).json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge"]]},"abstract":[{"code":"Decodable","type":"codeVoice"},{"text":" initializer.","type":"text"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passkeysignupchallenge\/init(from:)"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"init","kind":"keyword"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"decoder","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"Decoder","kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"platforms":["iOS"]}]}],"kind":"symbol","sections":[],"schemaVersion":{"major":0,"patch":0,"minor":3},"metadata":{"role":"symbol","symbolKind":"init","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP","text":"Decoder"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"externalID":"s:5Auth022PasskeySignupChallengeV4fromACs7Decoder_p_tKcfc","extendedModule":"Auth0","roleHeading":"Initializer","modules":[{"name":"Auth0"}],"title":"init(from:)"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge\/init(from:)"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasskeySignupChallenge/init(from:)":{"url":"\/documentation\/auth0\/passkeysignupchallenge\/init(from:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge\/init(from:)","kind":"symbol","abstract":[{"type":"codeVoice","code":"Decodable"},{"text":" initializer.","type":"text"}],"type":"topic","title":"init(from:)","role":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Decoder","preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}]},"doc://com.auth0.Auth0/documentation/Auth0/PasskeySignupChallenge":{"type":"topic","abstract":[{"type":"text","text":"A passkey signup challenge."}],"kind":"symbol","title":"PasskeySignupChallenge","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge","role":"symbol","url":"\/documentation\/auth0\/passkeysignupchallenge","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasskeySignupChallenge"}],"navigatorTitle":[{"kind":"identifier","text":"PasskeySignupChallenge"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passkeysignupchallenge\/init(from:)"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge"]]},"abstract":[{"code":"Decodable","type":"codeVoice"},{"text":" initializer.","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"init","kind":"keyword"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"decoder","kind":"internalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:s7DecoderP","text":"Decoder","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"platforms":["iOS"]}]}],"sections":[],"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"externalID":"s:5Auth022PasskeySignupChallengeV4fromACs7Decoder_p_tKcfc","extendedModule":"Auth0","symbolKind":"init","title":"init(from:)","role":"symbol","roleHeading":"Initializer","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Decoder","preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"modules":[{"name":"Auth0"}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge\/init(from:)"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeySignupChallenge":{"title":"PasskeySignupChallenge","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge","role":"symbol","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"PasskeySignupChallenge","kind":"identifier"}],"abstract":[{"text":"A passkey signup challenge.","type":"text"}],"url":"\/documentation\/auth0\/passkeysignupchallenge","navigatorTitle":[{"text":"PasskeySignupChallenge","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/PasskeySignupChallenge/init(from:)":{"type":"topic","title":"init(from:)","url":"\/documentation\/auth0\/passkeysignupchallenge\/init(from:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge\/init(from:)","abstract":[{"code":"Decodable","type":"codeVoice"},{"text":" initializer.","type":"text"}],"role":"symbol","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Decoder","preciseIdentifier":"s:s7DecoderP"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/passkeysignupchallenge/relyingpartyid.json b/docs/data/documentation/auth0/passkeysignupchallenge/relyingpartyid.json index 934202ffd..d2d9e492f 100644 --- a/docs/data/documentation/auth0/passkeysignupchallenge/relyingpartyid.json +++ b/docs/data/documentation/auth0/passkeysignupchallenge/relyingpartyid.json @@ -1 +1 @@ -{"metadata":{"title":"relyingPartyId","modules":[{"name":"Auth0"}],"externalID":"s:5Auth022PasskeySignupChallengeV14relyingPartyIdSSvp","roleHeading":"Instance Property","role":"symbol","symbolKind":"property","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"relyingPartyId","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}]},"variants":[{"paths":["\/documentation\/auth0\/passkeysignupchallenge\/relyingpartyid"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge\/relyingPartyId","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Custom domain configured in the Auth0 tenant."}],"primaryContentSections":[{"declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"relyingPartyId","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"schemaVersion":{"patch":0,"minor":3,"major":0},"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasskeySignupChallenge/relyingPartyId":{"role":"symbol","url":"\/documentation\/auth0\/passkeysignupchallenge\/relyingpartyid","type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge\/relyingPartyId","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"relyingPartyId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"title":"relyingPartyId","abstract":[{"text":"Custom domain configured in the Auth0 tenant.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeySignupChallenge":{"type":"topic","abstract":[{"type":"text","text":"A passkey signup challenge."}],"kind":"symbol","title":"PasskeySignupChallenge","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge","role":"symbol","url":"\/documentation\/auth0\/passkeysignupchallenge","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasskeySignupChallenge"}],"navigatorTitle":[{"kind":"identifier","text":"PasskeySignupChallenge"}]}}} \ No newline at end of file +{"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge\/relyingPartyId"},"metadata":{"modules":[{"name":"Auth0"}],"externalID":"s:5Auth022PasskeySignupChallengeV14relyingPartyIdSSvp","title":"relyingPartyId","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"relyingPartyId","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"roleHeading":"Instance Property","role":"symbol","symbolKind":"property"},"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passkeysignupchallenge\/relyingpartyid"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"relyingPartyId","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"languages":["swift"],"platforms":["iOS"]}]}],"abstract":[{"type":"text","text":"Custom domain configured in the Auth0 tenant."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeySignupChallenge":{"title":"PasskeySignupChallenge","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge","role":"symbol","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"PasskeySignupChallenge","kind":"identifier"}],"abstract":[{"text":"A passkey signup challenge.","type":"text"}],"url":"\/documentation\/auth0\/passkeysignupchallenge","navigatorTitle":[{"text":"PasskeySignupChallenge","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/PasskeySignupChallenge/relyingPartyId":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge\/relyingPartyId","title":"relyingPartyId","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"relyingPartyId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"role":"symbol","url":"\/documentation\/auth0\/passkeysignupchallenge\/relyingpartyid","abstract":[{"type":"text","text":"Custom domain configured in the Auth0 tenant."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/passkeysignupchallenge/userid.json b/docs/data/documentation/auth0/passkeysignupchallenge/userid.json index 7ef2a42bb..6d0ba31ea 100644 --- a/docs/data/documentation/auth0/passkeysignupchallenge/userid.json +++ b/docs/data/documentation/auth0/passkeysignupchallenge/userid.json @@ -1 +1 @@ -{"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge"]]},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passkeysignupchallenge\/userid"]}],"abstract":[{"type":"text","text":"Generated unique identifier of the user."}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge\/userId"},"metadata":{"modules":[{"name":"Auth0"}],"title":"userId","roleHeading":"Instance Property","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"userId","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Data","preciseIdentifier":"s:10Foundation4DataV","kind":"typeIdentifier"}],"externalID":"s:5Auth022PasskeySignupChallengeV6userId10Foundation4DataVvp","role":"symbol","symbolKind":"property"},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"userId","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Data","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV"}]}],"kind":"declarations"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasskeySignupChallenge/userId":{"role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"userId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge\/userId","abstract":[{"text":"Generated unique identifier of the user.","type":"text"}],"kind":"symbol","title":"userId","type":"topic","url":"\/documentation\/auth0\/passkeysignupchallenge\/userid"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeySignupChallenge":{"type":"topic","abstract":[{"type":"text","text":"A passkey signup challenge."}],"kind":"symbol","title":"PasskeySignupChallenge","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge","role":"symbol","url":"\/documentation\/auth0\/passkeysignupchallenge","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasskeySignupChallenge"}],"navigatorTitle":[{"kind":"identifier","text":"PasskeySignupChallenge"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge"]]},"metadata":{"modules":[{"name":"Auth0"}],"title":"userId","roleHeading":"Instance Property","symbolKind":"property","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"userId","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV","text":"Data"}],"externalID":"s:5Auth022PasskeySignupChallengeV6userId10Foundation4DataVvp"},"sections":[],"abstract":[{"type":"text","text":"Generated unique identifier of the user."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passkeysignupchallenge\/userid"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge\/userId"},"kind":"symbol","schemaVersion":{"minor":3,"patch":0,"major":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"userId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"}]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasskeySignupChallenge/userId":{"url":"\/documentation\/auth0\/passkeysignupchallenge\/userid","title":"userId","abstract":[{"text":"Generated unique identifier of the user.","type":"text"}],"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"userId"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV","text":"Data"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge\/userId","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeySignupChallenge":{"title":"PasskeySignupChallenge","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge","role":"symbol","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"PasskeySignupChallenge","kind":"identifier"}],"abstract":[{"text":"A passkey signup challenge.","type":"text"}],"url":"\/documentation\/auth0\/passkeysignupchallenge","navigatorTitle":[{"text":"PasskeySignupChallenge","kind":"identifier"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/passkeysignupchallenge/username.json b/docs/data/documentation/auth0/passkeysignupchallenge/username.json index 75a8bee58..fa916e9e2 100644 --- a/docs/data/documentation/auth0/passkeysignupchallenge/username.json +++ b/docs/data/documentation/auth0/passkeysignupchallenge/username.json @@ -1 +1 @@ -{"abstract":[{"text":"A user identifier, like the user’s email.","type":"text"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge\/userName"},"kind":"symbol","schemaVersion":{"patch":0,"major":0,"minor":3},"metadata":{"roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"title":"userName","role":"symbol","externalID":"s:5Auth022PasskeySignupChallengeV8userNameSSvp","symbolKind":"property","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"userName","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}]},"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"userName"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"platforms":["iOS"]}],"kind":"declarations"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passkeysignupchallenge\/username"]}],"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/PasskeySignupChallenge":{"type":"topic","abstract":[{"type":"text","text":"A passkey signup challenge."}],"kind":"symbol","title":"PasskeySignupChallenge","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge","role":"symbol","url":"\/documentation\/auth0\/passkeysignupchallenge","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasskeySignupChallenge"}],"navigatorTitle":[{"kind":"identifier","text":"PasskeySignupChallenge"}]},"doc://com.auth0.Auth0/documentation/Auth0/PasskeySignupChallenge/userName":{"url":"\/documentation\/auth0\/passkeysignupchallenge\/username","title":"userName","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge\/userName","kind":"symbol","type":"topic","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"userName","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"abstract":[{"type":"text","text":"A user identifier, like the user’s email."}],"role":"symbol"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge"]]},"metadata":{"symbolKind":"property","modules":[{"name":"Auth0"}],"title":"userName","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"userName"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"externalID":"s:5Auth022PasskeySignupChallengeV8userNameSSvp","role":"symbol","roleHeading":"Instance Property"},"sections":[],"abstract":[{"type":"text","text":"A user identifier, like the user’s email."}],"variants":[{"paths":["\/documentation\/auth0\/passkeysignupchallenge\/username"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge\/userName","interfaceLanguage":"swift"},"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"userName"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasskeySignupChallenge":{"title":"PasskeySignupChallenge","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge","role":"symbol","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"PasskeySignupChallenge","kind":"identifier"}],"abstract":[{"text":"A passkey signup challenge.","type":"text"}],"url":"\/documentation\/auth0\/passkeysignupchallenge","navigatorTitle":[{"text":"PasskeySignupChallenge","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/PasskeySignupChallenge/userName":{"url":"\/documentation\/auth0\/passkeysignupchallenge\/username","title":"userName","abstract":[{"type":"text","text":"A user identifier, like the user’s email."}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"userName"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasskeySignupChallenge\/userName","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/passwordlesstype.json b/docs/data/documentation/auth0/passwordlesstype.json index bc46c86fd..61ced6986 100644 --- a/docs/data/documentation/auth0/passwordlesstype.json +++ b/docs/data/documentation/auth0/passwordlesstype.json @@ -1 +1 @@ -{"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"relationshipsSections":[{"kind":"relationships","title":"Conforms To","identifiers":["doc:\/\/com.auth0.Auth0\/SQ","doc:\/\/com.auth0.Auth0\/SH","doc:\/\/com.auth0.Auth0\/SY"],"type":"conformsTo"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasswordlessType","kind":"identifier"}]}]}],"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"],"generated":true,"anchor":"Enumeration-Cases"},{"title":"Initializers","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/init(rawValue:)"],"generated":true,"anchor":"Initializers"},{"title":"Default Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/Equatable-Implementations","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/RawRepresentable-Implementations"],"generated":true,"anchor":"Default-Implementations"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passwordlesstype"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"},"abstract":[{"text":"Types of passwordless authentication.","type":"text"}],"metadata":{"navigatorTitle":[{"text":"PasswordlessType","kind":"identifier"}],"role":"symbol","modules":[{"name":"Auth0"}],"title":"PasswordlessType","symbolKind":"enum","roleHeading":"Enumeration","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasswordlessType","kind":"identifier"}],"externalID":"s:5Auth016PasswordlessTypeO"},"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/init(rawValue:)":{"type":"topic","url":"\/documentation\/auth0\/passwordlesstype\/init(rawvalue:)","fragments":[{"text":"init","kind":"identifier"},{"text":"?(","kind":"text"},{"text":"rawValue","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":")","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/init(rawValue:)","role":"symbol","abstract":[],"kind":"symbol","title":"init(rawValue:)"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/iOSLink":{"abstract":[{"type":"text","text":"Universal Link."}],"kind":"symbol","url":"\/documentation\/auth0\/passwordlesstype\/ioslink","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/iOSLink","type":"topic","title":"PasswordlessType.iOSLink","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"iOSLink"}]},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/webLink":{"title":"PasswordlessType.webLink","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/webLink","url":"\/documentation\/auth0\/passwordlesstype\/weblink","abstract":[{"type":"text","text":"Regular Web HTTP link (web only, uses a redirect)."}],"type":"topic","kind":"symbol","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"webLink","kind":"identifier"}],"role":"symbol"},"doc://com.auth0.Auth0/SY":{"type":"unresolvable","title":"Swift.RawRepresentable","identifier":"doc:\/\/com.auth0.Auth0\/SY"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/androidLink":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/androidLink","title":"PasswordlessType.androidLink","type":"topic","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"androidLink"}],"abstract":[{"type":"text","text":"Android App Link."}],"url":"\/documentation\/auth0\/passwordlesstype\/androidlink","role":"symbol","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/code":{"title":"PasswordlessType.code","type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/code","abstract":[{"text":"Simple OTP code sent by email or SMS.","type":"text"}],"url":"\/documentation\/auth0\/passwordlesstype\/code","role":"symbol","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"code"}]},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"url":"\/documentation\/auth0\/passwordlesstype","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasswordlessType"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","type":"topic","navigatorTitle":[{"kind":"identifier","text":"PasswordlessType"}],"kind":"symbol","title":"PasswordlessType","abstract":[{"type":"text","text":"Types of passwordless authentication."}]},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/Equatable-Implementations":{"title":"Equatable Implementations","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/Equatable-Implementations","role":"collectionGroup","type":"topic","kind":"article","url":"\/documentation\/auth0\/passwordlesstype\/equatable-implementations"},"doc://com.auth0.Auth0/SQ":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/SQ","title":"Swift.Equatable"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/RawRepresentable-Implementations":{"title":"RawRepresentable Implementations","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/RawRepresentable-Implementations","role":"collectionGroup","type":"topic","kind":"article","url":"\/documentation\/auth0\/passwordlesstype\/rawrepresentable-implementations"},"doc://com.auth0.Auth0/SH":{"type":"unresolvable","title":"Swift.Hashable","identifier":"doc:\/\/com.auth0.Auth0\/SH"}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passwordlesstype"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"abstract":[{"type":"text","text":"Types of passwordless authentication."}],"topicSections":[{"generated":true,"anchor":"Enumeration-Cases","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"]},{"generated":true,"anchor":"Initializers","title":"Initializers","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/init(rawValue:)"]},{"generated":true,"anchor":"Default-Implementations","title":"Default Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/Equatable-Implementations","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/RawRepresentable-Implementations"]}],"sections":[],"kind":"symbol","schemaVersion":{"patch":0,"major":0,"minor":3},"relationshipsSections":[{"type":"conformsTo","kind":"relationships","title":"Conforms To","identifiers":["doc:\/\/com.auth0.Auth0\/SQ","doc:\/\/com.auth0.Auth0\/SH","doc:\/\/com.auth0.Auth0\/SY"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasswordlessType","kind":"identifier"}]}]}],"metadata":{"externalID":"s:5Auth016PasswordlessTypeO","symbolKind":"enum","title":"PasswordlessType","roleHeading":"Enumeration","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PasswordlessType","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"PasswordlessType"}],"modules":[{"name":"Auth0"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/iOSLink":{"type":"topic","abstract":[{"type":"text","text":"Universal Link."}],"kind":"symbol","url":"\/documentation\/auth0\/passwordlesstype\/ioslink","title":"PasswordlessType.iOSLink","role":"symbol","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"iOSLink"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/iOSLink"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/androidLink":{"kind":"symbol","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"androidLink","kind":"identifier"}],"title":"PasswordlessType.androidLink","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Android App Link."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/androidLink","url":"\/documentation\/auth0\/passwordlesstype\/androidlink"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"navigatorTitle":[{"kind":"identifier","text":"PasswordlessType"}],"kind":"symbol","url":"\/documentation\/auth0\/passwordlesstype","role":"symbol","abstract":[{"type":"text","text":"Types of passwordless authentication."}],"type":"topic","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasswordlessType"}],"title":"PasswordlessType","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/webLink":{"kind":"symbol","title":"PasswordlessType.webLink","role":"symbol","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"webLink","kind":"identifier"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/webLink","abstract":[{"text":"Regular Web HTTP link (web only, uses a redirect).","type":"text"}],"url":"\/documentation\/auth0\/passwordlesstype\/weblink"},"doc://com.auth0.Auth0/SQ":{"type":"unresolvable","title":"Swift.Equatable","identifier":"doc:\/\/com.auth0.Auth0\/SQ"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/Equatable-Implementations":{"type":"topic","abstract":[],"kind":"article","url":"\/documentation\/auth0\/passwordlesstype\/equatable-implementations","title":"Equatable Implementations","role":"collectionGroup","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/Equatable-Implementations"},"doc://com.auth0.Auth0/SY":{"type":"unresolvable","title":"Swift.RawRepresentable","identifier":"doc:\/\/com.auth0.Auth0\/SY"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/code":{"kind":"symbol","url":"\/documentation\/auth0\/passwordlesstype\/code","role":"symbol","abstract":[{"type":"text","text":"Simple OTP code sent by email or SMS."}],"type":"topic","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"code"}],"title":"PasswordlessType.code","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/code"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/RawRepresentable-Implementations":{"type":"topic","abstract":[],"kind":"article","url":"\/documentation\/auth0\/passwordlesstype\/rawrepresentable-implementations","title":"RawRepresentable Implementations","role":"collectionGroup","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/RawRepresentable-Implementations"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/init(rawValue:)":{"role":"symbol","title":"init(rawValue:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"?("},{"kind":"externalParam","text":"rawValue"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":")"}],"abstract":[],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/init(rawValue:)","url":"\/documentation\/auth0\/passwordlesstype\/init(rawvalue:)","type":"topic"},"doc://com.auth0.Auth0/SH":{"type":"unresolvable","title":"Swift.Hashable","identifier":"doc:\/\/com.auth0.Auth0\/SH"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/passwordlesstype/!=(_:_:).json b/docs/data/documentation/auth0/passwordlesstype/!=(_:_:).json index 3f3311cbf..9b7bcbcfb 100644 --- a/docs/data/documentation/auth0/passwordlesstype/!=(_:_:).json +++ b/docs/data/documentation/auth0/passwordlesstype/!=(_:_:).json @@ -1 +1 @@ -{"kind":"symbol","sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/!=(_:_:)","interfaceLanguage":"swift"},"schemaVersion":{"major":0,"patch":0,"minor":3},"abstract":[{"text":"Inherited from ","type":"text"},{"code":"Equatable.!=(_:_:)","type":"codeVoice"},{"text":".","type":"text"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passwordlesstype\/!=(_:_:)"]}],"metadata":{"extendedModule":"Swift","roleHeading":"Operator","role":"symbol","symbolKind":"op","title":"!=(_:_:)","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"modules":[{"relatedModules":["Swift"],"name":"Auth0"}],"externalID":"s:SQsE2neoiySbx_xtFZ::SYNTHESIZED::s:5Auth016PasswordlessTypeO"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"!="},{"kind":"text","text":" "},{"kind":"text","text":"("},{"kind":"internalParam","text":"lhs"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":", "},{"kind":"internalParam","text":"rhs"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"languages":["swift"],"platforms":["iOS"]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/!=(_:_:)":{"kind":"symbol","abstract":[],"fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"type":"topic","role":"symbol","url":"\/documentation\/auth0\/passwordlesstype\/!=(_:_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/!=(_:_:)","title":"!=(_:_:)"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"url":"\/documentation\/auth0\/passwordlesstype","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasswordlessType"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","type":"topic","navigatorTitle":[{"kind":"identifier","text":"PasswordlessType"}],"kind":"symbol","title":"PasswordlessType","abstract":[{"type":"text","text":"Types of passwordless authentication."}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"variants":[{"paths":["\/documentation\/auth0\/passwordlesstype\/!=(_:_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"]]},"abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"Equatable.!=(_:_:)"},{"type":"text","text":"."}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"static"},{"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"},{"kind":"internalParam","text":"rhs"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"platforms":["iOS"]}],"kind":"declarations"}],"schemaVersion":{"patch":0,"minor":3,"major":0},"kind":"symbol","sections":[],"metadata":{"externalID":"s:SQsE2neoiySbx_xtFZ::SYNTHESIZED::s:5Auth016PasswordlessTypeO","extendedModule":"Swift","symbolKind":"op","title":"!=(_:_:)","role":"symbol","roleHeading":"Operator","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"modules":[{"relatedModules":["Swift"],"name":"Auth0"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/!=(_:_:)","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"navigatorTitle":[{"kind":"identifier","text":"PasswordlessType"}],"kind":"symbol","url":"\/documentation\/auth0\/passwordlesstype","role":"symbol","abstract":[{"type":"text","text":"Types of passwordless authentication."}],"type":"topic","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasswordlessType"}],"title":"PasswordlessType","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/!=(_:_:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/!=(_:_:)","title":"!=(_:_:)","type":"topic","role":"symbol","kind":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"abstract":[],"url":"\/documentation\/auth0\/passwordlesstype\/!=(_:_:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ 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 c57b5dcac..3b585ecc8 100644 --- a/docs/data/documentation/auth0/passwordlesstype/androidlink.json +++ b/docs/data/documentation/auth0/passwordlesstype/androidlink.json @@ -1 +1 @@ -{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/androidLink"},"sections":[],"kind":"symbol","primaryContentSections":[{"declarations":[{"tokens":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"androidLink","kind":"identifier"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"metadata":{"fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"androidLink"}],"externalID":"s:5Auth016PasswordlessTypeO11androidLinkyA2CmF","roleHeading":"Case","symbolKind":"case","title":"PasswordlessType.androidLink","role":"symbol","modules":[{"name":"Auth0"}]},"schemaVersion":{"major":0,"patch":0,"minor":3},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"]]},"abstract":[{"text":"Android App Link.","type":"text"}],"variants":[{"paths":["\/documentation\/auth0\/passwordlesstype\/androidlink"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"url":"\/documentation\/auth0\/passwordlesstype","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasswordlessType"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","type":"topic","navigatorTitle":[{"kind":"identifier","text":"PasswordlessType"}],"kind":"symbol","title":"PasswordlessType","abstract":[{"type":"text","text":"Types of passwordless authentication."}]},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/androidLink":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/androidLink","title":"PasswordlessType.androidLink","type":"topic","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"androidLink"}],"abstract":[{"type":"text","text":"Android App Link."}],"url":"\/documentation\/auth0\/passwordlesstype\/androidlink","role":"symbol","kind":"symbol"}}} \ No newline at end of file +{"abstract":[{"type":"text","text":"Android App Link."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"androidLink","kind":"identifier"}],"languages":["swift"],"platforms":["iOS"]}]}],"variants":[{"paths":["\/documentation\/auth0\/passwordlesstype\/androidlink"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"]]},"metadata":{"modules":[{"name":"Auth0"}],"symbolKind":"case","roleHeading":"Case","title":"PasswordlessType.androidLink","role":"symbol","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"androidLink","kind":"identifier"}],"externalID":"s:5Auth016PasswordlessTypeO11androidLinkyA2CmF"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/androidLink"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/androidLink":{"kind":"symbol","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"androidLink","kind":"identifier"}],"title":"PasswordlessType.androidLink","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Android App Link."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/androidLink","url":"\/documentation\/auth0\/passwordlesstype\/androidlink"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"navigatorTitle":[{"kind":"identifier","text":"PasswordlessType"}],"kind":"symbol","url":"\/documentation\/auth0\/passwordlesstype","role":"symbol","abstract":[{"type":"text","text":"Types of passwordless authentication."}],"type":"topic","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasswordlessType"}],"title":"PasswordlessType","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/passwordlesstype/code.json b/docs/data/documentation/auth0/passwordlesstype/code.json index f592c5dd6..3a280e7eb 100644 --- a/docs/data/documentation/auth0/passwordlesstype/code.json +++ b/docs/data/documentation/auth0/passwordlesstype/code.json @@ -1 +1 @@ -{"abstract":[{"text":"Simple OTP code sent by email or SMS.","type":"text"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passwordlesstype\/code"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"]]},"sections":[],"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"roleHeading":"Case","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"code","kind":"identifier"}],"role":"symbol","symbolKind":"case","externalID":"s:5Auth016PasswordlessTypeO4codeyA2CmF","modules":[{"name":"Auth0"}],"title":"PasswordlessType.code"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/code"},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"code"}]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"url":"\/documentation\/auth0\/passwordlesstype","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasswordlessType"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","type":"topic","navigatorTitle":[{"kind":"identifier","text":"PasswordlessType"}],"kind":"symbol","title":"PasswordlessType","abstract":[{"type":"text","text":"Types of passwordless authentication."}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/code":{"title":"PasswordlessType.code","type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/code","abstract":[{"text":"Simple OTP code sent by email or SMS.","type":"text"}],"url":"\/documentation\/auth0\/passwordlesstype\/code","role":"symbol","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"code"}]}}} \ No newline at end of file +{"sections":[],"variants":[{"paths":["\/documentation\/auth0\/passwordlesstype\/code"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","abstract":[{"type":"text","text":"Simple OTP code sent by email or SMS."}],"metadata":{"roleHeading":"Case","role":"symbol","title":"PasswordlessType.code","symbolKind":"case","externalID":"s:5Auth016PasswordlessTypeO4codeyA2CmF","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"]]},"schemaVersion":{"patch":0,"major":0,"minor":3},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/code"},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"case"},{"text":" ","kind":"text"},{"text":"code","kind":"identifier"}],"languages":["swift"]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/code":{"kind":"symbol","url":"\/documentation\/auth0\/passwordlesstype\/code","role":"symbol","abstract":[{"type":"text","text":"Simple OTP code sent by email or SMS."}],"type":"topic","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"code"}],"title":"PasswordlessType.code","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/code"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"navigatorTitle":[{"kind":"identifier","text":"PasswordlessType"}],"kind":"symbol","url":"\/documentation\/auth0\/passwordlesstype","role":"symbol","abstract":[{"type":"text","text":"Types of passwordless authentication."}],"type":"topic","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasswordlessType"}],"title":"PasswordlessType","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"}}} \ 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 681104f91..8e00bff90 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"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passwordlesstype\/equatable-implementations"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/Equatable-Implementations","interfaceLanguage":"swift"},"sections":[],"topicSections":[{"title":"Operators","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/!=(_:_:)"],"generated":true,"anchor":"Operators"}],"metadata":{"roleHeading":"API Collection","modules":[{"name":"Auth0"}],"role":"collectionGroup","title":"Equatable Implementations"},"schemaVersion":{"minor":3,"patch":0,"major":0},"kind":"article","references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"url":"\/documentation\/auth0\/passwordlesstype","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasswordlessType"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","type":"topic","navigatorTitle":[{"kind":"identifier","text":"PasswordlessType"}],"kind":"symbol","title":"PasswordlessType","abstract":[{"type":"text","text":"Types of passwordless authentication."}]},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/!=(_:_:)":{"kind":"symbol","abstract":[],"fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"type":"topic","role":"symbol","url":"\/documentation\/auth0\/passwordlesstype\/!=(_:_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/!=(_:_:)","title":"!=(_:_:)"}}} \ No newline at end of file +{"sections":[],"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","metadata":{"modules":[{"name":"Auth0"}],"title":"Equatable Implementations","role":"collectionGroup","roleHeading":"API Collection"},"schemaVersion":{"minor":3,"patch":0,"major":0},"topicSections":[{"anchor":"Operators","title":"Operators","generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/!=(_:_:)"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"navigatorTitle":[{"kind":"identifier","text":"PasswordlessType"}],"kind":"symbol","url":"\/documentation\/auth0\/passwordlesstype","role":"symbol","abstract":[{"type":"text","text":"Types of passwordless authentication."}],"type":"topic","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasswordlessType"}],"title":"PasswordlessType","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/!=(_:_:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/!=(_:_:)","title":"!=(_:_:)","type":"topic","role":"symbol","kind":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"abstract":[],"url":"\/documentation\/auth0\/passwordlesstype\/!=(_:_:)"}}} \ 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 f5b3dc141..5e14011b2 100644 --- a/docs/data/documentation/auth0/passwordlesstype/hash(into:).json +++ b/docs/data/documentation/auth0/passwordlesstype/hash(into:).json @@ -1 +1 @@ -{"abstract":[{"type":"text","text":"Inherited from "},{"code":"RawRepresentable.hash(into:)","type":"codeVoice"},{"type":"text","text":"."}],"metadata":{"roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"hash"},{"kind":"text","text":"("},{"kind":"externalParam","text":"into"},{"kind":"text","text":": "},{"kind":"keyword","text":"inout"},{"kind":"text","text":" "},{"preciseIdentifier":"s:s6HasherV","kind":"typeIdentifier","text":"Hasher"},{"kind":"text","text":")"}],"extendedModule":"Swift","role":"symbol","externalID":"s:SYsSHRzSH8RawValueSYRpzrlE4hash4intoys6HasherVz_tF::SYNTHESIZED::s:5Auth016PasswordlessTypeO","symbolKind":"method","conformance":{"conformancePrefix":[{"type":"text","text":"Conforms when"}],"availabilityPrefix":[{"type":"text","text":"Available when"}],"constraints":[{"type":"codeVoice","code":"Self"},{"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":"."}]},"modules":[{"name":"Auth0","relatedModules":["Swift"]}],"title":"hash(into:)"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/hash(into:)","interfaceLanguage":"swift"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passwordlesstype\/hash(into:)"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"hash"},{"kind":"text","text":"("},{"kind":"externalParam","text":"into"},{"kind":"text","text":" "},{"kind":"internalParam","text":"hasher"},{"kind":"text","text":": "},{"kind":"keyword","text":"inout"},{"kind":"text","text":" "},{"preciseIdentifier":"s:s6HasherV","kind":"typeIdentifier","text":"Hasher"},{"kind":"text","text":")"}]}]}],"sections":[],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"]]},"schemaVersion":{"minor":3,"patch":0,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/hash(into:)":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"hash"},{"kind":"text","text":"("},{"kind":"externalParam","text":"into"},{"kind":"text","text":": "},{"kind":"keyword","text":"inout"},{"kind":"text","text":" "},{"preciseIdentifier":"s:s6HasherV","kind":"typeIdentifier","text":"Hasher"},{"kind":"text","text":")"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/hash(into:)","role":"symbol","kind":"symbol","url":"\/documentation\/auth0\/passwordlesstype\/hash(into:)","conformance":{"conformancePrefix":[{"type":"text","text":"Conforms when"}],"availabilityPrefix":[{"type":"text","text":"Available when"}],"constraints":[{"type":"codeVoice","code":"Self"},{"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":"."}]},"abstract":[],"type":"topic","title":"hash(into:)"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"url":"\/documentation\/auth0\/passwordlesstype","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasswordlessType"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","type":"topic","navigatorTitle":[{"kind":"identifier","text":"PasswordlessType"}],"kind":"symbol","title":"PasswordlessType","abstract":[{"type":"text","text":"Types of passwordless authentication."}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"RawRepresentable.hash(into:)"},{"type":"text","text":"."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"hash"},{"kind":"text","text":"("},{"kind":"externalParam","text":"into"},{"kind":"text","text":" "},{"kind":"internalParam","text":"hasher"},{"kind":"text","text":": "},{"kind":"keyword","text":"inout"},{"kind":"text","text":" "},{"kind":"typeIdentifier","text":"Hasher","preciseIdentifier":"s:s6HasherV"},{"kind":"text","text":")"}]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passwordlesstype\/hash(into:)"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"]]},"metadata":{"modules":[{"name":"Auth0","relatedModules":["Swift"]}],"title":"hash(into:)","roleHeading":"Instance Method","symbolKind":"method","role":"symbol","extendedModule":"Swift","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"hash","kind":"identifier"},{"text":"(","kind":"text"},{"text":"into","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"inout","kind":"keyword"},{"text":" ","kind":"text"},{"preciseIdentifier":"s:s6HasherV","text":"Hasher","kind":"typeIdentifier"},{"text":")","kind":"text"}],"externalID":"s:SYsSHRzSH8RawValueSYRpzrlE4hash4intoys6HasherVz_tF::SYNTHESIZED::s:5Auth016PasswordlessTypeO","conformance":{"constraints":[{"code":"Self","type":"codeVoice"},{"text":" conforms to ","type":"text"},{"code":"Hashable","type":"codeVoice"},{"text":" and ","type":"text"},{"code":"RawValue","type":"codeVoice"},{"text":" conforms to ","type":"text"},{"code":"Hashable","type":"codeVoice"},{"text":".","type":"text"}],"conformancePrefix":[{"text":"Conforms when","type":"text"}],"availabilityPrefix":[{"text":"Available when","type":"text"}]}},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/hash(into:)","interfaceLanguage":"swift"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/hash(into:)":{"role":"symbol","title":"hash(into:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"hash"},{"kind":"text","text":"("},{"kind":"externalParam","text":"into"},{"kind":"text","text":": "},{"kind":"keyword","text":"inout"},{"kind":"text","text":" "},{"kind":"typeIdentifier","text":"Hasher","preciseIdentifier":"s:s6HasherV"},{"kind":"text","text":")"}],"abstract":[],"conformance":{"availabilityPrefix":[{"type":"text","text":"Available when"}],"conformancePrefix":[{"type":"text","text":"Conforms when"}],"constraints":[{"type":"codeVoice","code":"Self"},{"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":"."}]},"kind":"symbol","url":"\/documentation\/auth0\/passwordlesstype\/hash(into:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/hash(into:)","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"navigatorTitle":[{"kind":"identifier","text":"PasswordlessType"}],"kind":"symbol","url":"\/documentation\/auth0\/passwordlesstype","role":"symbol","abstract":[{"type":"text","text":"Types of passwordless authentication."}],"type":"topic","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasswordlessType"}],"title":"PasswordlessType","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ 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 8929ac5e1..425976d7f 100644 --- a/docs/data/documentation/auth0/passwordlesstype/hashvalue.json +++ b/docs/data/documentation/auth0/passwordlesstype/hashvalue.json @@ -1 +1 @@ -{"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"]]},"schemaVersion":{"patch":0,"major":0,"minor":3},"metadata":{"conformance":{"constraints":[{"type":"codeVoice","code":"Self"},{"text":" conforms to ","type":"text"},{"type":"codeVoice","code":"Hashable"},{"text":" and ","type":"text"},{"type":"codeVoice","code":"RawValue"},{"text":" conforms to ","type":"text"},{"type":"codeVoice","code":"Hashable"},{"text":".","type":"text"}],"availabilityPrefix":[{"text":"Available when","type":"text"}],"conformancePrefix":[{"text":"Conforms when","type":"text"}]},"symbolKind":"property","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"hashValue","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"}],"modules":[{"name":"Auth0","relatedModules":["Swift"]}],"role":"symbol","externalID":"s:SYsSHRzSH8RawValueSYRpzrlE04hashB0Sivp::SYNTHESIZED::s:5Auth016PasswordlessTypeO","title":"hashValue","extendedModule":"Swift","roleHeading":"Instance Property"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/hashValue"},"abstract":[{"text":"Inherited from ","type":"text"},{"type":"codeVoice","code":"RawRepresentable.hashValue"},{"text":".","type":"text"}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"hashValue"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}]}],"kind":"declarations"}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passwordlesstype\/hashvalue"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"url":"\/documentation\/auth0\/passwordlesstype","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasswordlessType"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","type":"topic","navigatorTitle":[{"kind":"identifier","text":"PasswordlessType"}],"kind":"symbol","title":"PasswordlessType","abstract":[{"type":"text","text":"Types of passwordless authentication."}]},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/hashValue":{"url":"\/documentation\/auth0\/passwordlesstype\/hashvalue","abstract":[],"type":"topic","kind":"symbol","role":"symbol","conformance":{"constraints":[{"type":"codeVoice","code":"Self"},{"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"}]},"title":"hashValue","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"hashValue","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/hashValue"}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passwordlesstype\/hashvalue"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"]]},"abstract":[{"text":"Inherited from ","type":"text"},{"code":"RawRepresentable.hashValue","type":"codeVoice"},{"text":".","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"hashValue","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}]}],"schemaVersion":{"minor":3,"major":0,"patch":0},"kind":"symbol","sections":[],"metadata":{"externalID":"s:SYsSHRzSH8RawValueSYRpzrlE04hashB0Sivp::SYNTHESIZED::s:5Auth016PasswordlessTypeO","extendedModule":"Swift","symbolKind":"property","title":"hashValue","roleHeading":"Instance Property","role":"symbol","conformance":{"availabilityPrefix":[{"text":"Available when","type":"text"}],"conformancePrefix":[{"text":"Conforms when","type":"text"}],"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":"."}]},"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"hashValue"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"}],"modules":[{"name":"Auth0","relatedModules":["Swift"]}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/hashValue"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/hashValue":{"kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"hashValue"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"}],"conformance":{"availabilityPrefix":[{"type":"text","text":"Available when"}],"conformancePrefix":[{"type":"text","text":"Conforms when"}],"constraints":[{"type":"codeVoice","code":"Self"},{"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":"."}]},"title":"hashValue","type":"topic","role":"symbol","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/hashValue","url":"\/documentation\/auth0\/passwordlesstype\/hashvalue"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"navigatorTitle":[{"kind":"identifier","text":"PasswordlessType"}],"kind":"symbol","url":"\/documentation\/auth0\/passwordlesstype","role":"symbol","abstract":[{"type":"text","text":"Types of passwordless authentication."}],"type":"topic","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasswordlessType"}],"title":"PasswordlessType","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"}}} \ 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 ef1dffa28..52b527c08 100644 --- a/docs/data/documentation/auth0/passwordlesstype/init(rawvalue:).json +++ b/docs/data/documentation/auth0/passwordlesstype/init(rawvalue:).json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"]]},"variants":[{"paths":["\/documentation\/auth0\/passwordlesstype\/init(rawvalue:)"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"RawRepresentable.init(rawValue:)"},{"type":"text","text":"."}],"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"init","kind":"keyword"},{"text":"?(","kind":"text"},{"text":"rawValue","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":")","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"sections":[],"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/init(rawValue:)","interfaceLanguage":"swift"},"metadata":{"symbolKind":"init","modules":[{"name":"Auth0"}],"fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"?("},{"kind":"externalParam","text":"rawValue"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":")"}],"roleHeading":"Initializer","role":"symbol","title":"init(rawValue:)","externalID":"s:5Auth016PasswordlessTypeO8rawValueACSgSS_tcfc"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"url":"\/documentation\/auth0\/passwordlesstype","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasswordlessType"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","type":"topic","navigatorTitle":[{"kind":"identifier","text":"PasswordlessType"}],"kind":"symbol","title":"PasswordlessType","abstract":[{"type":"text","text":"Types of passwordless authentication."}]},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/init(rawValue:)":{"type":"topic","url":"\/documentation\/auth0\/passwordlesstype\/init(rawvalue:)","fragments":[{"text":"init","kind":"identifier"},{"text":"?(","kind":"text"},{"text":"rawValue","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":")","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/init(rawValue:)","role":"symbol","abstract":[],"kind":"symbol","title":"init(rawValue:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"]]},"metadata":{"role":"symbol","modules":[{"name":"Auth0"}],"title":"init(rawValue:)","fragments":[{"text":"init","kind":"identifier"},{"text":"?(","kind":"text"},{"text":"rawValue","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":")","kind":"text"}],"externalID":"s:5Auth016PasswordlessTypeO8rawValueACSgSS_tcfc","roleHeading":"Initializer","symbolKind":"init"},"sections":[],"abstract":[{"text":"Inherited from ","type":"text"},{"code":"RawRepresentable.init(rawValue:)","type":"codeVoice"},{"text":".","type":"text"}],"variants":[{"paths":["\/documentation\/auth0\/passwordlesstype\/init(rawvalue:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/init(rawValue:)"},"kind":"symbol","schemaVersion":{"minor":3,"patch":0,"major":0},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"init","kind":"keyword"},{"text":"?(","kind":"text"},{"text":"rawValue","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":")"}]}],"kind":"declarations"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"navigatorTitle":[{"kind":"identifier","text":"PasswordlessType"}],"kind":"symbol","url":"\/documentation\/auth0\/passwordlesstype","role":"symbol","abstract":[{"type":"text","text":"Types of passwordless authentication."}],"type":"topic","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasswordlessType"}],"title":"PasswordlessType","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/init(rawValue:)":{"role":"symbol","title":"init(rawValue:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"?("},{"kind":"externalParam","text":"rawValue"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":")"}],"abstract":[],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/init(rawValue:)","url":"\/documentation\/auth0\/passwordlesstype\/init(rawvalue:)","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ 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 5f050dd7c..988ef0380 100644 --- a/docs/data/documentation/auth0/passwordlesstype/ioslink.json +++ b/docs/data/documentation/auth0/passwordlesstype/ioslink.json @@ -1 +1 @@ -{"schemaVersion":{"major":0,"patch":0,"minor":3},"abstract":[{"type":"text","text":"Universal Link."}],"sections":[],"metadata":{"role":"symbol","modules":[{"name":"Auth0"}],"externalID":"s:5Auth016PasswordlessTypeO7iOSLinkyA2CmF","roleHeading":"Case","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"iOSLink"}],"symbolKind":"case","title":"PasswordlessType.iOSLink"},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"iOSLink"}]}],"kind":"declarations"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passwordlesstype\/ioslink"]}],"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/iOSLink"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"url":"\/documentation\/auth0\/passwordlesstype","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasswordlessType"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","type":"topic","navigatorTitle":[{"kind":"identifier","text":"PasswordlessType"}],"kind":"symbol","title":"PasswordlessType","abstract":[{"type":"text","text":"Types of passwordless authentication."}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/iOSLink":{"abstract":[{"type":"text","text":"Universal Link."}],"kind":"symbol","url":"\/documentation\/auth0\/passwordlesstype\/ioslink","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/iOSLink","type":"topic","title":"PasswordlessType.iOSLink","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"iOSLink"}]}}} \ No newline at end of file +{"abstract":[{"text":"Universal Link.","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"iOSLink","kind":"identifier"}],"platforms":["iOS"]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passwordlesstype\/ioslink"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"]]},"metadata":{"modules":[{"name":"Auth0"}],"title":"PasswordlessType.iOSLink","roleHeading":"Case","symbolKind":"case","role":"symbol","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"iOSLink","kind":"identifier"}],"externalID":"s:5Auth016PasswordlessTypeO7iOSLinkyA2CmF"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/iOSLink"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/iOSLink":{"type":"topic","abstract":[{"type":"text","text":"Universal Link."}],"kind":"symbol","url":"\/documentation\/auth0\/passwordlesstype\/ioslink","title":"PasswordlessType.iOSLink","role":"symbol","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"iOSLink"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/iOSLink"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"navigatorTitle":[{"kind":"identifier","text":"PasswordlessType"}],"kind":"symbol","url":"\/documentation\/auth0\/passwordlesstype","role":"symbol","abstract":[{"type":"text","text":"Types of passwordless authentication."}],"type":"topic","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasswordlessType"}],"title":"PasswordlessType","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"}}} \ 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 cfbe377b1..700587aa9 100644 --- a/docs/data/documentation/auth0/passwordlesstype/rawrepresentable-implementations.json +++ b/docs/data/documentation/auth0/passwordlesstype/rawrepresentable-implementations.json @@ -1 +1 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/RawRepresentable-Implementations","interfaceLanguage":"swift"},"schemaVersion":{"minor":3,"major":0,"patch":0},"topicSections":[{"title":"Instance Properties","generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/hashValue"],"anchor":"Instance-Properties"},{"title":"Instance Methods","generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/hash(into:)"],"anchor":"Instance-Methods"}],"variants":[{"paths":["\/documentation\/auth0\/passwordlesstype\/rawrepresentable-implementations"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"article","metadata":{"title":"RawRepresentable Implementations","role":"collectionGroup","roleHeading":"API Collection","modules":[{"name":"Auth0"}]},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/hashValue":{"url":"\/documentation\/auth0\/passwordlesstype\/hashvalue","abstract":[],"type":"topic","kind":"symbol","role":"symbol","conformance":{"constraints":[{"type":"codeVoice","code":"Self"},{"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"}]},"title":"hashValue","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"hashValue","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/hashValue"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/hash(into:)":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"hash"},{"kind":"text","text":"("},{"kind":"externalParam","text":"into"},{"kind":"text","text":": "},{"kind":"keyword","text":"inout"},{"kind":"text","text":" "},{"preciseIdentifier":"s:s6HasherV","kind":"typeIdentifier","text":"Hasher"},{"kind":"text","text":")"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/hash(into:)","role":"symbol","kind":"symbol","url":"\/documentation\/auth0\/passwordlesstype\/hash(into:)","conformance":{"conformancePrefix":[{"type":"text","text":"Conforms when"}],"availabilityPrefix":[{"type":"text","text":"Available when"}],"constraints":[{"type":"codeVoice","code":"Self"},{"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":"."}]},"abstract":[],"type":"topic","title":"hash(into:)"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"url":"\/documentation\/auth0\/passwordlesstype","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasswordlessType"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","type":"topic","navigatorTitle":[{"kind":"identifier","text":"PasswordlessType"}],"kind":"symbol","title":"PasswordlessType","abstract":[{"type":"text","text":"Types of passwordless authentication."}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passwordlesstype\/rawrepresentable-implementations"]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"]]},"topicSections":[{"title":"Instance Properties","generated":true,"anchor":"Instance-Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/hashValue"]},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/hash(into:)"],"generated":true,"title":"Instance Methods","anchor":"Instance-Methods"}],"metadata":{"role":"collectionGroup","title":"RawRepresentable Implementations","roleHeading":"API Collection","modules":[{"name":"Auth0"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/RawRepresentable-Implementations","interfaceLanguage":"swift"},"kind":"article","references":{"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/hash(into:)":{"role":"symbol","title":"hash(into:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"hash"},{"kind":"text","text":"("},{"kind":"externalParam","text":"into"},{"kind":"text","text":": "},{"kind":"keyword","text":"inout"},{"kind":"text","text":" "},{"kind":"typeIdentifier","text":"Hasher","preciseIdentifier":"s:s6HasherV"},{"kind":"text","text":")"}],"abstract":[],"conformance":{"availabilityPrefix":[{"type":"text","text":"Available when"}],"conformancePrefix":[{"type":"text","text":"Conforms when"}],"constraints":[{"type":"codeVoice","code":"Self"},{"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":"."}]},"kind":"symbol","url":"\/documentation\/auth0\/passwordlesstype\/hash(into:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/hash(into:)","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"navigatorTitle":[{"kind":"identifier","text":"PasswordlessType"}],"kind":"symbol","url":"\/documentation\/auth0\/passwordlesstype","role":"symbol","abstract":[{"type":"text","text":"Types of passwordless authentication."}],"type":"topic","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasswordlessType"}],"title":"PasswordlessType","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/hashValue":{"kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"hashValue"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"}],"conformance":{"availabilityPrefix":[{"type":"text","text":"Available when"}],"conformancePrefix":[{"type":"text","text":"Conforms when"}],"constraints":[{"type":"codeVoice","code":"Self"},{"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":"."}]},"title":"hashValue","type":"topic","role":"symbol","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/hashValue","url":"\/documentation\/auth0\/passwordlesstype\/hashvalue"}}} \ 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 82b84713d..89736be37 100644 --- a/docs/data/documentation/auth0/passwordlesstype/weblink.json +++ b/docs/data/documentation/auth0/passwordlesstype/weblink.json @@ -1 +1 @@ -{"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"]]},"kind":"symbol","schemaVersion":{"major":0,"patch":0,"minor":3},"metadata":{"title":"PasswordlessType.webLink","externalID":"s:5Auth016PasswordlessTypeO7webLinkyA2CmF","modules":[{"name":"Auth0"}],"fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"webLink","kind":"identifier"}],"roleHeading":"Case","role":"symbol","symbolKind":"case"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/webLink"},"abstract":[{"type":"text","text":"Regular Web HTTP link (web only, uses a redirect)."}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"webLink","kind":"identifier"}]}],"kind":"declarations"}],"variants":[{"paths":["\/documentation\/auth0\/passwordlesstype\/weblink"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"url":"\/documentation\/auth0\/passwordlesstype","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasswordlessType"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType","type":"topic","navigatorTitle":[{"kind":"identifier","text":"PasswordlessType"}],"kind":"symbol","title":"PasswordlessType","abstract":[{"type":"text","text":"Types of passwordless authentication."}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/webLink":{"title":"PasswordlessType.webLink","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/webLink","url":"\/documentation\/auth0\/passwordlesstype\/weblink","abstract":[{"type":"text","text":"Regular Web HTTP link (web only, uses a redirect)."}],"type":"topic","kind":"symbol","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"webLink","kind":"identifier"}],"role":"symbol"}}} \ No newline at end of file +{"kind":"symbol","primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"webLink"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/passwordlesstype\/weblink"]}],"sections":[],"schemaVersion":{"minor":3,"patch":0,"major":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/webLink","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"]]},"abstract":[{"text":"Regular Web HTTP link (web only, uses a redirect).","type":"text"}],"metadata":{"externalID":"s:5Auth016PasswordlessTypeO7webLinkyA2CmF","modules":[{"name":"Auth0"}],"title":"PasswordlessType.webLink","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"webLink"}],"roleHeading":"Case","role":"symbol","symbolKind":"case"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType":{"navigatorTitle":[{"kind":"identifier","text":"PasswordlessType"}],"kind":"symbol","url":"\/documentation\/auth0\/passwordlesstype","role":"symbol","abstract":[{"type":"text","text":"Types of passwordless authentication."}],"type":"topic","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PasswordlessType"}],"title":"PasswordlessType","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType"},"doc://com.auth0.Auth0/documentation/Auth0/PasswordlessType/webLink":{"kind":"symbol","title":"PasswordlessType.webLink","role":"symbol","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"webLink","kind":"identifier"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PasswordlessType\/webLink","abstract":[{"text":"Regular Web HTTP link (web only, uses a redirect).","type":"text"}],"url":"\/documentation\/auth0\/passwordlesstype\/weblink"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/phoneenrollmentchallenge.json b/docs/data/documentation/auth0/phoneenrollmentchallenge.json index 8bc6c77f0..07aa0435d 100644 --- a/docs/data/documentation/auth0/phoneenrollmentchallenge.json +++ b/docs/data/documentation/auth0/phoneenrollmentchallenge.json @@ -1 +1 @@ -{"relationshipsSections":[{"title":"Conforms To","kind":"relationships","identifiers":["doc:\/\/com.auth0.Auth0\/s8CopyableP","doc:\/\/com.auth0.Auth0\/Se"],"type":"conformsTo"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/phoneenrollmentchallenge"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"PhoneEnrollmentChallenge"}],"platforms":["iOS"],"languages":["swift"]}]}],"schemaVersion":{"major":0,"patch":0,"minor":3},"sections":[],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"abstract":[{"type":"text","text":"A Phone enrollment challenge."}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PhoneEnrollmentChallenge","interfaceLanguage":"swift"},"metadata":{"symbolKind":"struct","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PhoneEnrollmentChallenge","kind":"identifier"}],"modules":[{"name":"Auth0"}],"role":"symbol","title":"PhoneEnrollmentChallenge","roleHeading":"Structure","externalID":"s:5Auth024PhoneEnrollmentChallengeV","navigatorTitle":[{"kind":"identifier","text":"PhoneEnrollmentChallenge"}]},"topicSections":[{"title":"Instance Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PhoneEnrollmentChallenge\/authenticationId","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PhoneEnrollmentChallenge\/authenticationSession"],"generated":true,"anchor":"Instance-Properties"},{"title":"Default Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PhoneEnrollmentChallenge\/Decodable-Implementations"],"generated":true,"anchor":"Default-Implementations"}],"references":{"doc://com.auth0.Auth0/Se":{"identifier":"doc:\/\/com.auth0.Auth0\/Se","title":"Swift.Decodable","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/PhoneEnrollmentChallenge/authenticationId":{"type":"topic","abstract":[{"text":"The unique identifier for the authentication method.","type":"text"}],"title":"authenticationId","url":"\/documentation\/auth0\/phoneenrollmentchallenge\/authenticationid","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PhoneEnrollmentChallenge\/authenticationId","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticationId"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/PhoneEnrollmentChallenge/Decodable-Implementations":{"url":"\/documentation\/auth0\/phoneenrollmentchallenge\/decodable-implementations","role":"collectionGroup","title":"Decodable Implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PhoneEnrollmentChallenge\/Decodable-Implementations","type":"topic","abstract":[],"kind":"article"},"doc://com.auth0.Auth0/s8CopyableP":{"type":"unresolvable","title":"Swift.Copyable","identifier":"doc:\/\/com.auth0.Auth0\/s8CopyableP"},"doc://com.auth0.Auth0/documentation/Auth0/PhoneEnrollmentChallenge":{"navigatorTitle":[{"kind":"identifier","text":"PhoneEnrollmentChallenge"}],"type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"PhoneEnrollmentChallenge"}],"kind":"symbol","role":"symbol","abstract":[{"text":"A Phone enrollment challenge.","type":"text"}],"url":"\/documentation\/auth0\/phoneenrollmentchallenge","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PhoneEnrollmentChallenge","title":"PhoneEnrollmentChallenge"},"doc://com.auth0.Auth0/documentation/Auth0/PhoneEnrollmentChallenge/authenticationSession":{"type":"topic","abstract":[{"type":"text","text":"The unique session identifier for the enrollment."}],"title":"authenticationSession","url":"\/documentation\/auth0\/phoneenrollmentchallenge\/authenticationsession","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PhoneEnrollmentChallenge\/authenticationSession","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticationSession"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"kind":"symbol"}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/phoneenrollmentchallenge"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"abstract":[{"type":"text","text":"A Phone enrollment challenge."}],"topicSections":[{"anchor":"Instance-Properties","title":"Instance Properties","generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PhoneEnrollmentChallenge\/authenticationId","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PhoneEnrollmentChallenge\/authenticationSession"]},{"anchor":"Default-Implementations","title":"Default Implementations","generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PhoneEnrollmentChallenge\/Decodable-Implementations"]}],"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","relationshipsSections":[{"title":"Conforms To","type":"conformsTo","kind":"relationships","identifiers":["doc:\/\/com.auth0.Auth0\/s8CopyableP","doc:\/\/com.auth0.Auth0\/Se"]}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PhoneEnrollmentChallenge","kind":"identifier"}]}],"kind":"declarations"}],"metadata":{"externalID":"s:5Auth024PhoneEnrollmentChallengeV","symbolKind":"struct","title":"PhoneEnrollmentChallenge","role":"symbol","roleHeading":"Structure","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PhoneEnrollmentChallenge","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"PhoneEnrollmentChallenge"}],"modules":[{"name":"Auth0"}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PhoneEnrollmentChallenge"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PhoneEnrollmentChallenge/Decodable-Implementations":{"type":"topic","abstract":[],"title":"Decodable Implementations","url":"\/documentation\/auth0\/phoneenrollmentchallenge\/decodable-implementations","kind":"article","role":"collectionGroup","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PhoneEnrollmentChallenge\/Decodable-Implementations"},"doc://com.auth0.Auth0/Se":{"title":"Swift.Decodable","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/Se"},"doc://com.auth0.Auth0/documentation/Auth0/PhoneEnrollmentChallenge":{"url":"\/documentation\/auth0\/phoneenrollmentchallenge","title":"PhoneEnrollmentChallenge","abstract":[{"type":"text","text":"A Phone enrollment challenge."}],"navigatorTitle":[{"text":"PhoneEnrollmentChallenge","kind":"identifier"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"PhoneEnrollmentChallenge"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PhoneEnrollmentChallenge","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PhoneEnrollmentChallenge/authenticationId":{"type":"topic","abstract":[{"type":"text","text":"The unique identifier for the authentication method."}],"title":"authenticationId","url":"\/documentation\/auth0\/phoneenrollmentchallenge\/authenticationid","kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticationId"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PhoneEnrollmentChallenge\/authenticationId"},"doc://com.auth0.Auth0/s8CopyableP":{"title":"Swift.Copyable","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s8CopyableP"},"doc://com.auth0.Auth0/documentation/Auth0/PhoneEnrollmentChallenge/authenticationSession":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PhoneEnrollmentChallenge\/authenticationSession","kind":"symbol","title":"authenticationSession","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticationSession"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"role":"symbol","url":"\/documentation\/auth0\/phoneenrollmentchallenge\/authenticationsession","abstract":[{"type":"text","text":"The unique session identifier for the enrollment."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/phoneenrollmentchallenge/authenticationid.json b/docs/data/documentation/auth0/phoneenrollmentchallenge/authenticationid.json index c0af1f588..d0b33952e 100644 --- a/docs/data/documentation/auth0/phoneenrollmentchallenge/authenticationid.json +++ b/docs/data/documentation/auth0/phoneenrollmentchallenge/authenticationid.json @@ -1 +1 @@ -{"schemaVersion":{"major":0,"patch":0,"minor":3},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PhoneEnrollmentChallenge\/authenticationId","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authenticationId","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}]}]}],"kind":"symbol","abstract":[{"type":"text","text":"The unique identifier for the authentication method."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/phoneenrollmentchallenge\/authenticationid"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PhoneEnrollmentChallenge"]]},"metadata":{"roleHeading":"Instance Property","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authenticationId","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"modules":[{"name":"Auth0"}],"title":"authenticationId","role":"symbol","externalID":"s:5Auth024PhoneEnrollmentChallengeV16authenticationIdSSvp","symbolKind":"property"},"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/PhoneEnrollmentChallenge/authenticationId":{"type":"topic","abstract":[{"text":"The unique identifier for the authentication method.","type":"text"}],"title":"authenticationId","url":"\/documentation\/auth0\/phoneenrollmentchallenge\/authenticationid","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PhoneEnrollmentChallenge\/authenticationId","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticationId"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/PhoneEnrollmentChallenge":{"navigatorTitle":[{"kind":"identifier","text":"PhoneEnrollmentChallenge"}],"type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"PhoneEnrollmentChallenge"}],"kind":"symbol","role":"symbol","abstract":[{"text":"A Phone enrollment challenge.","type":"text"}],"url":"\/documentation\/auth0\/phoneenrollmentchallenge","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PhoneEnrollmentChallenge","title":"PhoneEnrollmentChallenge"}}} \ No newline at end of file +{"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"authenticationId","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/phoneenrollmentchallenge\/authenticationid"]}],"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PhoneEnrollmentChallenge\/authenticationId","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PhoneEnrollmentChallenge"]]},"abstract":[{"type":"text","text":"The unique identifier for the authentication method."}],"metadata":{"symbolKind":"property","title":"authenticationId","externalID":"s:5Auth024PhoneEnrollmentChallengeV16authenticationIdSSvp","roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authenticationId","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"role":"symbol"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PhoneEnrollmentChallenge":{"url":"\/documentation\/auth0\/phoneenrollmentchallenge","title":"PhoneEnrollmentChallenge","abstract":[{"type":"text","text":"A Phone enrollment challenge."}],"navigatorTitle":[{"text":"PhoneEnrollmentChallenge","kind":"identifier"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"PhoneEnrollmentChallenge"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PhoneEnrollmentChallenge","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PhoneEnrollmentChallenge/authenticationId":{"type":"topic","abstract":[{"type":"text","text":"The unique identifier for the authentication method."}],"title":"authenticationId","url":"\/documentation\/auth0\/phoneenrollmentchallenge\/authenticationid","kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticationId"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PhoneEnrollmentChallenge\/authenticationId"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/phoneenrollmentchallenge/authenticationsession.json b/docs/data/documentation/auth0/phoneenrollmentchallenge/authenticationsession.json index dab2a0535..62c20702e 100644 --- a/docs/data/documentation/auth0/phoneenrollmentchallenge/authenticationsession.json +++ b/docs/data/documentation/auth0/phoneenrollmentchallenge/authenticationsession.json @@ -1 +1 @@ -{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/phoneenrollmentchallenge\/authenticationsession"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PhoneEnrollmentChallenge\/authenticationSession","interfaceLanguage":"swift"},"metadata":{"roleHeading":"Instance Property","title":"authenticationSession","role":"symbol","externalID":"s:5Auth024PhoneEnrollmentChallengeV21authenticationSessionSSvp","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticationSession"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"modules":[{"name":"Auth0"}],"symbolKind":"property"},"abstract":[{"text":"The unique session identifier for the enrollment.","type":"text"}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PhoneEnrollmentChallenge"]]},"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authenticationSession","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"languages":["swift"]}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/PhoneEnrollmentChallenge/authenticationSession":{"type":"topic","abstract":[{"type":"text","text":"The unique session identifier for the enrollment."}],"title":"authenticationSession","url":"\/documentation\/auth0\/phoneenrollmentchallenge\/authenticationsession","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PhoneEnrollmentChallenge\/authenticationSession","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticationSession"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/PhoneEnrollmentChallenge":{"navigatorTitle":[{"kind":"identifier","text":"PhoneEnrollmentChallenge"}],"type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"PhoneEnrollmentChallenge"}],"kind":"symbol","role":"symbol","abstract":[{"text":"A Phone enrollment challenge.","type":"text"}],"url":"\/documentation\/auth0\/phoneenrollmentchallenge","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PhoneEnrollmentChallenge","title":"PhoneEnrollmentChallenge"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PhoneEnrollmentChallenge"]]},"metadata":{"symbolKind":"property","modules":[{"name":"Auth0"}],"title":"authenticationSession","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticationSession"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"externalID":"s:5Auth024PhoneEnrollmentChallengeV21authenticationSessionSSvp","role":"symbol","roleHeading":"Instance Property"},"sections":[],"abstract":[{"type":"text","text":"The unique session identifier for the enrollment."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/phoneenrollmentchallenge\/authenticationsession"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PhoneEnrollmentChallenge\/authenticationSession"},"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticationSession"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/PhoneEnrollmentChallenge/authenticationSession":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PhoneEnrollmentChallenge\/authenticationSession","kind":"symbol","title":"authenticationSession","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticationSession"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"role":"symbol","url":"\/documentation\/auth0\/phoneenrollmentchallenge\/authenticationsession","abstract":[{"type":"text","text":"The unique session identifier for the enrollment."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PhoneEnrollmentChallenge":{"url":"\/documentation\/auth0\/phoneenrollmentchallenge","title":"PhoneEnrollmentChallenge","abstract":[{"type":"text","text":"A Phone enrollment challenge."}],"navigatorTitle":[{"text":"PhoneEnrollmentChallenge","kind":"identifier"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"PhoneEnrollmentChallenge"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PhoneEnrollmentChallenge","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/phoneenrollmentchallenge/decodable-implementations.json b/docs/data/documentation/auth0/phoneenrollmentchallenge/decodable-implementations.json index b1499c1b4..a677065e3 100644 --- a/docs/data/documentation/auth0/phoneenrollmentchallenge/decodable-implementations.json +++ b/docs/data/documentation/auth0/phoneenrollmentchallenge/decodable-implementations.json @@ -1 +1 @@ -{"sections":[],"schemaVersion":{"patch":0,"minor":3,"major":0},"topicSections":[{"title":"Initializers","generated":true,"anchor":"Initializers","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PhoneEnrollmentChallenge\/init(from:)"]}],"metadata":{"modules":[{"name":"Auth0"}],"role":"collectionGroup","title":"Decodable Implementations","roleHeading":"API Collection"},"kind":"article","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/phoneenrollmentchallenge\/decodable-implementations"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PhoneEnrollmentChallenge"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PhoneEnrollmentChallenge\/Decodable-Implementations","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PhoneEnrollmentChallenge":{"navigatorTitle":[{"kind":"identifier","text":"PhoneEnrollmentChallenge"}],"type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"PhoneEnrollmentChallenge"}],"kind":"symbol","role":"symbol","abstract":[{"text":"A Phone enrollment challenge.","type":"text"}],"url":"\/documentation\/auth0\/phoneenrollmentchallenge","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PhoneEnrollmentChallenge","title":"PhoneEnrollmentChallenge"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/PhoneEnrollmentChallenge/init(from:)":{"abstract":[{"code":"Decodable","type":"codeVoice"},{"type":"text","text":" initializer."}],"fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Decoder","preciseIdentifier":"s:s7DecoderP"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PhoneEnrollmentChallenge\/init(from:)","title":"init(from:)","role":"symbol","kind":"symbol","url":"\/documentation\/auth0\/phoneenrollmentchallenge\/init(from:)","type":"topic"}}} \ No newline at end of file +{"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PhoneEnrollmentChallenge\/Decodable-Implementations","interfaceLanguage":"swift"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/phoneenrollmentchallenge\/decodable-implementations"]}],"kind":"article","metadata":{"role":"collectionGroup","title":"Decodable Implementations","roleHeading":"API Collection","modules":[{"name":"Auth0"}]},"schemaVersion":{"patch":0,"minor":3,"major":0},"topicSections":[{"anchor":"Initializers","title":"Initializers","generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PhoneEnrollmentChallenge\/init(from:)"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PhoneEnrollmentChallenge"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PhoneEnrollmentChallenge/init(from:)":{"title":"init(from:)","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PhoneEnrollmentChallenge\/init(from:)","role":"symbol","kind":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"from"},{"kind":"text","text":": "},{"text":"Decoder","preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier"},{"kind":"text","text":") "},{"text":"throws","kind":"keyword"}],"abstract":[{"code":"Decodable","type":"codeVoice"},{"type":"text","text":" initializer."}],"url":"\/documentation\/auth0\/phoneenrollmentchallenge\/init(from:)"},"doc://com.auth0.Auth0/documentation/Auth0/PhoneEnrollmentChallenge":{"url":"\/documentation\/auth0\/phoneenrollmentchallenge","title":"PhoneEnrollmentChallenge","abstract":[{"type":"text","text":"A Phone enrollment challenge."}],"navigatorTitle":[{"text":"PhoneEnrollmentChallenge","kind":"identifier"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"PhoneEnrollmentChallenge"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PhoneEnrollmentChallenge","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/phoneenrollmentchallenge/init(from:).json b/docs/data/documentation/auth0/phoneenrollmentchallenge/init(from:).json index e5e1c7f25..114175d40 100644 --- a/docs/data/documentation/auth0/phoneenrollmentchallenge/init(from:).json +++ b/docs/data/documentation/auth0/phoneenrollmentchallenge/init(from:).json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PhoneEnrollmentChallenge"]]},"schemaVersion":{"minor":3,"major":0,"patch":0},"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PhoneEnrollmentChallenge\/init(from:)"},"kind":"symbol","abstract":[{"code":"Decodable","type":"codeVoice"},{"type":"text","text":" initializer."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":" "},{"kind":"internalParam","text":"decoder"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP","text":"Decoder"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"platforms":["iOS"]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/phoneenrollmentchallenge\/init(from:)"]}],"metadata":{"roleHeading":"Initializer","extendedModule":"Auth0","symbolKind":"init","externalID":"s:5Auth024PhoneEnrollmentChallengeV4fromACs7Decoder_p_tKcfc","role":"symbol","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Decoder","preciseIdentifier":"s:s7DecoderP"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"modules":[{"name":"Auth0"}],"title":"init(from:)"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/PhoneEnrollmentChallenge/init(from:)":{"abstract":[{"code":"Decodable","type":"codeVoice"},{"type":"text","text":" initializer."}],"fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Decoder","preciseIdentifier":"s:s7DecoderP"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PhoneEnrollmentChallenge\/init(from:)","title":"init(from:)","role":"symbol","kind":"symbol","url":"\/documentation\/auth0\/phoneenrollmentchallenge\/init(from:)","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PhoneEnrollmentChallenge":{"navigatorTitle":[{"kind":"identifier","text":"PhoneEnrollmentChallenge"}],"type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"PhoneEnrollmentChallenge"}],"kind":"symbol","role":"symbol","abstract":[{"text":"A Phone enrollment challenge.","type":"text"}],"url":"\/documentation\/auth0\/phoneenrollmentchallenge","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PhoneEnrollmentChallenge","title":"PhoneEnrollmentChallenge"}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/phoneenrollmentchallenge\/init(from:)"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PhoneEnrollmentChallenge"]]},"abstract":[{"type":"codeVoice","code":"Decodable"},{"type":"text","text":" initializer."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"init","kind":"keyword"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"decoder","kind":"internalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:s7DecoderP","text":"Decoder","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}]}]}],"kind":"symbol","sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"externalID":"s:5Auth024PhoneEnrollmentChallengeV4fromACs7Decoder_p_tKcfc","extendedModule":"Auth0","symbolKind":"init","title":"init(from:)","role":"symbol","roleHeading":"Initializer","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier","text":"Decoder"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"modules":[{"name":"Auth0"}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PhoneEnrollmentChallenge\/init(from:)"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PhoneEnrollmentChallenge/init(from:)":{"title":"init(from:)","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PhoneEnrollmentChallenge\/init(from:)","role":"symbol","kind":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"from"},{"kind":"text","text":": "},{"text":"Decoder","preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier"},{"kind":"text","text":") "},{"text":"throws","kind":"keyword"}],"abstract":[{"code":"Decodable","type":"codeVoice"},{"type":"text","text":" initializer."}],"url":"\/documentation\/auth0\/phoneenrollmentchallenge\/init(from:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PhoneEnrollmentChallenge":{"url":"\/documentation\/auth0\/phoneenrollmentchallenge","title":"PhoneEnrollmentChallenge","abstract":[{"type":"text","text":"A Phone enrollment challenge."}],"navigatorTitle":[{"text":"PhoneEnrollmentChallenge","kind":"identifier"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"PhoneEnrollmentChallenge"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PhoneEnrollmentChallenge","role":"symbol","kind":"symbol","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/preferredauthenticationmethod.json b/docs/data/documentation/auth0/preferredauthenticationmethod.json index cf0d09251..8cb55edc6 100644 --- a/docs/data/documentation/auth0/preferredauthenticationmethod.json +++ b/docs/data/documentation/auth0/preferredauthenticationmethod.json @@ -1 +1 @@ -{"metadata":{"role":"symbol","externalID":"s:5Auth029PreferredAuthenticationMethodO","title":"PreferredAuthenticationMethod","navigatorTitle":[{"text":"PreferredAuthenticationMethod","kind":"identifier"}],"roleHeading":"Enumeration","modules":[{"name":"Auth0"}],"symbolKind":"enum","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PreferredAuthenticationMethod"}]},"sections":[],"relationshipsSections":[{"kind":"relationships","identifiers":["doc:\/\/com.auth0.Auth0\/SQ","doc:\/\/com.auth0.Auth0\/SH","doc:\/\/com.auth0.Auth0\/SY"],"title":"Conforms To","type":"conformsTo"}],"schemaVersion":{"major":0,"patch":0,"minor":3},"topicSections":[{"generated":true,"anchor":"Enumeration-Cases","title":"Enumeration Cases","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod\/sms","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod\/voice"]},{"generated":true,"anchor":"Initializers","title":"Initializers","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod\/init(rawValue:)"]},{"generated":true,"anchor":"Default-Implementations","title":"Default Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod\/Equatable-Implementations","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod\/RawRepresentable-Implementations"]}],"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PreferredAuthenticationMethod","kind":"identifier"}],"platforms":["iOS"],"languages":["swift"]}]}],"variants":[{"paths":["\/documentation\/auth0\/preferredauthenticationmethod"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PreferredAuthenticationMethod":{"abstract":[],"role":"symbol","url":"\/documentation\/auth0\/preferredauthenticationmethod","title":"PreferredAuthenticationMethod","navigatorTitle":[{"kind":"identifier","text":"PreferredAuthenticationMethod"}],"type":"topic","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PreferredAuthenticationMethod"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/SQ":{"identifier":"doc:\/\/com.auth0.Auth0\/SQ","type":"unresolvable","title":"Swift.Equatable"},"doc://com.auth0.Auth0/SY":{"identifier":"doc:\/\/com.auth0.Auth0\/SY","title":"Swift.RawRepresentable","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/PreferredAuthenticationMethod/Equatable-Implementations":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod\/Equatable-Implementations","role":"collectionGroup","abstract":[],"title":"Equatable Implementations","kind":"article","url":"\/documentation\/auth0\/preferredauthenticationmethod\/equatable-implementations"},"doc://com.auth0.Auth0/documentation/Auth0/PreferredAuthenticationMethod/sms":{"fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"sms"}],"abstract":[],"type":"topic","title":"PreferredAuthenticationMethod.sms","role":"symbol","url":"\/documentation\/auth0\/preferredauthenticationmethod\/sms","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod\/sms"},"doc://com.auth0.Auth0/SH":{"identifier":"doc:\/\/com.auth0.Auth0\/SH","type":"unresolvable","title":"Swift.Hashable"},"doc://com.auth0.Auth0/documentation/Auth0/PreferredAuthenticationMethod/RawRepresentable-Implementations":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod\/RawRepresentable-Implementations","role":"collectionGroup","abstract":[],"kind":"article","url":"\/documentation\/auth0\/preferredauthenticationmethod\/rawrepresentable-implementations","title":"RawRepresentable Implementations","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PreferredAuthenticationMethod/init(rawValue:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod\/init(rawValue:)","role":"symbol","abstract":[],"fragments":[{"text":"init","kind":"identifier"},{"text":"?(","kind":"text"},{"text":"rawValue","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":")","kind":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/preferredauthenticationmethod\/init(rawvalue:)","type":"topic","title":"init(rawValue:)"},"doc://com.auth0.Auth0/documentation/Auth0/PreferredAuthenticationMethod/voice":{"title":"PreferredAuthenticationMethod.voice","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"voice"}],"abstract":[],"url":"\/documentation\/auth0\/preferredauthenticationmethod\/voice","type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod\/voice","role":"symbol"}}} \ No newline at end of file +{"sections":[],"kind":"symbol","metadata":{"modules":[{"name":"Auth0"}],"externalID":"s:5Auth029PreferredAuthenticationMethodO","title":"PreferredAuthenticationMethod","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PreferredAuthenticationMethod"}],"roleHeading":"Enumeration","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"PreferredAuthenticationMethod"}],"symbolKind":"enum"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod"},"topicSections":[{"anchor":"Enumeration-Cases","title":"Enumeration Cases","generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod\/sms","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod\/voice"]},{"anchor":"Initializers","title":"Initializers","generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod\/init(rawValue:)"]},{"anchor":"Default-Implementations","title":"Default Implementations","generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod\/Equatable-Implementations","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod\/RawRepresentable-Implementations"]}],"relationshipsSections":[{"title":"Conforms To","identifiers":["doc:\/\/com.auth0.Auth0\/SQ","doc:\/\/com.auth0.Auth0\/SH","doc:\/\/com.auth0.Auth0\/SY"],"type":"conformsTo","kind":"relationships"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/preferredauthenticationmethod"]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PreferredAuthenticationMethod"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/PreferredAuthenticationMethod/sms":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod\/sms","title":"PreferredAuthenticationMethod.sms","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"sms","kind":"identifier"}],"role":"symbol","url":"\/documentation\/auth0\/preferredauthenticationmethod\/sms","abstract":[],"type":"topic"},"doc://com.auth0.Auth0/SQ":{"type":"unresolvable","title":"Swift.Equatable","identifier":"doc:\/\/com.auth0.Auth0\/SQ"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PreferredAuthenticationMethod/voice":{"kind":"symbol","title":"PreferredAuthenticationMethod.voice","role":"symbol","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"voice"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod\/voice","abstract":[],"url":"\/documentation\/auth0\/preferredauthenticationmethod\/voice"},"doc://com.auth0.Auth0/documentation/Auth0/PreferredAuthenticationMethod":{"url":"\/documentation\/auth0\/preferredauthenticationmethod","abstract":[],"title":"PreferredAuthenticationMethod","navigatorTitle":[{"text":"PreferredAuthenticationMethod","kind":"identifier"}],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PreferredAuthenticationMethod"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PreferredAuthenticationMethod/init(rawValue:)":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod\/init(rawValue:)","title":"init(rawValue:)","fragments":[{"text":"init","kind":"identifier"},{"text":"?(","kind":"text"},{"text":"rawValue","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":")","kind":"text"}],"role":"symbol","url":"\/documentation\/auth0\/preferredauthenticationmethod\/init(rawvalue:)","abstract":[],"type":"topic"},"doc://com.auth0.Auth0/SY":{"type":"unresolvable","title":"Swift.RawRepresentable","identifier":"doc:\/\/com.auth0.Auth0\/SY"},"doc://com.auth0.Auth0/documentation/Auth0/PreferredAuthenticationMethod/RawRepresentable-Implementations":{"kind":"article","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod\/RawRepresentable-Implementations","title":"RawRepresentable Implementations","role":"collectionGroup","url":"\/documentation\/auth0\/preferredauthenticationmethod\/rawrepresentable-implementations","abstract":[],"type":"topic"},"doc://com.auth0.Auth0/SH":{"type":"unresolvable","title":"Swift.Hashable","identifier":"doc:\/\/com.auth0.Auth0\/SH"},"doc://com.auth0.Auth0/documentation/Auth0/PreferredAuthenticationMethod/Equatable-Implementations":{"kind":"article","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod\/Equatable-Implementations","title":"Equatable Implementations","role":"collectionGroup","url":"\/documentation\/auth0\/preferredauthenticationmethod\/equatable-implementations","abstract":[],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/preferredauthenticationmethod/!=(_:_:).json b/docs/data/documentation/auth0/preferredauthenticationmethod/!=(_:_:).json index b801eea99..18f9e4d45 100644 --- a/docs/data/documentation/auth0/preferredauthenticationmethod/!=(_:_:).json +++ b/docs/data/documentation/auth0/preferredauthenticationmethod/!=(_:_:).json @@ -1 +1 @@ -{"schemaVersion":{"minor":3,"major":0,"patch":0},"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"!="},{"kind":"text","text":" "},{"kind":"text","text":"("},{"kind":"internalParam","text":"lhs"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":", "},{"kind":"internalParam","text":"rhs"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}]}]}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod\/!=(_:_:)"},"variants":[{"paths":["\/documentation\/auth0\/preferredauthenticationmethod\/!=(_:_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"extendedModule":"Swift","title":"!=(_:_:)","role":"symbol","modules":[{"relatedModules":["Swift"],"name":"Auth0"}],"symbolKind":"op","roleHeading":"Operator","externalID":"s:SQsE2neoiySbx_xtFZ::SYNTHESIZED::s:5Auth029PreferredAuthenticationMethodO","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}]},"abstract":[{"text":"Inherited from ","type":"text"},{"type":"codeVoice","code":"Equatable.!=(_:_:)"},{"text":".","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/PreferredAuthenticationMethod/!=(_:_:)":{"abstract":[],"title":"!=(_:_:)","role":"symbol","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/preferredauthenticationmethod\/!=(_:_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod\/!=(_:_:)","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/PreferredAuthenticationMethod":{"abstract":[],"role":"symbol","url":"\/documentation\/auth0\/preferredauthenticationmethod","title":"PreferredAuthenticationMethod","navigatorTitle":[{"kind":"identifier","text":"PreferredAuthenticationMethod"}],"type":"topic","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PreferredAuthenticationMethod"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod","kind":"symbol"}}} \ No newline at end of file +{"abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"Equatable.!=(_:_:)"},{"type":"text","text":"."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"!=","kind":"identifier"},{"kind":"text","text":" "},{"text":"(","kind":"text"},{"text":"lhs","kind":"internalParam"},{"kind":"text","text":": "},{"text":"Self","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"rhs","kind":"internalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Self"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}]}]}],"variants":[{"paths":["\/documentation\/auth0\/preferredauthenticationmethod\/!=(_:_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod"]]},"metadata":{"symbolKind":"op","roleHeading":"Operator","externalID":"s:SQsE2neoiySbx_xtFZ::SYNTHESIZED::s:5Auth029PreferredAuthenticationMethodO","extendedModule":"Swift","title":"!=(_:_:)","modules":[{"name":"Auth0","relatedModules":["Swift"]}],"fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"role":"symbol"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod\/!=(_:_:)","interfaceLanguage":"swift"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/PreferredAuthenticationMethod/!=(_:_:)":{"type":"topic","title":"!=(_:_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod\/!=(_:_:)","kind":"symbol","abstract":[],"url":"\/documentation\/auth0\/preferredauthenticationmethod\/!=(_:_:)","role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PreferredAuthenticationMethod":{"url":"\/documentation\/auth0\/preferredauthenticationmethod","abstract":[],"title":"PreferredAuthenticationMethod","navigatorTitle":[{"text":"PreferredAuthenticationMethod","kind":"identifier"}],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PreferredAuthenticationMethod"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod","role":"symbol","kind":"symbol","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/preferredauthenticationmethod/equatable-implementations.json b/docs/data/documentation/auth0/preferredauthenticationmethod/equatable-implementations.json index aca1bdb61..265a5d711 100644 --- a/docs/data/documentation/auth0/preferredauthenticationmethod/equatable-implementations.json +++ b/docs/data/documentation/auth0/preferredauthenticationmethod/equatable-implementations.json @@ -1 +1 @@ -{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod\/Equatable-Implementations"},"schemaVersion":{"patch":0,"major":0,"minor":3},"sections":[],"kind":"article","metadata":{"role":"collectionGroup","title":"Equatable Implementations","roleHeading":"API Collection","modules":[{"name":"Auth0"}]},"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod\/!=(_:_:)"],"title":"Operators","generated":true,"anchor":"Operators"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/preferredauthenticationmethod\/equatable-implementations"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/PreferredAuthenticationMethod":{"abstract":[],"role":"symbol","url":"\/documentation\/auth0\/preferredauthenticationmethod","title":"PreferredAuthenticationMethod","navigatorTitle":[{"kind":"identifier","text":"PreferredAuthenticationMethod"}],"type":"topic","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PreferredAuthenticationMethod"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/PreferredAuthenticationMethod/!=(_:_:)":{"abstract":[],"title":"!=(_:_:)","role":"symbol","type":"topic","kind":"symbol","url":"\/documentation\/auth0\/preferredauthenticationmethod\/!=(_:_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod\/!=(_:_:)","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}]}}} \ No newline at end of file +{"topicSections":[{"anchor":"Operators","title":"Operators","generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod\/!=(_:_:)"]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/preferredauthenticationmethod\/equatable-implementations"]}],"kind":"article","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod\/Equatable-Implementations"},"metadata":{"title":"Equatable Implementations","role":"collectionGroup","modules":[{"name":"Auth0"}],"roleHeading":"API Collection"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PreferredAuthenticationMethod":{"url":"\/documentation\/auth0\/preferredauthenticationmethod","abstract":[],"title":"PreferredAuthenticationMethod","navigatorTitle":[{"text":"PreferredAuthenticationMethod","kind":"identifier"}],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PreferredAuthenticationMethod"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PreferredAuthenticationMethod/!=(_:_:)":{"type":"topic","title":"!=(_:_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod\/!=(_:_:)","kind":"symbol","abstract":[],"url":"\/documentation\/auth0\/preferredauthenticationmethod\/!=(_:_:)","role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/preferredauthenticationmethod/hash(into:).json b/docs/data/documentation/auth0/preferredauthenticationmethod/hash(into:).json index ec7e43bd1..cc7c9457b 100644 --- a/docs/data/documentation/auth0/preferredauthenticationmethod/hash(into:).json +++ b/docs/data/documentation/auth0/preferredauthenticationmethod/hash(into:).json @@ -1 +1 @@ -{"abstract":[{"text":"Inherited from ","type":"text"},{"code":"RawRepresentable.hash(into:)","type":"codeVoice"},{"text":".","type":"text"}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"hash","kind":"identifier"},{"text":"(","kind":"text"},{"text":"into","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"hasher","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"inout","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Hasher","kind":"typeIdentifier","preciseIdentifier":"s:s6HasherV"},{"text":")","kind":"text"}],"languages":["swift"]}],"kind":"declarations"}],"variants":[{"paths":["\/documentation\/auth0\/preferredauthenticationmethod\/hash(into:)"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"patch":0,"minor":3,"major":0},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod"]]},"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod\/hash(into:)"},"metadata":{"roleHeading":"Instance Method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"hash","kind":"identifier"},{"text":"(","kind":"text"},{"text":"into","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"inout","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Hasher","preciseIdentifier":"s:s6HasherV","kind":"typeIdentifier"},{"text":")","kind":"text"}],"modules":[{"name":"Auth0","relatedModules":["Swift"]}],"title":"hash(into:)","symbolKind":"method","extendedModule":"Swift","role":"symbol","conformance":{"constraints":[{"code":"Self","type":"codeVoice"},{"text":" conforms to ","type":"text"},{"code":"Hashable","type":"codeVoice"},{"text":" and ","type":"text"},{"code":"RawValue","type":"codeVoice"},{"text":" conforms to ","type":"text"},{"code":"Hashable","type":"codeVoice"},{"text":".","type":"text"}],"availabilityPrefix":[{"text":"Available when","type":"text"}],"conformancePrefix":[{"text":"Conforms when","type":"text"}]},"externalID":"s:SYsSHRzSH8RawValueSYRpzrlE4hash4intoys6HasherVz_tF::SYNTHESIZED::s:5Auth029PreferredAuthenticationMethodO"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/PreferredAuthenticationMethod/hash(into:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod\/hash(into:)","title":"hash(into:)","role":"symbol","abstract":[],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"hash","kind":"identifier"},{"text":"(","kind":"text"},{"text":"into","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"inout","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Hasher","preciseIdentifier":"s:s6HasherV","kind":"typeIdentifier"},{"text":")","kind":"text"}],"conformance":{"constraints":[{"type":"codeVoice","code":"Self"},{"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"}]},"type":"topic","kind":"symbol","url":"\/documentation\/auth0\/preferredauthenticationmethod\/hash(into:)"},"doc://com.auth0.Auth0/documentation/Auth0/PreferredAuthenticationMethod":{"abstract":[],"role":"symbol","url":"\/documentation\/auth0\/preferredauthenticationmethod","title":"PreferredAuthenticationMethod","navigatorTitle":[{"kind":"identifier","text":"PreferredAuthenticationMethod"}],"type":"topic","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PreferredAuthenticationMethod"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod","kind":"symbol"}}} \ No newline at end of file +{"kind":"symbol","primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"hash","kind":"identifier"},{"text":"(","kind":"text"},{"text":"into","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"hasher","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"inout","kind":"keyword"},{"text":" ","kind":"text"},{"preciseIdentifier":"s:s6HasherV","text":"Hasher","kind":"typeIdentifier"},{"text":")","kind":"text"}],"platforms":["iOS"]}],"kind":"declarations"}],"variants":[{"paths":["\/documentation\/auth0\/preferredauthenticationmethod\/hash(into:)"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"schemaVersion":{"minor":3,"patch":0,"major":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod\/hash(into:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"RawRepresentable.hash(into:)"},{"type":"text","text":"."}],"metadata":{"roleHeading":"Instance Method","extendedModule":"Swift","role":"symbol","title":"hash(into:)","symbolKind":"method","conformance":{"constraints":[{"code":"Self","type":"codeVoice"},{"type":"text","text":" conforms to "},{"code":"Hashable","type":"codeVoice"},{"text":" and ","type":"text"},{"code":"RawValue","type":"codeVoice"},{"text":" conforms to ","type":"text"},{"code":"Hashable","type":"codeVoice"},{"text":".","type":"text"}],"availabilityPrefix":[{"text":"Available when","type":"text"}],"conformancePrefix":[{"type":"text","text":"Conforms when"}]},"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"hash"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"into"},{"kind":"text","text":": "},{"kind":"keyword","text":"inout"},{"kind":"text","text":" "},{"kind":"typeIdentifier","text":"Hasher","preciseIdentifier":"s:s6HasherV"},{"kind":"text","text":")"}],"externalID":"s:SYsSHRzSH8RawValueSYRpzrlE4hash4intoys6HasherVz_tF::SYNTHESIZED::s:5Auth029PreferredAuthenticationMethodO","modules":[{"name":"Auth0","relatedModules":["Swift"]}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PreferredAuthenticationMethod":{"url":"\/documentation\/auth0\/preferredauthenticationmethod","abstract":[],"title":"PreferredAuthenticationMethod","navigatorTitle":[{"text":"PreferredAuthenticationMethod","kind":"identifier"}],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PreferredAuthenticationMethod"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PreferredAuthenticationMethod/hash(into:)":{"title":"hash(into:)","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod\/hash(into:)","role":"symbol","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"hash","kind":"identifier"},{"text":"(","kind":"text"},{"text":"into","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"inout","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Hasher","preciseIdentifier":"s:s6HasherV","kind":"typeIdentifier"},{"text":")","kind":"text"}],"abstract":[],"conformance":{"constraints":[{"type":"codeVoice","code":"Self"},{"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"}]},"url":"\/documentation\/auth0\/preferredauthenticationmethod\/hash(into:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/preferredauthenticationmethod/hashvalue.json b/docs/data/documentation/auth0/preferredauthenticationmethod/hashvalue.json index 5f9a0442f..8054cfa58 100644 --- a/docs/data/documentation/auth0/preferredauthenticationmethod/hashvalue.json +++ b/docs/data/documentation/auth0/preferredauthenticationmethod/hashvalue.json @@ -1 +1 @@ -{"abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"RawRepresentable.hashValue"},{"type":"text","text":"."}],"variants":[{"paths":["\/documentation\/auth0\/preferredauthenticationmethod\/hashvalue"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod\/hashValue"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod"]]},"schemaVersion":{"minor":3,"patch":0,"major":0},"sections":[],"metadata":{"role":"symbol","symbolKind":"property","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"hashValue"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"}],"title":"hashValue","modules":[{"relatedModules":["Swift"],"name":"Auth0"}],"externalID":"s:SYsSHRzSH8RawValueSYRpzrlE04hashB0Sivp::SYNTHESIZED::s:5Auth029PreferredAuthenticationMethodO","conformance":{"constraints":[{"type":"codeVoice","code":"Self"},{"text":" conforms to ","type":"text"},{"type":"codeVoice","code":"Hashable"},{"text":" and ","type":"text"},{"type":"codeVoice","code":"RawValue"},{"text":" conforms to ","type":"text"},{"type":"codeVoice","code":"Hashable"},{"text":".","type":"text"}],"conformancePrefix":[{"text":"Conforms when","type":"text"}],"availabilityPrefix":[{"text":"Available when","type":"text"}]},"roleHeading":"Instance Property","extendedModule":"Swift"},"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"hashValue"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"platforms":["iOS"],"languages":["swift"]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/PreferredAuthenticationMethod":{"abstract":[],"role":"symbol","url":"\/documentation\/auth0\/preferredauthenticationmethod","title":"PreferredAuthenticationMethod","navigatorTitle":[{"kind":"identifier","text":"PreferredAuthenticationMethod"}],"type":"topic","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PreferredAuthenticationMethod"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/PreferredAuthenticationMethod/hashValue":{"abstract":[],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod\/hashValue","conformance":{"availabilityPrefix":[{"type":"text","text":"Available when"}],"conformancePrefix":[{"type":"text","text":"Conforms when"}],"constraints":[{"type":"codeVoice","code":"Self"},{"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":"."}]},"title":"hashValue","kind":"symbol","url":"\/documentation\/auth0\/preferredauthenticationmethod\/hashvalue","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"hashValue","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"}],"role":"symbol"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod"]]},"metadata":{"extendedModule":"Swift","symbolKind":"property","modules":[{"name":"Auth0","relatedModules":["Swift"]}],"title":"hashValue","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"hashValue"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"}],"externalID":"s:SYsSHRzSH8RawValueSYRpzrlE04hashB0Sivp::SYNTHESIZED::s:5Auth029PreferredAuthenticationMethodO","role":"symbol","conformance":{"availabilityPrefix":[{"text":"Available when","type":"text"}],"conformancePrefix":[{"text":"Conforms when","type":"text"}],"constraints":[{"code":"Self","type":"codeVoice"},{"text":" conforms to ","type":"text"},{"code":"Hashable","type":"codeVoice"},{"text":" and ","type":"text"},{"code":"RawValue","type":"codeVoice"},{"text":" conforms to ","type":"text"},{"code":"Hashable","type":"codeVoice"},{"text":".","type":"text"}]},"roleHeading":"Instance Property"},"sections":[],"abstract":[{"type":"text","text":"Inherited from "},{"code":"RawRepresentable.hashValue","type":"codeVoice"},{"type":"text","text":"."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/preferredauthenticationmethod\/hashvalue"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod\/hashValue","interfaceLanguage":"swift"},"kind":"symbol","schemaVersion":{"patch":0,"minor":3,"major":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"hashValue","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Int","preciseIdentifier":"s:Si","kind":"typeIdentifier"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/PreferredAuthenticationMethod/hashValue":{"url":"\/documentation\/auth0\/preferredauthenticationmethod\/hashvalue","abstract":[],"title":"hashValue","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"hashValue","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Int","preciseIdentifier":"s:Si","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod\/hashValue","role":"symbol","kind":"symbol","conformance":{"constraints":[{"type":"codeVoice","code":"Self"},{"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":"."}],"conformancePrefix":[{"type":"text","text":"Conforms when"}],"availabilityPrefix":[{"type":"text","text":"Available when"}]},"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PreferredAuthenticationMethod":{"url":"\/documentation\/auth0\/preferredauthenticationmethod","abstract":[],"title":"PreferredAuthenticationMethod","navigatorTitle":[{"text":"PreferredAuthenticationMethod","kind":"identifier"}],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PreferredAuthenticationMethod"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/preferredauthenticationmethod/init(rawvalue:).json b/docs/data/documentation/auth0/preferredauthenticationmethod/init(rawvalue:).json index 348650f6e..5162f1734 100644 --- a/docs/data/documentation/auth0/preferredauthenticationmethod/init(rawvalue:).json +++ b/docs/data/documentation/auth0/preferredauthenticationmethod/init(rawvalue:).json @@ -1 +1 @@ -{"kind":"symbol","sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod"]]},"metadata":{"roleHeading":"Initializer","role":"symbol","modules":[{"name":"Auth0"}],"externalID":"s:5Auth029PreferredAuthenticationMethodO8rawValueACSgSS_tcfc","fragments":[{"text":"init","kind":"identifier"},{"text":"?(","kind":"text"},{"text":"rawValue","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":")","kind":"text"}],"symbolKind":"init","title":"init(rawValue:)"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod\/init(rawValue:)"},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"init","kind":"keyword"},{"text":"?(","kind":"text"},{"text":"rawValue","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":")","kind":"text"}],"languages":["swift"]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/preferredauthenticationmethod\/init(rawvalue:)"]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"abstract":[{"text":"Inherited from ","type":"text"},{"code":"RawRepresentable.init(rawValue:)","type":"codeVoice"},{"text":".","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/PreferredAuthenticationMethod/init(rawValue:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod\/init(rawValue:)","role":"symbol","abstract":[],"fragments":[{"text":"init","kind":"identifier"},{"text":"?(","kind":"text"},{"text":"rawValue","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":")","kind":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/preferredauthenticationmethod\/init(rawvalue:)","type":"topic","title":"init(rawValue:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/PreferredAuthenticationMethod":{"abstract":[],"role":"symbol","url":"\/documentation\/auth0\/preferredauthenticationmethod","title":"PreferredAuthenticationMethod","navigatorTitle":[{"kind":"identifier","text":"PreferredAuthenticationMethod"}],"type":"topic","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PreferredAuthenticationMethod"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod","kind":"symbol"}}} \ No newline at end of file +{"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"init"},{"kind":"text","text":"?("},{"kind":"externalParam","text":"rawValue"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":")"}],"languages":["swift"],"platforms":["iOS"]}]}],"variants":[{"paths":["\/documentation\/auth0\/preferredauthenticationmethod\/init(rawvalue:)"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod\/init(rawValue:)"},"abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"RawRepresentable.init(rawValue:)"},{"type":"text","text":"."}],"metadata":{"role":"symbol","modules":[{"name":"Auth0"}],"title":"init(rawValue:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"?("},{"kind":"externalParam","text":"rawValue"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":")"}],"externalID":"s:5Auth029PreferredAuthenticationMethodO8rawValueACSgSS_tcfc","roleHeading":"Initializer","symbolKind":"init"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PreferredAuthenticationMethod/init(rawValue:)":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod\/init(rawValue:)","title":"init(rawValue:)","fragments":[{"text":"init","kind":"identifier"},{"text":"?(","kind":"text"},{"text":"rawValue","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":")","kind":"text"}],"role":"symbol","url":"\/documentation\/auth0\/preferredauthenticationmethod\/init(rawvalue:)","abstract":[],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PreferredAuthenticationMethod":{"url":"\/documentation\/auth0\/preferredauthenticationmethod","abstract":[],"title":"PreferredAuthenticationMethod","navigatorTitle":[{"text":"PreferredAuthenticationMethod","kind":"identifier"}],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PreferredAuthenticationMethod"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod","role":"symbol","kind":"symbol","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/preferredauthenticationmethod/rawrepresentable-implementations.json b/docs/data/documentation/auth0/preferredauthenticationmethod/rawrepresentable-implementations.json index 3a3752dcd..278d2669e 100644 --- a/docs/data/documentation/auth0/preferredauthenticationmethod/rawrepresentable-implementations.json +++ b/docs/data/documentation/auth0/preferredauthenticationmethod/rawrepresentable-implementations.json @@ -1 +1 @@ -{"variants":[{"paths":["\/documentation\/auth0\/preferredauthenticationmethod\/rawrepresentable-implementations"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod\/hashValue"],"title":"Instance Properties","generated":true,"anchor":"Instance-Properties"},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod\/hash(into:)"],"title":"Instance Methods","generated":true,"anchor":"Instance-Methods"}],"kind":"article","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod\/RawRepresentable-Implementations"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod"]]},"metadata":{"title":"RawRepresentable Implementations","modules":[{"name":"Auth0"}],"roleHeading":"API Collection","role":"collectionGroup"},"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PreferredAuthenticationMethod/hashValue":{"abstract":[],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod\/hashValue","conformance":{"availabilityPrefix":[{"type":"text","text":"Available when"}],"conformancePrefix":[{"type":"text","text":"Conforms when"}],"constraints":[{"type":"codeVoice","code":"Self"},{"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":"."}]},"title":"hashValue","kind":"symbol","url":"\/documentation\/auth0\/preferredauthenticationmethod\/hashvalue","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"hashValue","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/PreferredAuthenticationMethod/hash(into:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod\/hash(into:)","title":"hash(into:)","role":"symbol","abstract":[],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"hash","kind":"identifier"},{"text":"(","kind":"text"},{"text":"into","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"inout","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Hasher","preciseIdentifier":"s:s6HasherV","kind":"typeIdentifier"},{"text":")","kind":"text"}],"conformance":{"constraints":[{"type":"codeVoice","code":"Self"},{"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"}]},"type":"topic","kind":"symbol","url":"\/documentation\/auth0\/preferredauthenticationmethod\/hash(into:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/PreferredAuthenticationMethod":{"abstract":[],"role":"symbol","url":"\/documentation\/auth0\/preferredauthenticationmethod","title":"PreferredAuthenticationMethod","navigatorTitle":[{"kind":"identifier","text":"PreferredAuthenticationMethod"}],"type":"topic","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PreferredAuthenticationMethod"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod","kind":"symbol"}}} \ No newline at end of file +{"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod\/RawRepresentable-Implementations"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/preferredauthenticationmethod\/rawrepresentable-implementations"]}],"kind":"article","metadata":{"roleHeading":"API Collection","modules":[{"name":"Auth0"}],"role":"collectionGroup","title":"RawRepresentable Implementations"},"schemaVersion":{"major":0,"minor":3,"patch":0},"topicSections":[{"generated":true,"title":"Instance Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod\/hashValue"],"anchor":"Instance-Properties"},{"generated":true,"title":"Instance Methods","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod\/hash(into:)"],"anchor":"Instance-Methods"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PreferredAuthenticationMethod/hashValue":{"url":"\/documentation\/auth0\/preferredauthenticationmethod\/hashvalue","abstract":[],"title":"hashValue","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"hashValue","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Int","preciseIdentifier":"s:Si","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod\/hashValue","role":"symbol","kind":"symbol","conformance":{"constraints":[{"type":"codeVoice","code":"Self"},{"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":"."}],"conformancePrefix":[{"type":"text","text":"Conforms when"}],"availabilityPrefix":[{"type":"text","text":"Available when"}]},"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PreferredAuthenticationMethod/hash(into:)":{"title":"hash(into:)","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod\/hash(into:)","role":"symbol","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"hash","kind":"identifier"},{"text":"(","kind":"text"},{"text":"into","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"inout","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Hasher","preciseIdentifier":"s:s6HasherV","kind":"typeIdentifier"},{"text":")","kind":"text"}],"abstract":[],"conformance":{"constraints":[{"type":"codeVoice","code":"Self"},{"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"}]},"url":"\/documentation\/auth0\/preferredauthenticationmethod\/hash(into:)"},"doc://com.auth0.Auth0/documentation/Auth0/PreferredAuthenticationMethod":{"url":"\/documentation\/auth0\/preferredauthenticationmethod","abstract":[],"title":"PreferredAuthenticationMethod","navigatorTitle":[{"text":"PreferredAuthenticationMethod","kind":"identifier"}],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PreferredAuthenticationMethod"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/preferredauthenticationmethod/sms.json b/docs/data/documentation/auth0/preferredauthenticationmethod/sms.json index 939fe33f7..efd8f4479 100644 --- a/docs/data/documentation/auth0/preferredauthenticationmethod/sms.json +++ b/docs/data/documentation/auth0/preferredauthenticationmethod/sms.json @@ -1 +1 @@ -{"metadata":{"modules":[{"name":"Auth0"}],"symbolKind":"case","role":"symbol","roleHeading":"Case","externalID":"s:5Auth029PreferredAuthenticationMethodO3smsyA2CmF","title":"PreferredAuthenticationMethod.sms","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"text":"sms","kind":"identifier"}]},"kind":"symbol","primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"sms","kind":"identifier"}],"platforms":["iOS"]}],"kind":"declarations"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod\/sms","interfaceLanguage":"swift"},"sections":[],"variants":[{"paths":["\/documentation\/auth0\/preferredauthenticationmethod\/sms"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"minor":3,"major":0,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/PreferredAuthenticationMethod":{"abstract":[],"role":"symbol","url":"\/documentation\/auth0\/preferredauthenticationmethod","title":"PreferredAuthenticationMethod","navigatorTitle":[{"kind":"identifier","text":"PreferredAuthenticationMethod"}],"type":"topic","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PreferredAuthenticationMethod"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/PreferredAuthenticationMethod/sms":{"fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"sms"}],"abstract":[],"type":"topic","title":"PreferredAuthenticationMethod.sms","role":"symbol","url":"\/documentation\/auth0\/preferredauthenticationmethod\/sms","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod\/sms"}}} \ No newline at end of file +{"metadata":{"externalID":"s:5Auth029PreferredAuthenticationMethodO3smsyA2CmF","modules":[{"name":"Auth0"}],"title":"PreferredAuthenticationMethod.sms","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"sms","kind":"identifier"}],"roleHeading":"Case","role":"symbol","symbolKind":"case"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/preferredauthenticationmethod\/sms"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod\/sms","interfaceLanguage":"swift"},"kind":"symbol","primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"sms","kind":"identifier"}],"platforms":["iOS"]}],"kind":"declarations"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod"]]},"schemaVersion":{"patch":0,"minor":3,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PreferredAuthenticationMethod":{"url":"\/documentation\/auth0\/preferredauthenticationmethod","abstract":[],"title":"PreferredAuthenticationMethod","navigatorTitle":[{"text":"PreferredAuthenticationMethod","kind":"identifier"}],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PreferredAuthenticationMethod"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PreferredAuthenticationMethod/sms":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod\/sms","title":"PreferredAuthenticationMethod.sms","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"sms","kind":"identifier"}],"role":"symbol","url":"\/documentation\/auth0\/preferredauthenticationmethod\/sms","abstract":[],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/preferredauthenticationmethod/voice.json b/docs/data/documentation/auth0/preferredauthenticationmethod/voice.json index 40a2438c2..7b078a692 100644 --- a/docs/data/documentation/auth0/preferredauthenticationmethod/voice.json +++ b/docs/data/documentation/auth0/preferredauthenticationmethod/voice.json @@ -1 +1 @@ -{"kind":"symbol","metadata":{"modules":[{"name":"Auth0"}],"externalID":"s:5Auth029PreferredAuthenticationMethodO5voiceyA2CmF","symbolKind":"case","title":"PreferredAuthenticationMethod.voice","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"voice","kind":"identifier"}],"roleHeading":"Case","role":"symbol"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod"]]},"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"voice"}]}]}],"variants":[{"paths":["\/documentation\/auth0\/preferredauthenticationmethod\/voice"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"minor":3,"major":0,"patch":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod\/voice"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PreferredAuthenticationMethod/voice":{"title":"PreferredAuthenticationMethod.voice","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"voice"}],"abstract":[],"url":"\/documentation\/auth0\/preferredauthenticationmethod\/voice","type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod\/voice","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/PreferredAuthenticationMethod":{"abstract":[],"role":"symbol","url":"\/documentation\/auth0\/preferredauthenticationmethod","title":"PreferredAuthenticationMethod","navigatorTitle":[{"kind":"identifier","text":"PreferredAuthenticationMethod"}],"type":"topic","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PreferredAuthenticationMethod"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"voice"}],"languages":["swift"],"platforms":["iOS"]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/preferredauthenticationmethod\/voice"]}],"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod\/voice"},"metadata":{"roleHeading":"Case","symbolKind":"case","role":"symbol","title":"PreferredAuthenticationMethod.voice","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"voice"}],"externalID":"s:5Auth029PreferredAuthenticationMethodO5voiceyA2CmF","modules":[{"name":"Auth0"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PreferredAuthenticationMethod/voice":{"kind":"symbol","title":"PreferredAuthenticationMethod.voice","role":"symbol","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"voice"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod\/voice","abstract":[],"url":"\/documentation\/auth0\/preferredauthenticationmethod\/voice"},"doc://com.auth0.Auth0/documentation/Auth0/PreferredAuthenticationMethod":{"url":"\/documentation\/auth0\/preferredauthenticationmethod","abstract":[],"title":"PreferredAuthenticationMethod","navigatorTitle":[{"text":"PreferredAuthenticationMethod","kind":"identifier"}],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"PreferredAuthenticationMethod"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PreferredAuthenticationMethod","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/pushenrollmentchallenge.json b/docs/data/documentation/auth0/pushenrollmentchallenge.json index dfd614eb3..e38d5abaf 100644 --- a/docs/data/documentation/auth0/pushenrollmentchallenge.json +++ b/docs/data/documentation/auth0/pushenrollmentchallenge.json @@ -1 +1 @@ -{"abstract":[{"type":"text","text":"A Push enrollment challenge."}],"sections":[],"schemaVersion":{"major":0,"patch":0,"minor":3},"kind":"symbol","topicSections":[{"anchor":"Instance-Properties","title":"Instance Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge\/authenticationId","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge\/authenticationSession","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge\/authenticatorManualInputCode","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge\/authenticatorQRCodeURI"],"generated":true},{"anchor":"Default-Implementations","title":"Default Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge\/Decodable-Implementations"],"generated":true}],"relationshipsSections":[{"type":"conformsTo","title":"Conforms To","kind":"relationships","identifiers":["doc:\/\/com.auth0.Auth0\/s8CopyableP","doc:\/\/com.auth0.Auth0\/Se"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge","interfaceLanguage":"swift"},"metadata":{"navigatorTitle":[{"text":"PushEnrollmentChallenge","kind":"identifier"}],"role":"symbol","title":"PushEnrollmentChallenge","externalID":"s:5Auth023PushEnrollmentChallengeV","roleHeading":"Structure","symbolKind":"struct","modules":[{"name":"Auth0"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PushEnrollmentChallenge","kind":"identifier"}]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/pushenrollmentchallenge"]}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PushEnrollmentChallenge","kind":"identifier"}],"languages":["swift"]}],"kind":"declarations"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PushEnrollmentChallenge/authenticatorQRCodeURI":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge\/authenticatorQRCodeURI","type":"topic","kind":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authenticatorQRCodeURI","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"title":"authenticatorQRCodeURI","abstract":[{"text":"The URI for the QR code to be scanned by the authenticator.","type":"text"}],"url":"\/documentation\/auth0\/pushenrollmentchallenge\/authenticatorqrcodeuri"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/PushEnrollmentChallenge":{"title":"PushEnrollmentChallenge","abstract":[{"type":"text","text":"A Push enrollment challenge."}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PushEnrollmentChallenge","kind":"identifier"}],"navigatorTitle":[{"text":"PushEnrollmentChallenge","kind":"identifier"}],"url":"\/documentation\/auth0\/pushenrollmentchallenge","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/PushEnrollmentChallenge/authenticatorManualInputCode":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge\/authenticatorManualInputCode","url":"\/documentation\/auth0\/pushenrollmentchallenge\/authenticatormanualinputcode","role":"symbol","kind":"symbol","title":"authenticatorManualInputCode","type":"topic","abstract":[{"text":"The manual input code for the authenticator in case QR codes cannot be used.","type":"text"}],"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authenticatorManualInputCode","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}]},"doc://com.auth0.Auth0/s8CopyableP":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s8CopyableP","title":"Swift.Copyable"},"doc://com.auth0.Auth0/Se":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/Se","title":"Swift.Decodable"},"doc://com.auth0.Auth0/documentation/Auth0/PushEnrollmentChallenge/authenticationId":{"role":"symbol","abstract":[{"text":"The unique identifier for the authentication method.","type":"text"}],"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authenticationId","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"type":"topic","title":"authenticationId","url":"\/documentation\/auth0\/pushenrollmentchallenge\/authenticationid","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge\/authenticationId"},"doc://com.auth0.Auth0/documentation/Auth0/PushEnrollmentChallenge/authenticationSession":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge\/authenticationSession","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticationSession"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"title":"authenticationSession","abstract":[{"type":"text","text":"The unique session identifier for the enrollment."}],"role":"symbol","url":"\/documentation\/auth0\/pushenrollmentchallenge\/authenticationsession","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PushEnrollmentChallenge/Decodable-Implementations":{"role":"collectionGroup","abstract":[],"type":"topic","title":"Decodable Implementations","url":"\/documentation\/auth0\/pushenrollmentchallenge\/decodable-implementations","kind":"article","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge\/Decodable-Implementations"}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/pushenrollmentchallenge"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"abstract":[{"type":"text","text":"A Push enrollment challenge."}],"topicSections":[{"title":"Instance Properties","generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge\/authenticationId","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge\/authenticationSession","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge\/authenticatorManualInputCode","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge\/authenticatorQRCodeURI"],"anchor":"Instance-Properties"},{"title":"Default Implementations","generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge\/Decodable-Implementations"],"anchor":"Default-Implementations"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","sections":[],"relationshipsSections":[{"title":"Conforms To","type":"conformsTo","kind":"relationships","identifiers":["doc:\/\/com.auth0.Auth0\/s8CopyableP","doc:\/\/com.auth0.Auth0\/Se"]}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"PushEnrollmentChallenge"}]}],"kind":"declarations"}],"metadata":{"externalID":"s:5Auth023PushEnrollmentChallengeV","symbolKind":"struct","title":"PushEnrollmentChallenge","roleHeading":"Structure","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"PushEnrollmentChallenge"}],"navigatorTitle":[{"kind":"identifier","text":"PushEnrollmentChallenge"}],"modules":[{"name":"Auth0"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PushEnrollmentChallenge":{"type":"topic","title":"PushEnrollmentChallenge","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge","kind":"symbol","abstract":[{"type":"text","text":"A Push enrollment challenge."}],"url":"\/documentation\/auth0\/pushenrollmentchallenge","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"PushEnrollmentChallenge"}],"navigatorTitle":[{"kind":"identifier","text":"PushEnrollmentChallenge"}]},"doc://com.auth0.Auth0/documentation/Auth0/PushEnrollmentChallenge/authenticatorQRCodeURI":{"kind":"symbol","abstract":[{"type":"text","text":"The URI for the QR code to be scanned by the authenticator."}],"type":"topic","title":"authenticatorQRCodeURI","url":"\/documentation\/auth0\/pushenrollmentchallenge\/authenticatorqrcodeuri","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authenticatorQRCodeURI","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge\/authenticatorQRCodeURI"},"doc://com.auth0.Auth0/s8CopyableP":{"title":"Swift.Copyable","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s8CopyableP"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PushEnrollmentChallenge/authenticationSession":{"url":"\/documentation\/auth0\/pushenrollmentchallenge\/authenticationsession","abstract":[{"type":"text","text":"The unique session identifier for the enrollment."}],"title":"authenticationSession","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"authenticationSession","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge\/authenticationSession","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PushEnrollmentChallenge/authenticationId":{"url":"\/documentation\/auth0\/pushenrollmentchallenge\/authenticationid","abstract":[{"type":"text","text":"The unique identifier for the authentication method."}],"title":"authenticationId","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authenticationId","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge\/authenticationId","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PushEnrollmentChallenge/authenticatorManualInputCode":{"type":"topic","abstract":[{"text":"The manual input code for the authenticator in case QR codes cannot be used.","type":"text"}],"title":"authenticatorManualInputCode","url":"\/documentation\/auth0\/pushenrollmentchallenge\/authenticatormanualinputcode","kind":"symbol","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authenticatorManualInputCode","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge\/authenticatorManualInputCode"},"doc://com.auth0.Auth0/Se":{"title":"Swift.Decodable","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/Se"},"doc://com.auth0.Auth0/documentation/Auth0/PushEnrollmentChallenge/Decodable-Implementations":{"type":"topic","abstract":[],"title":"Decodable Implementations","url":"\/documentation\/auth0\/pushenrollmentchallenge\/decodable-implementations","kind":"article","role":"collectionGroup","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge\/Decodable-Implementations"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/pushenrollmentchallenge/authenticationid.json b/docs/data/documentation/auth0/pushenrollmentchallenge/authenticationid.json index 9c6dcf165..7baf50f61 100644 --- a/docs/data/documentation/auth0/pushenrollmentchallenge/authenticationid.json +++ b/docs/data/documentation/auth0/pushenrollmentchallenge/authenticationid.json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticationId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}]}]}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge"]]},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/pushenrollmentchallenge\/authenticationid"]}],"abstract":[{"type":"text","text":"The unique identifier for the authentication method."}],"metadata":{"roleHeading":"Instance Property","role":"symbol","symbolKind":"property","title":"authenticationId","externalID":"s:5Auth023PushEnrollmentChallengeV16authenticationIdSSvp","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticationId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}]},"schemaVersion":{"patch":0,"major":0,"minor":3},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge\/authenticationId","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PushEnrollmentChallenge":{"title":"PushEnrollmentChallenge","abstract":[{"type":"text","text":"A Push enrollment challenge."}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PushEnrollmentChallenge","kind":"identifier"}],"navigatorTitle":[{"text":"PushEnrollmentChallenge","kind":"identifier"}],"url":"\/documentation\/auth0\/pushenrollmentchallenge","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/PushEnrollmentChallenge/authenticationId":{"role":"symbol","abstract":[{"text":"The unique identifier for the authentication method.","type":"text"}],"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authenticationId","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"type":"topic","title":"authenticationId","url":"\/documentation\/auth0\/pushenrollmentchallenge\/authenticationid","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge\/authenticationId"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge"]]},"metadata":{"externalID":"s:5Auth023PushEnrollmentChallengeV16authenticationIdSSvp","symbolKind":"property","title":"authenticationId","role":"symbol","roleHeading":"Instance Property","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authenticationId","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"modules":[{"name":"Auth0"}]},"sections":[],"abstract":[{"type":"text","text":"The unique identifier for the authentication method."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/pushenrollmentchallenge\/authenticationid"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge\/authenticationId"},"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authenticationId","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/PushEnrollmentChallenge/authenticationId":{"url":"\/documentation\/auth0\/pushenrollmentchallenge\/authenticationid","abstract":[{"type":"text","text":"The unique identifier for the authentication method."}],"title":"authenticationId","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authenticationId","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge\/authenticationId","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PushEnrollmentChallenge":{"type":"topic","title":"PushEnrollmentChallenge","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge","kind":"symbol","abstract":[{"type":"text","text":"A Push enrollment challenge."}],"url":"\/documentation\/auth0\/pushenrollmentchallenge","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"PushEnrollmentChallenge"}],"navigatorTitle":[{"kind":"identifier","text":"PushEnrollmentChallenge"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/pushenrollmentchallenge/authenticationsession.json b/docs/data/documentation/auth0/pushenrollmentchallenge/authenticationsession.json index dfccef9a3..2a901d90e 100644 --- a/docs/data/documentation/auth0/pushenrollmentchallenge/authenticationsession.json +++ b/docs/data/documentation/auth0/pushenrollmentchallenge/authenticationsession.json @@ -1 +1 @@ -{"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge"]]},"sections":[],"schemaVersion":{"major":0,"patch":0,"minor":3},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticationSession"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"variants":[{"paths":["\/documentation\/auth0\/pushenrollmentchallenge\/authenticationsession"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge\/authenticationSession","interfaceLanguage":"swift"},"metadata":{"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticationSession"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"title":"authenticationSession","roleHeading":"Instance Property","symbolKind":"property","modules":[{"name":"Auth0"}],"role":"symbol","externalID":"s:5Auth023PushEnrollmentChallengeV21authenticationSessionSSvp"},"abstract":[{"text":"The unique session identifier for the enrollment.","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/PushEnrollmentChallenge":{"title":"PushEnrollmentChallenge","abstract":[{"type":"text","text":"A Push enrollment challenge."}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PushEnrollmentChallenge","kind":"identifier"}],"navigatorTitle":[{"text":"PushEnrollmentChallenge","kind":"identifier"}],"url":"\/documentation\/auth0\/pushenrollmentchallenge","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/PushEnrollmentChallenge/authenticationSession":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge\/authenticationSession","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticationSession"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"title":"authenticationSession","abstract":[{"type":"text","text":"The unique session identifier for the enrollment."}],"role":"symbol","url":"\/documentation\/auth0\/pushenrollmentchallenge\/authenticationsession","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge"]]},"metadata":{"roleHeading":"Instance Property","symbolKind":"property","title":"authenticationSession","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticationSession"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"externalID":"s:5Auth023PushEnrollmentChallengeV21authenticationSessionSSvp","modules":[{"name":"Auth0"}]},"sections":[],"abstract":[{"type":"text","text":"The unique session identifier for the enrollment."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/pushenrollmentchallenge\/authenticationsession"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge\/authenticationSession","interfaceLanguage":"swift"},"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticationSession"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}]}],"kind":"declarations"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/PushEnrollmentChallenge":{"type":"topic","title":"PushEnrollmentChallenge","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge","kind":"symbol","abstract":[{"type":"text","text":"A Push enrollment challenge."}],"url":"\/documentation\/auth0\/pushenrollmentchallenge","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"PushEnrollmentChallenge"}],"navigatorTitle":[{"kind":"identifier","text":"PushEnrollmentChallenge"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PushEnrollmentChallenge/authenticationSession":{"url":"\/documentation\/auth0\/pushenrollmentchallenge\/authenticationsession","abstract":[{"type":"text","text":"The unique session identifier for the enrollment."}],"title":"authenticationSession","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"authenticationSession","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge\/authenticationSession","role":"symbol","kind":"symbol","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/pushenrollmentchallenge/authenticatormanualinputcode.json b/docs/data/documentation/auth0/pushenrollmentchallenge/authenticatormanualinputcode.json index 74a9d1b2c..980747c08 100644 --- a/docs/data/documentation/auth0/pushenrollmentchallenge/authenticatormanualinputcode.json +++ b/docs/data/documentation/auth0/pushenrollmentchallenge/authenticatormanualinputcode.json @@ -1 +1 @@ -{"metadata":{"role":"symbol","modules":[{"name":"Auth0"}],"symbolKind":"property","externalID":"s:5Auth023PushEnrollmentChallengeV28authenticatorManualInputCodeSSSgvp","title":"authenticatorManualInputCode","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authenticatorManualInputCode","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"roleHeading":"Instance Property"},"kind":"symbol","primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authenticatorManualInputCode","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"platforms":["iOS"]}],"kind":"declarations"}],"schemaVersion":{"patch":0,"major":0,"minor":3},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge\/authenticatorManualInputCode"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/pushenrollmentchallenge\/authenticatormanualinputcode"]}],"abstract":[{"text":"The manual input code for the authenticator in case QR codes cannot be used.","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge"]]},"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/PushEnrollmentChallenge/authenticatorManualInputCode":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge\/authenticatorManualInputCode","url":"\/documentation\/auth0\/pushenrollmentchallenge\/authenticatormanualinputcode","role":"symbol","kind":"symbol","title":"authenticatorManualInputCode","type":"topic","abstract":[{"text":"The manual input code for the authenticator in case QR codes cannot be used.","type":"text"}],"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authenticatorManualInputCode","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/PushEnrollmentChallenge":{"title":"PushEnrollmentChallenge","abstract":[{"type":"text","text":"A Push enrollment challenge."}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PushEnrollmentChallenge","kind":"identifier"}],"navigatorTitle":[{"text":"PushEnrollmentChallenge","kind":"identifier"}],"url":"\/documentation\/auth0\/pushenrollmentchallenge","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/pushenrollmentchallenge\/authenticatormanualinputcode"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge"]]},"abstract":[{"text":"The manual input code for the authenticator in case QR codes cannot be used.","type":"text"}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authenticatorManualInputCode","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"platforms":["iOS"]}],"kind":"declarations"}],"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","metadata":{"externalID":"s:5Auth023PushEnrollmentChallengeV28authenticatorManualInputCodeSSSgvp","symbolKind":"property","title":"authenticatorManualInputCode","role":"symbol","roleHeading":"Instance Property","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authenticatorManualInputCode","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"modules":[{"name":"Auth0"}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge\/authenticatorManualInputCode"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PushEnrollmentChallenge":{"type":"topic","title":"PushEnrollmentChallenge","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge","kind":"symbol","abstract":[{"type":"text","text":"A Push enrollment challenge."}],"url":"\/documentation\/auth0\/pushenrollmentchallenge","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"PushEnrollmentChallenge"}],"navigatorTitle":[{"kind":"identifier","text":"PushEnrollmentChallenge"}]},"doc://com.auth0.Auth0/documentation/Auth0/PushEnrollmentChallenge/authenticatorManualInputCode":{"type":"topic","abstract":[{"text":"The manual input code for the authenticator in case QR codes cannot be used.","type":"text"}],"title":"authenticatorManualInputCode","url":"\/documentation\/auth0\/pushenrollmentchallenge\/authenticatormanualinputcode","kind":"symbol","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authenticatorManualInputCode","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge\/authenticatorManualInputCode"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/pushenrollmentchallenge/authenticatorqrcodeuri.json b/docs/data/documentation/auth0/pushenrollmentchallenge/authenticatorqrcodeuri.json index 7d273b5b8..35f751d4f 100644 --- a/docs/data/documentation/auth0/pushenrollmentchallenge/authenticatorqrcodeuri.json +++ b/docs/data/documentation/auth0/pushenrollmentchallenge/authenticatorqrcodeuri.json @@ -1 +1 @@ -{"metadata":{"externalID":"s:5Auth023PushEnrollmentChallengeV22authenticatorQRCodeURISSvp","symbolKind":"property","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authenticatorQRCodeURI","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"role":"symbol","roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"title":"authenticatorQRCodeURI"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge\/authenticatorQRCodeURI","interfaceLanguage":"swift"},"kind":"symbol","sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge"]]},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authenticatorQRCodeURI","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/pushenrollmentchallenge\/authenticatorqrcodeuri"]}],"abstract":[{"text":"The URI for the QR code to be scanned by the authenticator.","type":"text"}],"schemaVersion":{"minor":3,"patch":0,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PushEnrollmentChallenge":{"title":"PushEnrollmentChallenge","abstract":[{"type":"text","text":"A Push enrollment challenge."}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PushEnrollmentChallenge","kind":"identifier"}],"navigatorTitle":[{"text":"PushEnrollmentChallenge","kind":"identifier"}],"url":"\/documentation\/auth0\/pushenrollmentchallenge","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/PushEnrollmentChallenge/authenticatorQRCodeURI":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge\/authenticatorQRCodeURI","type":"topic","kind":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authenticatorQRCodeURI","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"title":"authenticatorQRCodeURI","abstract":[{"text":"The URI for the QR code to be scanned by the authenticator.","type":"text"}],"url":"\/documentation\/auth0\/pushenrollmentchallenge\/authenticatorqrcodeuri"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"sections":[],"variants":[{"paths":["\/documentation\/auth0\/pushenrollmentchallenge\/authenticatorqrcodeuri"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge"]]},"abstract":[{"type":"text","text":"The URI for the QR code to be scanned by the authenticator."}],"metadata":{"roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"role":"symbol","title":"authenticatorQRCodeURI","externalID":"s:5Auth023PushEnrollmentChallengeV22authenticatorQRCodeURISSvp","symbolKind":"property","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticatorQRCodeURI"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}]},"schemaVersion":{"patch":0,"minor":3,"major":0},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticatorQRCodeURI"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge\/authenticatorQRCodeURI","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/PushEnrollmentChallenge":{"type":"topic","title":"PushEnrollmentChallenge","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge","kind":"symbol","abstract":[{"type":"text","text":"A Push enrollment challenge."}],"url":"\/documentation\/auth0\/pushenrollmentchallenge","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"PushEnrollmentChallenge"}],"navigatorTitle":[{"kind":"identifier","text":"PushEnrollmentChallenge"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PushEnrollmentChallenge/authenticatorQRCodeURI":{"kind":"symbol","abstract":[{"type":"text","text":"The URI for the QR code to be scanned by the authenticator."}],"type":"topic","title":"authenticatorQRCodeURI","url":"\/documentation\/auth0\/pushenrollmentchallenge\/authenticatorqrcodeuri","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authenticatorQRCodeURI","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge\/authenticatorQRCodeURI"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/pushenrollmentchallenge/decodable-implementations.json b/docs/data/documentation/auth0/pushenrollmentchallenge/decodable-implementations.json index 6aeb0f44a..72628e66d 100644 --- a/docs/data/documentation/auth0/pushenrollmentchallenge/decodable-implementations.json +++ b/docs/data/documentation/auth0/pushenrollmentchallenge/decodable-implementations.json @@ -1 +1 @@ -{"metadata":{"roleHeading":"API Collection","modules":[{"name":"Auth0"}],"title":"Decodable Implementations","role":"collectionGroup"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge"]]},"kind":"article","schemaVersion":{"major":0,"patch":0,"minor":3},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/pushenrollmentchallenge\/decodable-implementations"]}],"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge\/Decodable-Implementations","interfaceLanguage":"swift"},"topicSections":[{"title":"Initializers","anchor":"Initializers","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge\/init(from:)"],"generated":true}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/PushEnrollmentChallenge/init(from:)":{"url":"\/documentation\/auth0\/pushenrollmentchallenge\/init(from:)","title":"init(from:)","role":"symbol","kind":"symbol","abstract":[{"type":"codeVoice","code":"Decodable"},{"type":"text","text":" initializer."}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge\/init(from:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Decoder","preciseIdentifier":"s:s7DecoderP"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/PushEnrollmentChallenge":{"title":"PushEnrollmentChallenge","abstract":[{"type":"text","text":"A Push enrollment challenge."}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PushEnrollmentChallenge","kind":"identifier"}],"navigatorTitle":[{"text":"PushEnrollmentChallenge","kind":"identifier"}],"url":"\/documentation\/auth0\/pushenrollmentchallenge","role":"symbol"}}} \ No newline at end of file +{"topicSections":[{"generated":true,"title":"Initializers","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge\/init(from:)"],"anchor":"Initializers"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge"]]},"metadata":{"title":"Decodable Implementations","role":"collectionGroup","modules":[{"name":"Auth0"}],"roleHeading":"API Collection"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/pushenrollmentchallenge\/decodable-implementations"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge\/Decodable-Implementations","interfaceLanguage":"swift"},"kind":"article","schemaVersion":{"minor":3,"major":0,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PushEnrollmentChallenge":{"type":"topic","title":"PushEnrollmentChallenge","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge","kind":"symbol","abstract":[{"type":"text","text":"A Push enrollment challenge."}],"url":"\/documentation\/auth0\/pushenrollmentchallenge","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"PushEnrollmentChallenge"}],"navigatorTitle":[{"kind":"identifier","text":"PushEnrollmentChallenge"}]},"doc://com.auth0.Auth0/documentation/Auth0/PushEnrollmentChallenge/init(from:)":{"role":"symbol","title":"init(from:)","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"from"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier","text":"Decoder"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"abstract":[{"code":"Decodable","type":"codeVoice"},{"text":" initializer.","type":"text"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge\/init(from:)","url":"\/documentation\/auth0\/pushenrollmentchallenge\/init(from:)","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/pushenrollmentchallenge/init(from:).json b/docs/data/documentation/auth0/pushenrollmentchallenge/init(from:).json index 791f84f0a..7b9d4153b 100644 --- a/docs/data/documentation/auth0/pushenrollmentchallenge/init(from:).json +++ b/docs/data/documentation/auth0/pushenrollmentchallenge/init(from:).json @@ -1 +1 @@ -{"abstract":[{"code":"Decodable","type":"codeVoice"},{"text":" initializer.","type":"text"}],"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/pushenrollmentchallenge\/init(from:)"]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"metadata":{"fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Decoder","kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"externalID":"s:5Auth023PushEnrollmentChallengeV4fromACs7Decoder_p_tKcfc","role":"symbol","symbolKind":"init","extendedModule":"Auth0","title":"init(from:)","roleHeading":"Initializer","modules":[{"name":"Auth0"}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge\/init(from:)"},"kind":"symbol","primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"init","kind":"keyword"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"decoder","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"Decoder","preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}]}],"kind":"declarations"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/PushEnrollmentChallenge":{"title":"PushEnrollmentChallenge","abstract":[{"type":"text","text":"A Push enrollment challenge."}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PushEnrollmentChallenge","kind":"identifier"}],"navigatorTitle":[{"text":"PushEnrollmentChallenge","kind":"identifier"}],"url":"\/documentation\/auth0\/pushenrollmentchallenge","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/PushEnrollmentChallenge/init(from:)":{"url":"\/documentation\/auth0\/pushenrollmentchallenge\/init(from:)","title":"init(from:)","role":"symbol","kind":"symbol","abstract":[{"type":"codeVoice","code":"Decodable"},{"type":"text","text":" initializer."}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge\/init(from:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Decoder","preciseIdentifier":"s:s7DecoderP"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}]}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/pushenrollmentchallenge\/init(from:)"]}],"kind":"symbol","schemaVersion":{"patch":0,"major":0,"minor":3},"metadata":{"title":"init(from:)","role":"symbol","roleHeading":"Initializer","externalID":"s:5Auth023PushEnrollmentChallengeV4fromACs7Decoder_p_tKcfc","symbolKind":"init","extendedModule":"Auth0","modules":[{"name":"Auth0"}],"fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"text":"from","kind":"externalParam"},{"kind":"text","text":": "},{"text":"Decoder","preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}]},"abstract":[{"type":"codeVoice","code":"Decodable"},{"type":"text","text":" initializer."}],"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge\/init(from:)","interfaceLanguage":"swift"},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"init","kind":"keyword"},{"kind":"text","text":"("},{"text":"from","kind":"externalParam"},{"text":" ","kind":"text"},{"kind":"internalParam","text":"decoder"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP","text":"Decoder"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}]}],"kind":"declarations"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PushEnrollmentChallenge/init(from:)":{"role":"symbol","title":"init(from:)","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"from"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier","text":"Decoder"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"abstract":[{"code":"Decodable","type":"codeVoice"},{"text":" initializer.","type":"text"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge\/init(from:)","url":"\/documentation\/auth0\/pushenrollmentchallenge\/init(from:)","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/PushEnrollmentChallenge":{"type":"topic","title":"PushEnrollmentChallenge","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/PushEnrollmentChallenge","kind":"symbol","abstract":[{"type":"text","text":"A Push enrollment challenge."}],"url":"\/documentation\/auth0\/pushenrollmentchallenge","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"PushEnrollmentChallenge"}],"navigatorTitle":[{"kind":"identifier","text":"PushEnrollmentChallenge"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/recoverycodeenrollmentchallenge.json b/docs/data/documentation/auth0/recoverycodeenrollmentchallenge.json index 9ee1fc648..f48f905d0 100644 --- a/docs/data/documentation/auth0/recoverycodeenrollmentchallenge.json +++ b/docs/data/documentation/auth0/recoverycodeenrollmentchallenge.json @@ -1 +1 @@ -{"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/recoverycodeenrollmentchallenge"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"abstract":[{"type":"text","text":"A Recovery code enrollment challenge."}],"schemaVersion":{"patch":0,"minor":3,"major":0},"metadata":{"roleHeading":"Structure","modules":[{"name":"Auth0"}],"externalID":"s:5Auth031RecoveryCodeEnrollmentChallengeV","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"RecoveryCodeEnrollmentChallenge"}],"title":"RecoveryCodeEnrollmentChallenge","role":"symbol","navigatorTitle":[{"text":"RecoveryCodeEnrollmentChallenge","kind":"identifier"}],"symbolKind":"struct"},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"RecoveryCodeEnrollmentChallenge","kind":"identifier"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RecoveryCodeEnrollmentChallenge","interfaceLanguage":"swift"},"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RecoveryCodeEnrollmentChallenge\/authenticationId","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RecoveryCodeEnrollmentChallenge\/authenticationSession","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RecoveryCodeEnrollmentChallenge\/recoveryCode"],"anchor":"Instance-Properties","generated":true,"title":"Instance Properties"},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RecoveryCodeEnrollmentChallenge\/Decodable-Implementations"],"anchor":"Default-Implementations","generated":true,"title":"Default Implementations"}],"relationshipsSections":[{"type":"conformsTo","identifiers":["doc:\/\/com.auth0.Auth0\/s8CopyableP","doc:\/\/com.auth0.Auth0\/Se"],"title":"Conforms To","kind":"relationships"}],"sections":[],"references":{"doc://com.auth0.Auth0/s8CopyableP":{"identifier":"doc:\/\/com.auth0.Auth0\/s8CopyableP","title":"Swift.Copyable","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/RecoveryCodeEnrollmentChallenge":{"title":"RecoveryCodeEnrollmentChallenge","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RecoveryCodeEnrollmentChallenge","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"RecoveryCodeEnrollmentChallenge","kind":"identifier"}],"navigatorTitle":[{"text":"RecoveryCodeEnrollmentChallenge","kind":"identifier"}],"abstract":[{"type":"text","text":"A Recovery code enrollment challenge."}],"kind":"symbol","role":"symbol","url":"\/documentation\/auth0\/recoverycodeenrollmentchallenge"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/RecoveryCodeEnrollmentChallenge/Decodable-Implementations":{"title":"Decodable Implementations","url":"\/documentation\/auth0\/recoverycodeenrollmentchallenge\/decodable-implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RecoveryCodeEnrollmentChallenge\/Decodable-Implementations","abstract":[],"role":"collectionGroup","type":"topic","kind":"article"},"doc://com.auth0.Auth0/documentation/Auth0/RecoveryCodeEnrollmentChallenge/authenticationId":{"kind":"symbol","title":"authenticationId","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RecoveryCodeEnrollmentChallenge\/authenticationId","type":"topic","abstract":[{"type":"text","text":"The unique identifier for the authentication method."}],"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authenticationId","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"url":"\/documentation\/auth0\/recoverycodeenrollmentchallenge\/authenticationid"},"doc://com.auth0.Auth0/documentation/Auth0/RecoveryCodeEnrollmentChallenge/recoveryCode":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RecoveryCodeEnrollmentChallenge\/recoveryCode","url":"\/documentation\/auth0\/recoverycodeenrollmentchallenge\/recoverycode","kind":"symbol","title":"recoveryCode","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"recoveryCode"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"type":"topic","abstract":[{"type":"text","text":"The recovery code value."}]},"doc://com.auth0.Auth0/documentation/Auth0/RecoveryCodeEnrollmentChallenge/authenticationSession":{"type":"topic","abstract":[{"type":"text","text":"The unique session identifier for the enrollment."}],"role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authenticationSession","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RecoveryCodeEnrollmentChallenge\/authenticationSession","title":"authenticationSession","url":"\/documentation\/auth0\/recoverycodeenrollmentchallenge\/authenticationsession","kind":"symbol"},"doc://com.auth0.Auth0/Se":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/Se","title":"Swift.Decodable"}}} \ No newline at end of file +{"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RecoveryCodeEnrollmentChallenge","interfaceLanguage":"swift"},"metadata":{"symbolKind":"struct","title":"RecoveryCodeEnrollmentChallenge","externalID":"s:5Auth031RecoveryCodeEnrollmentChallengeV","roleHeading":"Structure","modules":[{"name":"Auth0"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"RecoveryCodeEnrollmentChallenge","kind":"identifier"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"RecoveryCodeEnrollmentChallenge"}]},"kind":"symbol","topicSections":[{"anchor":"Instance-Properties","title":"Instance Properties","generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RecoveryCodeEnrollmentChallenge\/authenticationId","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RecoveryCodeEnrollmentChallenge\/authenticationSession","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RecoveryCodeEnrollmentChallenge\/recoveryCode"]},{"anchor":"Default-Implementations","title":"Default Implementations","generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RecoveryCodeEnrollmentChallenge\/Decodable-Implementations"]}],"relationshipsSections":[{"type":"conformsTo","title":"Conforms To","identifiers":["doc:\/\/com.auth0.Auth0\/s8CopyableP","doc:\/\/com.auth0.Auth0\/Se"],"kind":"relationships"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/recoverycodeenrollmentchallenge"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"schemaVersion":{"minor":3,"patch":0,"major":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"RecoveryCodeEnrollmentChallenge","kind":"identifier"}],"platforms":["iOS"],"languages":["swift"]}]}],"abstract":[{"text":"A Recovery code enrollment challenge.","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/RecoveryCodeEnrollmentChallenge/authenticationSession":{"url":"\/documentation\/auth0\/recoverycodeenrollmentchallenge\/authenticationsession","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticationSession"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"title":"authenticationSession","type":"topic","role":"symbol","abstract":[{"type":"text","text":"The unique session identifier for the enrollment."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RecoveryCodeEnrollmentChallenge\/authenticationSession","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/RecoveryCodeEnrollmentChallenge/authenticationId":{"type":"topic","title":"authenticationId","url":"\/documentation\/auth0\/recoverycodeenrollmentchallenge\/authenticationid","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RecoveryCodeEnrollmentChallenge\/authenticationId","kind":"symbol","abstract":[{"type":"text","text":"The unique identifier for the authentication method."}],"role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticationId"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}]},"doc://com.auth0.Auth0/documentation/Auth0/RecoveryCodeEnrollmentChallenge/recoveryCode":{"title":"recoveryCode","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RecoveryCodeEnrollmentChallenge\/recoveryCode","type":"topic","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"recoveryCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"abstract":[{"type":"text","text":"The recovery code value."}],"url":"\/documentation\/auth0\/recoverycodeenrollmentchallenge\/recoverycode"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/RecoveryCodeEnrollmentChallenge/Decodable-Implementations":{"kind":"article","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RecoveryCodeEnrollmentChallenge\/Decodable-Implementations","title":"Decodable Implementations","role":"collectionGroup","url":"\/documentation\/auth0\/recoverycodeenrollmentchallenge\/decodable-implementations","abstract":[],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/RecoveryCodeEnrollmentChallenge":{"title":"RecoveryCodeEnrollmentChallenge","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RecoveryCodeEnrollmentChallenge","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"RecoveryCodeEnrollmentChallenge"}],"abstract":[{"type":"text","text":"A Recovery code enrollment challenge."}],"url":"\/documentation\/auth0\/recoverycodeenrollmentchallenge","navigatorTitle":[{"text":"RecoveryCodeEnrollmentChallenge","kind":"identifier"}]},"doc://com.auth0.Auth0/s8CopyableP":{"title":"Swift.Copyable","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s8CopyableP"},"doc://com.auth0.Auth0/Se":{"title":"Swift.Decodable","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/Se"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/recoverycodeenrollmentchallenge/authenticationid.json b/docs/data/documentation/auth0/recoverycodeenrollmentchallenge/authenticationid.json index 632475ca6..94dc52434 100644 --- a/docs/data/documentation/auth0/recoverycodeenrollmentchallenge/authenticationid.json +++ b/docs/data/documentation/auth0/recoverycodeenrollmentchallenge/authenticationid.json @@ -1 +1 @@ -{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/recoverycodeenrollmentchallenge\/authenticationid"]}],"abstract":[{"type":"text","text":"The unique identifier for the authentication method."}],"sections":[],"metadata":{"title":"authenticationId","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticationId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"modules":[{"name":"Auth0"}],"symbolKind":"property","externalID":"s:5Auth031RecoveryCodeEnrollmentChallengeV16authenticationIdSSvp","roleHeading":"Instance Property"},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RecoveryCodeEnrollmentChallenge"]]},"schemaVersion":{"minor":3,"patch":0,"major":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RecoveryCodeEnrollmentChallenge\/authenticationId","interfaceLanguage":"swift"},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authenticationId","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/RecoveryCodeEnrollmentChallenge":{"title":"RecoveryCodeEnrollmentChallenge","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RecoveryCodeEnrollmentChallenge","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"RecoveryCodeEnrollmentChallenge","kind":"identifier"}],"navigatorTitle":[{"text":"RecoveryCodeEnrollmentChallenge","kind":"identifier"}],"abstract":[{"type":"text","text":"A Recovery code enrollment challenge."}],"kind":"symbol","role":"symbol","url":"\/documentation\/auth0\/recoverycodeenrollmentchallenge"},"doc://com.auth0.Auth0/documentation/Auth0/RecoveryCodeEnrollmentChallenge/authenticationId":{"kind":"symbol","title":"authenticationId","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RecoveryCodeEnrollmentChallenge\/authenticationId","type":"topic","abstract":[{"type":"text","text":"The unique identifier for the authentication method."}],"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authenticationId","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"url":"\/documentation\/auth0\/recoverycodeenrollmentchallenge\/authenticationid"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"metadata":{"symbolKind":"property","roleHeading":"Instance Property","externalID":"s:5Auth031RecoveryCodeEnrollmentChallengeV16authenticationIdSSvp","title":"authenticationId","modules":[{"name":"Auth0"}],"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authenticationId","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"role":"symbol"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/recoverycodeenrollmentchallenge\/authenticationid"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RecoveryCodeEnrollmentChallenge\/authenticationId"},"kind":"symbol","abstract":[{"type":"text","text":"The unique identifier for the authentication method."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RecoveryCodeEnrollmentChallenge"]]},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authenticationId","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}]}],"kind":"declarations"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/RecoveryCodeEnrollmentChallenge/authenticationId":{"type":"topic","title":"authenticationId","url":"\/documentation\/auth0\/recoverycodeenrollmentchallenge\/authenticationid","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RecoveryCodeEnrollmentChallenge\/authenticationId","kind":"symbol","abstract":[{"type":"text","text":"The unique identifier for the authentication method."}],"role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticationId"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}]},"doc://com.auth0.Auth0/documentation/Auth0/RecoveryCodeEnrollmentChallenge":{"title":"RecoveryCodeEnrollmentChallenge","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RecoveryCodeEnrollmentChallenge","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"RecoveryCodeEnrollmentChallenge"}],"abstract":[{"type":"text","text":"A Recovery code enrollment challenge."}],"url":"\/documentation\/auth0\/recoverycodeenrollmentchallenge","navigatorTitle":[{"text":"RecoveryCodeEnrollmentChallenge","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/recoverycodeenrollmentchallenge/authenticationsession.json b/docs/data/documentation/auth0/recoverycodeenrollmentchallenge/authenticationsession.json index 23c54dd20..47d269d64 100644 --- a/docs/data/documentation/auth0/recoverycodeenrollmentchallenge/authenticationsession.json +++ b/docs/data/documentation/auth0/recoverycodeenrollmentchallenge/authenticationsession.json @@ -1 +1 @@ -{"metadata":{"externalID":"s:5Auth031RecoveryCodeEnrollmentChallengeV21authenticationSessionSSvp","symbolKind":"property","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authenticationSession","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"role":"symbol","roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"title":"authenticationSession"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RecoveryCodeEnrollmentChallenge\/authenticationSession","interfaceLanguage":"swift"},"kind":"symbol","sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RecoveryCodeEnrollmentChallenge"]]},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authenticationSession","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/recoverycodeenrollmentchallenge\/authenticationsession"]}],"abstract":[{"text":"The unique session identifier for the enrollment.","type":"text"}],"schemaVersion":{"minor":3,"patch":0,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/RecoveryCodeEnrollmentChallenge":{"title":"RecoveryCodeEnrollmentChallenge","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RecoveryCodeEnrollmentChallenge","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"RecoveryCodeEnrollmentChallenge","kind":"identifier"}],"navigatorTitle":[{"text":"RecoveryCodeEnrollmentChallenge","kind":"identifier"}],"abstract":[{"type":"text","text":"A Recovery code enrollment challenge."}],"kind":"symbol","role":"symbol","url":"\/documentation\/auth0\/recoverycodeenrollmentchallenge"},"doc://com.auth0.Auth0/documentation/Auth0/RecoveryCodeEnrollmentChallenge/authenticationSession":{"type":"topic","abstract":[{"type":"text","text":"The unique session identifier for the enrollment."}],"role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authenticationSession","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RecoveryCodeEnrollmentChallenge\/authenticationSession","title":"authenticationSession","url":"\/documentation\/auth0\/recoverycodeenrollmentchallenge\/authenticationsession","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"metadata":{"symbolKind":"property","modules":[{"name":"Auth0"}],"title":"authenticationSession","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"authenticationSession","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"externalID":"s:5Auth031RecoveryCodeEnrollmentChallengeV21authenticationSessionSSvp","role":"symbol","roleHeading":"Instance Property"},"sections":[],"variants":[{"paths":["\/documentation\/auth0\/recoverycodeenrollmentchallenge\/authenticationsession"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RecoveryCodeEnrollmentChallenge\/authenticationSession","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"type":"text","text":"The unique session identifier for the enrollment."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RecoveryCodeEnrollmentChallenge"]]},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"authenticationSession"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/RecoveryCodeEnrollmentChallenge":{"title":"RecoveryCodeEnrollmentChallenge","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RecoveryCodeEnrollmentChallenge","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"RecoveryCodeEnrollmentChallenge"}],"abstract":[{"type":"text","text":"A Recovery code enrollment challenge."}],"url":"\/documentation\/auth0\/recoverycodeenrollmentchallenge","navigatorTitle":[{"text":"RecoveryCodeEnrollmentChallenge","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/RecoveryCodeEnrollmentChallenge/authenticationSession":{"url":"\/documentation\/auth0\/recoverycodeenrollmentchallenge\/authenticationsession","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticationSession"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"title":"authenticationSession","type":"topic","role":"symbol","abstract":[{"type":"text","text":"The unique session identifier for the enrollment."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RecoveryCodeEnrollmentChallenge\/authenticationSession","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/recoverycodeenrollmentchallenge/decodable-implementations.json b/docs/data/documentation/auth0/recoverycodeenrollmentchallenge/decodable-implementations.json index b0d473225..9450086af 100644 --- a/docs/data/documentation/auth0/recoverycodeenrollmentchallenge/decodable-implementations.json +++ b/docs/data/documentation/auth0/recoverycodeenrollmentchallenge/decodable-implementations.json @@ -1 +1 @@ -{"kind":"article","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/recoverycodeenrollmentchallenge\/decodable-implementations"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RecoveryCodeEnrollmentChallenge"]]},"metadata":{"title":"Decodable Implementations","role":"collectionGroup","roleHeading":"API Collection","modules":[{"name":"Auth0"}]},"schemaVersion":{"minor":3,"patch":0,"major":0},"topicSections":[{"title":"Initializers","anchor":"Initializers","generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RecoveryCodeEnrollmentChallenge\/init(from:)"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RecoveryCodeEnrollmentChallenge\/Decodable-Implementations"},"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/RecoveryCodeEnrollmentChallenge":{"title":"RecoveryCodeEnrollmentChallenge","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RecoveryCodeEnrollmentChallenge","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"RecoveryCodeEnrollmentChallenge","kind":"identifier"}],"navigatorTitle":[{"text":"RecoveryCodeEnrollmentChallenge","kind":"identifier"}],"abstract":[{"type":"text","text":"A Recovery code enrollment challenge."}],"kind":"symbol","role":"symbol","url":"\/documentation\/auth0\/recoverycodeenrollmentchallenge"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/RecoveryCodeEnrollmentChallenge/init(from:)":{"title":"init(from:)","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RecoveryCodeEnrollmentChallenge\/init(from:)","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Decoder","preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"abstract":[{"code":"Decodable","type":"codeVoice"},{"text":" initializer.","type":"text"}],"kind":"symbol","role":"symbol","url":"\/documentation\/auth0\/recoverycodeenrollmentchallenge\/init(from:)"}}} \ No newline at end of file +{"variants":[{"paths":["\/documentation\/auth0\/recoverycodeenrollmentchallenge\/decodable-implementations"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RecoveryCodeEnrollmentChallenge"]]},"topicSections":[{"title":"Initializers","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RecoveryCodeEnrollmentChallenge\/init(from:)"],"anchor":"Initializers","generated":true}],"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"article","sections":[],"metadata":{"title":"Decodable Implementations","roleHeading":"API Collection","role":"collectionGroup","modules":[{"name":"Auth0"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RecoveryCodeEnrollmentChallenge\/Decodable-Implementations","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/RecoveryCodeEnrollmentChallenge":{"title":"RecoveryCodeEnrollmentChallenge","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RecoveryCodeEnrollmentChallenge","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"RecoveryCodeEnrollmentChallenge"}],"abstract":[{"type":"text","text":"A Recovery code enrollment challenge."}],"url":"\/documentation\/auth0\/recoverycodeenrollmentchallenge","navigatorTitle":[{"text":"RecoveryCodeEnrollmentChallenge","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/RecoveryCodeEnrollmentChallenge/init(from:)":{"type":"topic","abstract":[{"code":"Decodable","type":"codeVoice"},{"type":"text","text":" initializer."}],"kind":"symbol","title":"init(from:)","url":"\/documentation\/auth0\/recoverycodeenrollmentchallenge\/init(from:)","role":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:s7DecoderP","text":"Decoder","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RecoveryCodeEnrollmentChallenge\/init(from:)"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/recoverycodeenrollmentchallenge/init(from:).json b/docs/data/documentation/auth0/recoverycodeenrollmentchallenge/init(from:).json index 5d165178a..cc703023b 100644 --- a/docs/data/documentation/auth0/recoverycodeenrollmentchallenge/init(from:).json +++ b/docs/data/documentation/auth0/recoverycodeenrollmentchallenge/init(from:).json @@ -1 +1 @@ -{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/recoverycodeenrollmentchallenge\/init(from:)"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RecoveryCodeEnrollmentChallenge"]]},"metadata":{"modules":[{"name":"Auth0"}],"roleHeading":"Initializer","symbolKind":"init","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Decoder","kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"externalID":"s:5Auth031RecoveryCodeEnrollmentChallengeV4fromACs7Decoder_p_tKcfc","extendedModule":"Auth0","role":"symbol","title":"init(from:)"},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":" "},{"kind":"internalParam","text":"decoder"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Decoder","preciseIdentifier":"s:s7DecoderP"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"languages":["swift"]}],"kind":"declarations"}],"sections":[],"schemaVersion":{"minor":3,"patch":0,"major":0},"kind":"symbol","abstract":[{"type":"codeVoice","code":"Decodable"},{"text":" initializer.","type":"text"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RecoveryCodeEnrollmentChallenge\/init(from:)"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/RecoveryCodeEnrollmentChallenge/init(from:)":{"title":"init(from:)","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RecoveryCodeEnrollmentChallenge\/init(from:)","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Decoder","preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"abstract":[{"code":"Decodable","type":"codeVoice"},{"text":" initializer.","type":"text"}],"kind":"symbol","role":"symbol","url":"\/documentation\/auth0\/recoverycodeenrollmentchallenge\/init(from:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/RecoveryCodeEnrollmentChallenge":{"title":"RecoveryCodeEnrollmentChallenge","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RecoveryCodeEnrollmentChallenge","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"RecoveryCodeEnrollmentChallenge","kind":"identifier"}],"navigatorTitle":[{"text":"RecoveryCodeEnrollmentChallenge","kind":"identifier"}],"abstract":[{"type":"text","text":"A Recovery code enrollment challenge."}],"kind":"symbol","role":"symbol","url":"\/documentation\/auth0\/recoverycodeenrollmentchallenge"}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/recoverycodeenrollmentchallenge\/init(from:)"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RecoveryCodeEnrollmentChallenge"]]},"abstract":[{"type":"codeVoice","code":"Decodable"},{"type":"text","text":" initializer."}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":" "},{"kind":"internalParam","text":"decoder"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Decoder","preciseIdentifier":"s:s7DecoderP"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}]}],"kind":"declarations"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","sections":[],"metadata":{"externalID":"s:5Auth031RecoveryCodeEnrollmentChallengeV4fromACs7Decoder_p_tKcfc","extendedModule":"Auth0","symbolKind":"init","title":"init(from:)","roleHeading":"Initializer","role":"symbol","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP","text":"Decoder"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"modules":[{"name":"Auth0"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RecoveryCodeEnrollmentChallenge\/init(from:)","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/RecoveryCodeEnrollmentChallenge/init(from:)":{"type":"topic","abstract":[{"code":"Decodable","type":"codeVoice"},{"type":"text","text":" initializer."}],"kind":"symbol","title":"init(from:)","url":"\/documentation\/auth0\/recoverycodeenrollmentchallenge\/init(from:)","role":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:s7DecoderP","text":"Decoder","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RecoveryCodeEnrollmentChallenge\/init(from:)"},"doc://com.auth0.Auth0/documentation/Auth0/RecoveryCodeEnrollmentChallenge":{"title":"RecoveryCodeEnrollmentChallenge","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RecoveryCodeEnrollmentChallenge","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"RecoveryCodeEnrollmentChallenge"}],"abstract":[{"type":"text","text":"A Recovery code enrollment challenge."}],"url":"\/documentation\/auth0\/recoverycodeenrollmentchallenge","navigatorTitle":[{"text":"RecoveryCodeEnrollmentChallenge","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/recoverycodeenrollmentchallenge/recoverycode.json b/docs/data/documentation/auth0/recoverycodeenrollmentchallenge/recoverycode.json index 83d4c6958..c073173e4 100644 --- a/docs/data/documentation/auth0/recoverycodeenrollmentchallenge/recoverycode.json +++ b/docs/data/documentation/auth0/recoverycodeenrollmentchallenge/recoverycode.json @@ -1 +1 @@ -{"metadata":{"modules":[{"name":"Auth0"}],"title":"recoveryCode","roleHeading":"Instance Property","symbolKind":"property","externalID":"s:5Auth031RecoveryCodeEnrollmentChallengeV08recoveryC0SSvp","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"recoveryCode","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"role":"symbol"},"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/recoverycodeenrollmentchallenge\/recoverycode"]}],"abstract":[{"text":"The recovery code value.","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"recoveryCode","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"languages":["swift"],"platforms":["iOS"]}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RecoveryCodeEnrollmentChallenge"]]},"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RecoveryCodeEnrollmentChallenge\/recoveryCode","interfaceLanguage":"swift"},"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/RecoveryCodeEnrollmentChallenge/recoveryCode":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RecoveryCodeEnrollmentChallenge\/recoveryCode","url":"\/documentation\/auth0\/recoverycodeenrollmentchallenge\/recoverycode","kind":"symbol","title":"recoveryCode","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"recoveryCode"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"type":"topic","abstract":[{"type":"text","text":"The recovery code value."}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/RecoveryCodeEnrollmentChallenge":{"title":"RecoveryCodeEnrollmentChallenge","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RecoveryCodeEnrollmentChallenge","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"RecoveryCodeEnrollmentChallenge","kind":"identifier"}],"navigatorTitle":[{"text":"RecoveryCodeEnrollmentChallenge","kind":"identifier"}],"abstract":[{"type":"text","text":"A Recovery code enrollment challenge."}],"kind":"symbol","role":"symbol","url":"\/documentation\/auth0\/recoverycodeenrollmentchallenge"}}} \ No newline at end of file +{"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RecoveryCodeEnrollmentChallenge\/recoveryCode","interfaceLanguage":"swift"},"kind":"symbol","metadata":{"symbolKind":"property","title":"recoveryCode","externalID":"s:5Auth031RecoveryCodeEnrollmentChallengeV08recoveryC0SSvp","roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"recoveryCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"role":"symbol"},"variants":[{"paths":["\/documentation\/auth0\/recoverycodeenrollmentchallenge\/recoverycode"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RecoveryCodeEnrollmentChallenge"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"recoveryCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"platforms":["iOS"]}],"kind":"declarations"}],"abstract":[{"text":"The recovery code value.","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/RecoveryCodeEnrollmentChallenge/recoveryCode":{"title":"recoveryCode","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RecoveryCodeEnrollmentChallenge\/recoveryCode","type":"topic","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"recoveryCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"abstract":[{"type":"text","text":"The recovery code value."}],"url":"\/documentation\/auth0\/recoverycodeenrollmentchallenge\/recoverycode"},"doc://com.auth0.Auth0/documentation/Auth0/RecoveryCodeEnrollmentChallenge":{"title":"RecoveryCodeEnrollmentChallenge","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RecoveryCodeEnrollmentChallenge","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"RecoveryCodeEnrollmentChallenge"}],"abstract":[{"type":"text","text":"A Recovery code enrollment challenge."}],"url":"\/documentation\/auth0\/recoverycodeenrollmentchallenge","navigatorTitle":[{"text":"RecoveryCodeEnrollmentChallenge","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"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 41705abdb..5ce538825 100644 --- a/docs/data/documentation/auth0/refreshtokens.json +++ b/docs/data/documentation/auth0/refreshtokens.json @@ -1 +1 @@ -{"sections":[],"kind":"article","variants":[{"paths":["\/documentation\/auth0\/refreshtokens"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"title":"Refresh Tokens: Common Errors","roleHeading":"Article","role":"article","modules":[{"name":"Auth0"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"primaryContentSections":[{"content":[{"text":"Overview","type":"heading","level":2,"anchor":"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","type":"heading","level":2,"anchor":"Unknown-or-invalid-refresh-token"},{"type":"unorderedList","items":[{"content":[{"inlineContent":[{"type":"strong","inlineContent":[{"type":"text","text":"Example error description:"}]},{"type":"text","text":" "},{"type":"codeVoice","code":"The credentials renewal failed. CAUSE: Unknown or invalid refresh token"}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"type":"strong","inlineContent":[{"text":"Log event type:","type":"text"}]},{"type":"text","text":" "},{"type":"codeVoice","code":"fertft"}],"type":"paragraph"}]}]},{"type":"paragraph","inlineContent":[{"text":"This error means that Auth0 does not recognize the refresh token used to make the renewal request. Either an empty or garbage\/truncated\/padded token was sent, or the token is not valid anymore –it expired or was revoked.","type":"text"}]},{"anchor":"Common-causes","type":"heading","text":"Common causes","level":3},{"anchor":"Renewing-the-credentials-after-revoking-the-refresh-token","type":"heading","text":"Renewing the credentials after revoking the refresh token","level":4},{"type":"paragraph","inlineContent":[{"type":"text","text":"If you revoke the refresh token –either through the Credentials Manager or the Authentication API client– you should not attempt to renew the credentials afterward. For example, by calling the "},{"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"}]},{"anchor":"Misconfiguration-of-the-absolute-lifetime-of-refresh-tokens","type":"heading","text":"Misconfiguration of the absolute lifetime of refresh tokens","level":4},{"type":"paragraph","inlineContent":[{"text":"The ","type":"text"},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens\/configure-refresh-token-expiration","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, your app may issue renewal requests with expired refresh tokens. This could happen, for example, when using the ","type":"text"},{"code":"credentials()","type":"codeVoice"},{"text":" method of the Credentials Manager.","type":"text"}]},{"inlineContent":[{"type":"text","text":"Once a refresh token expires it can no longer be exchanged for new credentials."}],"type":"paragraph"},{"level":4,"anchor":"Misconfiguration-of-the-inactivity-lifetime-of-refresh-tokens","type":"heading","text":"Misconfiguration of the inactivity lifetime of refresh tokens"},{"inlineContent":[{"type":"text","text":"The "},{"overridingTitle":"inactivity lifetime","overridingTitleInlineContent":[{"type":"text","text":"inactivity lifetime"}],"type":"reference","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens\/configure-refresh-token-expiration","isActive":true},{"type":"text","text":" of the refresh token should not be shorter than the lifetime of the access token. If the access token is valid for longer than the refresh token is "},{"type":"emphasis","inlineContent":[{"text":"while the user is inactive","type":"text"}]},{"type":"text","text":", your app may issue renewal requests with expired refresh tokens. This could happen, for example, when using the "},{"type":"codeVoice","code":"credentials()"},{"type":"text","text":" method of the Credentials Manager while your app is backgrounded."}],"type":"paragraph"},{"inlineContent":[{"text":"Once a refresh token expires due to user inactivity it can no longer be exchanged for new credentials.","type":"text"}],"type":"paragraph"},{"level":2,"anchor":"Unsuccessful-Refresh-Token-exchange-reused-refresh-token-detected","type":"heading","text":"Unsuccessful Refresh Token exchange, reused refresh token detected"},{"type":"unorderedList","items":[{"content":[{"type":"paragraph","inlineContent":[{"type":"strong","inlineContent":[{"type":"text","text":"Example error description:"}]},{"text":" ","type":"text"},{"code":"The credentials renewal failed. CAUSE: Unsuccessful Refresh Token exchange, reused refresh token detected","type":"codeVoice"}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"strong","inlineContent":[{"text":"Log event type:","type":"text"}]},{"text":" ","type":"text"},{"code":"ferrt","type":"codeVoice"}]}]}]},{"inlineContent":[{"type":"text","text":"You might encounter this error if you have "},{"identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens\/refresh-token-rotation","type":"reference","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 "},{"identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens\/configure-refresh-token-rotation","type":"reference","isActive":true},{"type":"text","text":" has passed."}],"type":"paragraph"},{"inlineContent":[{"type":"text","text":"Rotating refresh tokens are effectively single-use. The renewed credentials will come with a new refresh token, and the old one will be invalidated once the renew interval passes."}],"type":"paragraph"},{"inlineContent":[{"inlineContent":[{"text":"In the absence of a bad actor, this error is typically a symptom of concurrency issues in your app.","type":"text"}],"type":"strong"}],"type":"paragraph"},{"level":3,"anchor":"Common-causes","type":"heading","text":"Common causes"},{"level":4,"anchor":"Multiple-Credentials-Manager-instances","type":"heading","text":"Multiple Credentials Manager instances"},{"inlineContent":[{"type":"text","text":"If you are using the Credentials Manager to renew the credentials -either through the "},{"type":"codeVoice","code":"credentials()"},{"type":"text","text":" or the "},{"type":"codeVoice","code":"renew()"},{"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":"paragraph"},{"type":"codeListing","syntax":"swift","code":["struct Services {"," \/\/ ❌ This will return a new instance every time"," var credentialsManager: CredentialsManager {"," return CredentialsManager(authentication: Auth0.authentication())"," }","}"]},{"level":4,"anchor":"Using-the-Authentication-API-client-to-renew-the-credentials-alongside-the-Credentials-Manager","type":"heading","text":"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()"},{"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()"},{"type":"text","text":" method of the Credentials Manager."}],"type":"paragraph"},{"inlineContent":[{"text":"To force a renewal, use the ","type":"text"},{"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"},{"level":4,"anchor":"Using-the-Authentication-API-client-to-renew-the-credentials-without-synchronization","type":"heading","text":"Using the Authentication API client to renew the credentials without synchronization"},{"inlineContent":[{"type":"text","text":"If you are "},{"type":"emphasis","inlineContent":[{"text":"not","type":"text"}]},{"type":"text","text":" using the Credentials Manager, you need to implement proper synchronization to call the "},{"type":"codeVoice","code":"renew()"},{"type":"text","text":" method of the Authentication API client. This method is not thread-safe; unless care is taken, concurrent renewal requests can happen."}],"type":"paragraph"}],"kind":"content"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"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","title":"reuse interval","type":"link","titleInlineContent":[{"type":"text","text":"reuse interval"}],"identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens\/configure-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","title":"absolute lifetime","titleInlineContent":[{"type":"text","text":"absolute lifetime"}],"identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens\/configure-refresh-token-expiration","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/renew(parameters:headers:callback:)":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/renew(parameters:headers:callback:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"renew","kind":"identifier"},{"text":"(","kind":"text"},{"text":"parameters","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","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"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"], ","kind":"text"},{"text":"callback","kind":"externalParam"},{"text":": (","kind":"text"},{"text":"CredentialsManagerResult","kind":"typeIdentifier","preciseIdentifier":"s:5Auth024CredentialsManagerResulta"},{"text":"<","kind":"text"},{"text":"Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"text":">) -> ","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":")","kind":"text"}],"title":"renew(parameters:headers:callback:)","url":"\/documentation\/auth0\/credentialsmanager\/renew(parameters:headers:callback:)","role":"symbol","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"}]},{"type":"text","text":"."}],"type":"topic"},"https://auth0.com/docs/secure/tokens/refresh-tokens/refresh-token-rotation":{"type":"link","titleInlineContent":[{"text":"Refresh Token Rotation","type":"text"}],"url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens\/refresh-token-rotation","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens\/refresh-token-rotation","title":"Refresh Token Rotation"}}} \ No newline at end of file +{"primaryContentSections":[{"content":[{"anchor":"Overview","type":"heading","level":2,"text":"Overview"},{"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."}],"type":"paragraph"},{"anchor":"Unknown-or-invalid-refresh-token","type":"heading","level":2,"text":"Unknown or invalid refresh token"},{"type":"unorderedList","items":[{"content":[{"inlineContent":[{"inlineContent":[{"text":"Example error description:","type":"text"}],"type":"strong"},{"text":" ","type":"text"},{"code":"The credentials renewal failed. CAUSE: Unknown or invalid refresh token","type":"codeVoice"}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"inlineContent":[{"text":"Log event type:","type":"text"}],"type":"strong"},{"text":" ","type":"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"},{"anchor":"Common-causes","type":"heading","level":3,"text":"Common causes"},{"anchor":"Renewing-the-credentials-after-revoking-the-refresh-token","type":"heading","level":4,"text":"Renewing the credentials after revoking the refresh token"},{"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":[{"type":"text","text":"Once a refresh token is revoked it can no longer be exchanged for new credentials."}],"type":"paragraph"},{"anchor":"Misconfiguration-of-the-absolute-lifetime-of-refresh-tokens","type":"heading","level":4,"text":"Misconfiguration of the absolute lifetime of refresh tokens"},{"inlineContent":[{"type":"text","text":"The "},{"type":"reference","isActive":true,"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()"},{"type":"text","text":" method of the Credentials Manager."}],"type":"paragraph"},{"inlineContent":[{"type":"text","text":"Once a refresh token expires it can no longer be exchanged for new credentials."}],"type":"paragraph"},{"anchor":"Misconfiguration-of-the-inactivity-lifetime-of-refresh-tokens","type":"heading","level":4,"text":"Misconfiguration of the inactivity lifetime of refresh tokens"},{"inlineContent":[{"type":"text","text":"The "},{"overridingTitle":"inactivity lifetime","overridingTitleInlineContent":[{"text":"inactivity lifetime","type":"text"}],"type":"reference","isActive":true,"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 "},{"type":"emphasis","inlineContent":[{"text":"while the user is inactive","type":"text"}]},{"type":"text","text":", your app may issue renewal requests with expired refresh tokens. This could happen, for example, when using the "},{"type":"codeVoice","code":"credentials()"},{"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"},{"anchor":"Unsuccessful-Refresh-Token-exchange-reused-refresh-token-detected","type":"heading","level":2,"text":"Unsuccessful Refresh Token exchange, reused refresh token detected"},{"type":"unorderedList","items":[{"content":[{"inlineContent":[{"inlineContent":[{"text":"Example error description:","type":"text"}],"type":"strong"},{"text":" ","type":"text"},{"code":"The credentials renewal failed. CAUSE: Unsuccessful Refresh Token exchange, reused refresh token detected","type":"codeVoice"}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"inlineContent":[{"text":"Log event type:","type":"text"}],"type":"strong"},{"text":" ","type":"text"},{"code":"ferrt","type":"codeVoice"}],"type":"paragraph"}]}]},{"inlineContent":[{"type":"text","text":"You might encounter this error if you have "},{"type":"reference","isActive":true,"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 "},{"type":"reference","isActive":true,"identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens\/configure-refresh-token-rotation"},{"type":"text","text":" has passed."}],"type":"paragraph"},{"inlineContent":[{"type":"text","text":"Rotating refresh tokens are effectively single-use. The renewed credentials will come with a new refresh token, and the old one will be invalidated once the renew interval passes."}],"type":"paragraph"},{"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"},{"anchor":"Common-causes","type":"heading","level":3,"text":"Common causes"},{"anchor":"Multiple-Credentials-Manager-instances","type":"heading","level":4,"text":"Multiple Credentials Manager instances"},{"inlineContent":[{"type":"text","text":"If you are using the Credentials Manager to renew the credentials -either through the "},{"type":"codeVoice","code":"credentials()"},{"type":"text","text":" or the "},{"type":"codeVoice","code":"renew()"},{"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":"paragraph"},{"type":"codeListing","code":["struct Services {"," \/\/ ❌ This will return a new instance every time"," var credentialsManager: CredentialsManager {"," return CredentialsManager(authentication: Auth0.authentication())"," }","}"],"syntax":"swift"},{"anchor":"Using-the-Authentication-API-client-to-renew-the-credentials-alongside-the-Credentials-Manager","type":"heading","level":4,"text":"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()"},{"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()"},{"type":"text","text":" method of the Credentials Manager."}],"type":"paragraph"},{"inlineContent":[{"type":"text","text":"To force a renewal, use the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/renew(parameters:headers:callback:)"},{"type":"text","text":" method of the Credentials Manager instead. This method is thread-safe; the Credentials Manager will make sure only one renewal request is in flight at any given time."}],"type":"paragraph"},{"anchor":"Using-the-Authentication-API-client-to-renew-the-credentials-without-synchronization","type":"heading","level":4,"text":"Using the Authentication API client to renew the credentials without synchronization"},{"inlineContent":[{"type":"text","text":"If you are "},{"type":"emphasis","inlineContent":[{"text":"not","type":"text"}]},{"type":"text","text":" using the Credentials Manager, you need to implement proper synchronization to call the "},{"type":"codeVoice","code":"renew()"},{"type":"text","text":" method of the Authentication API client. This method is not thread-safe; unless care is taken, concurrent renewal requests can happen."}],"type":"paragraph"}],"kind":"content"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/refreshtokens"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"metadata":{"modules":[{"name":"Auth0"}],"role":"article","title":"Refresh Tokens: Common Errors","roleHeading":"Article"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/RefreshTokens"},"kind":"article","references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"https://auth0.com/docs/secure/tokens/refresh-tokens/refresh-token-rotation":{"title":"Refresh Token Rotation","titleInlineContent":[{"text":"Refresh Token Rotation","type":"text"}],"url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens\/refresh-token-rotation","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens\/refresh-token-rotation","type":"link"},"https://auth0.com/docs/secure/tokens/refresh-tokens/configure-refresh-token-rotation":{"title":"reuse interval","titleInlineContent":[{"text":"reuse interval","type":"text"}],"url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens\/configure-refresh-token-rotation","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens\/configure-refresh-token-rotation","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsManager/renew(parameters:headers:callback:)":{"type":"topic","abstract":[{"text":"Renews credentials using the refresh token and stores them in the Keychain. ","type":"text"},{"inlineContent":[{"type":"text","text":"This method is thread-safe"}],"type":"strong"},{"text":".","type":"text"}],"title":"renew(parameters:headers:callback:)","kind":"symbol","url":"\/documentation\/auth0\/credentialsmanager\/renew(parameters:headers:callback:)","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"renew"},{"kind":"text","text":"("},{"kind":"externalParam","text":"parameters"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"callback"},{"kind":"text","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":">) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"kind":"text","text":")"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsManager\/renew(parameters:headers:callback:)"},"https://auth0.com/docs/secure/tokens/refresh-tokens/configure-refresh-token-expiration":{"title":"absolute lifetime","titleInlineContent":[{"text":"absolute lifetime","type":"text"}],"url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens\/configure-refresh-token-expiration","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens\/configure-refresh-token-expiration","type":"link"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/request.json b/docs/data/documentation/auth0/request.json index ec1f19183..c1a82377e 100644 --- a/docs/data/documentation/auth0/request.json +++ b/docs/data/documentation/auth0/request.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"metadata":{"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"title":"Request","roleHeading":"Structure","modules":[{"name":"Auth0"}],"externalID":"s:5Auth07RequestV","symbolKind":"struct","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Auth0 API request."}],"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(_:)"],"anchor":"Instance-Methods","generated":true,"title":"Instance Methods"},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/Callback"],"anchor":"Type-Aliases","generated":true,"title":"Type Aliases"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"},{"text":"<","kind":"text"},{"text":"T","kind":"genericParameter"},{"text":", ","kind":"text"},{"text":"E","kind":"genericParameter"},{"text":"> ","kind":"text"},{"text":"where","kind":"keyword"},{"text":" ","kind":"text"},{"text":"E","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Auth0APIError","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","preciseIdentifier":"s:5Auth00A8APIErrorP"}]}]},{"kind":"content","content":[{"text":"Usage","level":2,"anchor":"Usage","type":"heading"},{"syntax":"swift","code":["let request: Request = \/\/ ...","","request.start { result in"," print(result)","}"],"type":"codeListing"}]}],"variants":[{"paths":["\/documentation\/auth0\/request"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"schemaVersion":{"major":0,"patch":0,"minor":3},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Request/start()-8gjgk":{"role":"symbol","kind":"symbol","abstract":[{"type":"text","text":"Performs the request."}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"start","kind":"identifier"},{"text":"() ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"T","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV1Txmfp"}],"url":"\/documentation\/auth0\/request\/start()-8gjgk","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/start()-8gjgk","conformance":{"constraints":[{"type":"codeVoice","code":"E"},{"type":"text","text":" conforms to "},{"type":"codeVoice","code":"Auth0APIError"},{"type":"text","text":"."}],"availabilityPrefix":[{"type":"text","text":"Available when"}],"conformancePrefix":[{"type":"text","text":"Conforms when"}]},"title":"start()"},"doc://com.auth0.Auth0/documentation/Auth0/Request/start()-132e1":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"start"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:7Combine12AnyPublisherV","text":"AnyPublisher"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV1Txmfp","text":"T"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV1Eq_mfp","text":"E"},{"kind":"text","text":">"}],"abstract":[{"text":"Combine publisher for the request.","type":"text"}],"url":"\/documentation\/auth0\/request\/start()-132e1","title":"start()","type":"topic","role":"symbol","conformance":{"conformancePrefix":[{"text":"Conforms when","type":"text"}],"availabilityPrefix":[{"text":"Available when","type":"text"}],"constraints":[{"code":"E","type":"codeVoice"},{"text":" conforms to ","type":"text"},{"code":"Auth0APIError","type":"codeVoice"},{"text":".","type":"text"}]},"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/start()-132e1"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","type":"topic","url":"\/documentation\/auth0\/auth0apierror","title":"Auth0APIError","abstract":[{"type":"text","text":"Generic representation of Auth0 API errors."}],"role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Auth0APIError","kind":"identifier"}],"kind":"symbol","navigatorTitle":[{"text":"Auth0APIError","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request/start(_:)":{"role":"symbol","url":"\/documentation\/auth0\/request\/start(_:)","title":"start(_:)","type":"topic","abstract":[{"type":"text","text":"Performs the request."}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"start"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV8Callbacka","text":"Callback"},{"kind":"text","text":")"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/start(_:)","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Request/headers(_:)":{"kind":"symbol","abstract":[{"type":"text","text":"Modifies the headers by creating a copy of the request and adding the provided headers to the existing ones."}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/headers(_:)","url":"\/documentation\/auth0\/request\/headers(_:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"headers","kind":"identifier"},{"text":"([","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"]) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"T","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"E","kind":"typeIdentifier"},{"text":">","kind":"text"}],"title":"headers(_:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/request","kind":"symbol","abstract":[{"type":"text","text":"Auth0 API request."}]},"doc://com.auth0.Auth0/documentation/Auth0/Request/parameters(_:)":{"role":"symbol","kind":"symbol","type":"topic","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"parameters","kind":"identifier"},{"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"},{"text":"<","kind":"text"},{"text":"T","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"E","kind":"typeIdentifier"},{"text":">","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/parameters(_:)","url":"\/documentation\/auth0\/request\/parameters(_:)","abstract":[{"type":"text","text":"Modifies the parameters by creating a copy of the request and adding the provided parameters to the existing ones."}],"title":"parameters(_:)"},"doc://com.auth0.Auth0/documentation/Auth0/Request/Callback":{"abstract":[{"type":"text","text":"The callback closure type for the request."}],"fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"Callback"}],"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/request\/callback","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Callback"}],"title":"Request.Callback","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/Callback"}}} \ No newline at end of file +{"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(_:)"],"generated":true,"title":"Instance Methods","anchor":"Instance-Methods"},{"generated":true,"title":"Type Aliases","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/Callback"],"anchor":"Type-Aliases"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"relationshipsSections":[{"title":"Conforms To","kind":"relationships","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Requestable"],"type":"conformsTo"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"},{"text":"<","kind":"text"},{"text":"T","kind":"genericParameter"},{"text":", ","kind":"text"},{"text":"E","kind":"genericParameter"},{"text":"> ","kind":"text"},{"text":"where","kind":"keyword"},{"text":" ","kind":"text"},{"text":"E","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","text":"Auth0APIError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","preciseIdentifier":"s:5Auth00A8APIErrorP"}],"platforms":["iOS"],"languages":["swift"]}]},{"content":[{"text":"Usage","level":2,"anchor":"Usage","type":"heading"},{"type":"codeListing","code":["let request: Request = \/\/ ...","","request.start { result in"," print(result)","}"],"syntax":"swift"}],"kind":"content"}],"sections":[],"abstract":[{"type":"text","text":"Auth0 API request."}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/request"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","interfaceLanguage":"swift"},"metadata":{"roleHeading":"Structure","navigatorTitle":[{"text":"Request","kind":"identifier"}],"symbolKind":"struct","role":"symbol","title":"Request","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Request"}],"externalID":"s:5Auth07RequestV","modules":[{"name":"Auth0"}]},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Request/start(_:)":{"kind":"symbol","title":"start(_:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"start","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV8Callbacka","text":"Callback","kind":"typeIdentifier"},{"text":")","kind":"text"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/start(_:)","abstract":[{"type":"text","text":"Performs the request."}],"url":"\/documentation\/auth0\/request\/start(_:)"},"doc://com.auth0.Auth0/documentation/Auth0/Request/headers(_:)":{"type":"topic","title":"headers(_:)","url":"\/documentation\/auth0\/request\/headers(_:)","kind":"symbol","abstract":[{"text":"Modifies the headers by creating a copy of the request and adding the provided headers to the existing ones.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/headers(_:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"headers","kind":"identifier"},{"text":"([","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"]) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"T","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"E","kind":"typeIdentifier"},{"text":">","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"title":"Request","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"abstract":[{"text":"Auth0 API request.","type":"text"}],"url":"\/documentation\/auth0\/request","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request/start()-8gjgk":{"kind":"symbol","conformance":{"availabilityPrefix":[{"type":"text","text":"Available when"}],"conformancePrefix":[{"type":"text","text":"Conforms when"}],"constraints":[{"type":"codeVoice","code":"E"},{"text":" conforms to ","type":"text"},{"type":"codeVoice","code":"Auth0APIError"},{"text":".","type":"text"}]},"title":"start()","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"start","kind":"identifier"},{"text":"() ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV1Txmfp","text":"T"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/start()-8gjgk","abstract":[{"type":"text","text":"Performs the request."}],"url":"\/documentation\/auth0\/request\/start()-8gjgk"},"doc://com.auth0.Auth0/documentation/Auth0/Request/parameters(_:)":{"type":"topic","title":"parameters(_:)","url":"\/documentation\/auth0\/request\/parameters(_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/parameters(_:)","kind":"symbol","abstract":[{"type":"text","text":"Modifies the parameters by creating a copy of the request and adding the provided parameters to the existing ones."}],"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"parameters"},{"kind":"text","text":"(["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","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"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"E"},{"kind":"text","text":">"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Request/Callback":{"role":"symbol","title":"Request.Callback","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Callback","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"Callback"}],"abstract":[{"type":"text","text":"The callback closure type for the request."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/Callback","url":"\/documentation\/auth0\/request\/callback","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError":{"url":"\/documentation\/auth0\/auth0apierror","abstract":[{"type":"text","text":"Generic representation of Auth0 API errors."}],"title":"Auth0APIError","navigatorTitle":[{"kind":"identifier","text":"Auth0APIError"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Auth0APIError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Request/start()-132e1":{"type":"topic","abstract":[{"type":"text","text":"Combine publisher for the request."}],"title":"start()","kind":"symbol","url":"\/documentation\/auth0\/request\/start()-132e1","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"start"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","text":"AnyPublisher","preciseIdentifier":"s:7Combine12AnyPublisherV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"T","preciseIdentifier":"s:5Auth07RequestV1Txmfp"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"E","preciseIdentifier":"s:5Auth07RequestV1Eq_mfp"},{"kind":"text","text":">"}],"conformance":{"constraints":[{"code":"E","type":"codeVoice"},{"type":"text","text":" conforms to "},{"code":"Auth0APIError","type":"codeVoice"},{"type":"text","text":"."}],"availabilityPrefix":[{"type":"text","text":"Available when"}],"conformancePrefix":[{"type":"text","text":"Conforms when"}]},"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/start()-132e1"},"doc://com.auth0.Auth0/documentation/Auth0/Requestable":{"kind":"symbol","abstract":[],"type":"topic","url":"\/documentation\/auth0\/requestable","title":"Requestable","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Requestable","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Requestable","navigatorTitle":[{"text":"Requestable","kind":"identifier"}]}}} \ 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 a85fd28c3..421347965 100644 --- a/docs/data/documentation/auth0/request/callback.json +++ b/docs/data/documentation/auth0/request/callback.json @@ -1 +1 @@ -{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/Callback"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/request\/callback"]}],"schemaVersion":{"patch":0,"minor":3,"major":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"]]},"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"Callback"},{"kind":"text","text":" = ("},{"kind":"typeIdentifier","preciseIdentifier":"s:s6ResultO","text":"Result"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV1Txmfp","text":"T"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV1Eq_mfp","text":"E"},{"kind":"text","text":">) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"}],"platforms":["iOS"],"languages":["swift"]}]}],"abstract":[{"type":"text","text":"The callback closure type for the request."}],"metadata":{"roleHeading":"Type Alias","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Callback"}],"modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"Callback"}],"externalID":"s:5Auth07RequestV8Callbacka","symbolKind":"typealias","title":"Request.Callback"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Request/Callback":{"abstract":[{"type":"text","text":"The callback closure type for the request."}],"fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"Callback"}],"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/request\/callback","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Callback"}],"title":"Request.Callback","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/Callback"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/request","kind":"symbol","abstract":[{"type":"text","text":"Auth0 API request."}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"metadata":{"symbolKind":"typealias","title":"Request.Callback","externalID":"s:5Auth07RequestV8Callbacka","roleHeading":"Type Alias","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"Callback"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Callback"}]},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/request\/callback"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/Callback","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"type":"text","text":"The callback closure type for the request."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"]]},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"Callback"},{"kind":"text","text":" = ("},{"kind":"typeIdentifier","text":"Result","preciseIdentifier":"s:s6ResultO"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"T","preciseIdentifier":"s:5Auth07RequestV1Txmfp"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"E","preciseIdentifier":"s:5Auth07RequestV1Eq_mfp"},{"kind":"text","text":">) -> "},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"}]}],"kind":"declarations"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Request":{"title":"Request","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"abstract":[{"text":"Auth0 API request.","type":"text"}],"url":"\/documentation\/auth0\/request","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Request/Callback":{"role":"symbol","title":"Request.Callback","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Callback","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"Callback"}],"abstract":[{"type":"text","text":"The callback closure type for the request."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/Callback","url":"\/documentation\/auth0\/request\/callback","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 102d31232..70187abbd 100644 --- a/docs/data/documentation/auth0/request/headers(_:).json +++ b/docs/data/documentation/auth0/request/headers(_:).json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"]]},"kind":"symbol","primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"headers"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"extraHeaders"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"]) -> "},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"T"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"E"},{"kind":"text","text":">"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"},{"parameters":[{"name":"extraHeaders","content":[{"inlineContent":[{"text":"Additional headers for the request.","type":"text"}],"type":"paragraph"}]}],"kind":"parameters"}],"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"}]}],"schemaVersion":{"patch":0,"minor":3,"major":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/headers(_:)"},"sections":[],"metadata":{"externalID":"s:5Auth07RequestV7headersyACyxq_GSDyS2SGF","modules":[{"name":"Auth0"}],"roleHeading":"Instance Method","title":"headers(_:)","role":"symbol","symbolKind":"method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"headers"},{"kind":"text","text":"(["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"]) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"T"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"E"},{"kind":"text","text":">"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Request/headers(_:)":{"kind":"symbol","abstract":[{"type":"text","text":"Modifies the headers by creating a copy of the request and adding the provided headers to the existing ones."}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/headers(_:)","url":"\/documentation\/auth0\/request\/headers(_:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"headers","kind":"identifier"},{"text":"([","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"]) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"T","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"E","kind":"typeIdentifier"},{"text":">","kind":"text"}],"title":"headers(_:)"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/request","kind":"symbol","abstract":[{"type":"text","text":"Auth0 API request."}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"headers","kind":"identifier"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"extraHeaders","kind":"internalParam"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"]) -> ","kind":"text"},{"text":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"T","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"E","kind":"typeIdentifier"},{"text":">","kind":"text"}]}]},{"parameters":[{"name":"extraHeaders","content":[{"inlineContent":[{"type":"text","text":"Additional headers for the request."}],"type":"paragraph"}]}],"kind":"parameters"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/request\/headers(_:)"]}],"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/headers(_:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Modifies the headers by creating a copy of the request and adding the provided headers to the existing ones."}],"metadata":{"roleHeading":"Instance Method","symbolKind":"method","title":"headers(_:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"headers","kind":"identifier"},{"text":"([","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"]) -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"T","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"E","kind":"typeIdentifier"},{"text":">","kind":"text"}],"externalID":"s:5Auth07RequestV7headersyACyxq_GSDyS2SGF","modules":[{"name":"Auth0"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Request/headers(_:)":{"type":"topic","title":"headers(_:)","url":"\/documentation\/auth0\/request\/headers(_:)","kind":"symbol","abstract":[{"text":"Modifies the headers by creating a copy of the request and adding the provided headers to the existing ones.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/headers(_:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"headers","kind":"identifier"},{"text":"([","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"]) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"T","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"E","kind":"typeIdentifier"},{"text":">","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"title":"Request","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"abstract":[{"text":"Auth0 API request.","type":"text"}],"url":"\/documentation\/auth0\/request","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ 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 8bddb2f3a..ac98c17cc 100644 --- a/docs/data/documentation/auth0/request/parameters(_:).json +++ b/docs/data/documentation/auth0/request/parameters(_:).json @@ -1 +1 @@ -{"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"parameters"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"extraParameters"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]) -> "},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"T"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"E"},{"kind":"text","text":">"}]}]},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Additional parameters for the request."}]}],"name":"extraParameters"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/parameters(_:)","interfaceLanguage":"swift"},"metadata":{"externalID":"s:5Auth07RequestV10parametersyACyxq_GSDySSypGF","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"parameters","kind":"identifier"},{"kind":"text","text":"(["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","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"},{"text":">","kind":"text"}],"symbolKind":"method","modules":[{"name":"Auth0"}],"title":"parameters(_:)","roleHeading":"Instance Method","role":"symbol"},"abstract":[{"text":"Modifies the parameters by creating a copy of the request and adding the provided parameters to the existing ones.","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"]]},"variants":[{"paths":["\/documentation\/auth0\/request\/parameters(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","schemaVersion":{"minor":3,"major":0,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Request":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/request","kind":"symbol","abstract":[{"type":"text","text":"Auth0 API request."}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Request/parameters(_:)":{"role":"symbol","kind":"symbol","type":"topic","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"parameters","kind":"identifier"},{"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"},{"text":"<","kind":"text"},{"text":"T","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"E","kind":"typeIdentifier"},{"text":">","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/parameters(_:)","url":"\/documentation\/auth0\/request\/parameters(_:)","abstract":[{"type":"text","text":"Modifies the parameters by creating a copy of the request and adding the provided parameters to the existing ones."}],"title":"parameters(_:)"}}} \ No newline at end of file +{"kind":"symbol","primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"parameters"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"extraParameters"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]) -> "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"T"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"E"},{"kind":"text","text":">"}]}],"kind":"declarations"},{"parameters":[{"content":[{"inlineContent":[{"text":"Additional parameters for the request.","type":"text"}],"type":"paragraph"}],"name":"extraParameters"}],"kind":"parameters"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/request\/parameters(_:)"]}],"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/parameters(_:)","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"]]},"abstract":[{"type":"text","text":"Modifies the parameters by creating a copy of the request and adding the provided parameters to the existing ones."}],"metadata":{"roleHeading":"Instance Method","symbolKind":"method","title":"parameters(_:)","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"parameters"},{"kind":"text","text":"(["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]) -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"T"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"E"},{"kind":"text","text":">"}],"externalID":"s:5Auth07RequestV10parametersyACyxq_GSDySSypGF","modules":[{"name":"Auth0"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Request":{"title":"Request","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"abstract":[{"text":"Auth0 API request.","type":"text"}],"url":"\/documentation\/auth0\/request","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Request/parameters(_:)":{"type":"topic","title":"parameters(_:)","url":"\/documentation\/auth0\/request\/parameters(_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/parameters(_:)","kind":"symbol","abstract":[{"type":"text","text":"Modifies the parameters by creating a copy of the request and adding the provided parameters to the existing ones."}],"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"parameters"},{"kind":"text","text":"(["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","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"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"E"},{"kind":"text","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 d7de877df..47f69032c 100644 --- a/docs/data/documentation/auth0/request/start()-132e1.json +++ b/docs/data/documentation/auth0/request/start()-132e1.json @@ -1 +1 @@ -{"abstract":[{"text":"Combine publisher for the request.","type":"text"}],"variants":[{"paths":["\/documentation\/auth0\/request\/start()-132e1"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/start()-132e1","interfaceLanguage":"swift"},"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"metadata":{"extendedModule":"Auth0","conformance":{"constraints":[{"type":"codeVoice","code":"E"},{"type":"text","text":" conforms to "},{"type":"codeVoice","code":"Auth0APIError"},{"type":"text","text":"."}],"availabilityPrefix":[{"type":"text","text":"Available when"}],"conformancePrefix":[{"type":"text","text":"Conforms when"}]},"title":"start()","externalID":"s:5Auth07RequestV5start7Combine12AnyPublisherVyxq_GyF","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"start"},{"kind":"text","text":"() -> "},{"preciseIdentifier":"s:7Combine12AnyPublisherV","kind":"typeIdentifier","text":"AnyPublisher"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:5Auth07RequestV1Txmfp","kind":"typeIdentifier","text":"T"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth07RequestV1Eq_mfp","kind":"typeIdentifier","text":"E"},{"kind":"text","text":">"}],"modules":[{"name":"Auth0"}],"roleHeading":"Instance Method","symbolKind":"method","role":"symbol"},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"start","kind":"identifier"},{"text":"() -> ","kind":"text"},{"text":"AnyPublisher","preciseIdentifier":"s:7Combine12AnyPublisherV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"T","preciseIdentifier":"s:5Auth07RequestV1Txmfp","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"E","preciseIdentifier":"s:5Auth07RequestV1Eq_mfp","kind":"typeIdentifier"},{"text":">","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]},{"kind":"content","content":[{"type":"heading","level":2,"text":"Return Value","anchor":"return-value"},{"type":"paragraph","inlineContent":[{"text":"A type-erased publisher.","type":"text"}]}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Request/start()-132e1":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"start"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:7Combine12AnyPublisherV","text":"AnyPublisher"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV1Txmfp","text":"T"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV1Eq_mfp","text":"E"},{"kind":"text","text":">"}],"abstract":[{"text":"Combine publisher for the request.","type":"text"}],"url":"\/documentation\/auth0\/request\/start()-132e1","title":"start()","type":"topic","role":"symbol","conformance":{"conformancePrefix":[{"text":"Conforms when","type":"text"}],"availabilityPrefix":[{"text":"Available when","type":"text"}],"constraints":[{"code":"E","type":"codeVoice"},{"text":" conforms to ","type":"text"},{"code":"Auth0APIError","type":"codeVoice"},{"text":".","type":"text"}]},"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/start()-132e1"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/request","kind":"symbol","abstract":[{"type":"text","text":"Auth0 API request."}]}}} \ No newline at end of file +{"variants":[{"paths":["\/documentation\/auth0\/request\/start()-132e1"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"]]},"abstract":[{"type":"text","text":"Combine publisher for the request."}],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"start"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:7Combine12AnyPublisherV","text":"AnyPublisher"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV1Txmfp","text":"T"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV1Eq_mfp","text":"E"},{"kind":"text","text":">"}],"platforms":["iOS"],"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"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","sections":[],"metadata":{"externalID":"s:5Auth07RequestV5start7Combine12AnyPublisherVyxq_GyF","extendedModule":"Auth0","symbolKind":"method","title":"start()","role":"symbol","roleHeading":"Instance Method","conformance":{"conformancePrefix":[{"type":"text","text":"Conforms when"}],"availabilityPrefix":[{"type":"text","text":"Available when"}],"constraints":[{"type":"codeVoice","code":"E"},{"type":"text","text":" conforms to "},{"type":"codeVoice","code":"Auth0APIError"},{"type":"text","text":"."}]},"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"start"},{"kind":"text","text":"() -> "},{"preciseIdentifier":"s:7Combine12AnyPublisherV","kind":"typeIdentifier","text":"AnyPublisher"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:5Auth07RequestV1Txmfp","kind":"typeIdentifier","text":"T"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth07RequestV1Eq_mfp","kind":"typeIdentifier","text":"E"},{"kind":"text","text":">"}],"modules":[{"name":"Auth0"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/start()-132e1","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Request/start()-132e1":{"type":"topic","abstract":[{"type":"text","text":"Combine publisher for the request."}],"title":"start()","kind":"symbol","url":"\/documentation\/auth0\/request\/start()-132e1","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"start"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","text":"AnyPublisher","preciseIdentifier":"s:7Combine12AnyPublisherV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"T","preciseIdentifier":"s:5Auth07RequestV1Txmfp"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"E","preciseIdentifier":"s:5Auth07RequestV1Eq_mfp"},{"kind":"text","text":">"}],"conformance":{"constraints":[{"code":"E","type":"codeVoice"},{"type":"text","text":" conforms to "},{"code":"Auth0APIError","type":"codeVoice"},{"type":"text","text":"."}],"availabilityPrefix":[{"type":"text","text":"Available when"}],"conformancePrefix":[{"type":"text","text":"Conforms when"}]},"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/start()-132e1"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"title":"Request","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"abstract":[{"text":"Auth0 API request.","type":"text"}],"url":"\/documentation\/auth0\/request","navigatorTitle":[{"kind":"identifier","text":"Request"}]}}} \ 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 956a66058..44c20fbe4 100644 --- a/docs/data/documentation/auth0/request/start()-8gjgk.json +++ b/docs/data/documentation/auth0/request/start()-8gjgk.json @@ -1 +1 @@ -{"schemaVersion":{"patch":0,"major":0,"minor":3},"sections":[],"metadata":{"title":"start()","symbolKind":"method","roleHeading":"Instance Method","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"start"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV1Txmfp","text":"T"}],"conformance":{"conformancePrefix":[{"type":"text","text":"Conforms when"}],"availabilityPrefix":[{"type":"text","text":"Available when"}],"constraints":[{"type":"codeVoice","code":"E"},{"type":"text","text":" conforms to "},{"type":"codeVoice","code":"Auth0APIError"},{"type":"text","text":"."}]},"modules":[{"name":"Auth0"}],"extendedModule":"Auth0","externalID":"s:5Auth07RequestV5startxyYaKF"},"variants":[{"paths":["\/documentation\/auth0\/request\/start()-8gjgk"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/start()-8gjgk"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"]]},"abstract":[{"type":"text","text":"Performs the request."}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"start","kind":"identifier"},{"text":"() ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"T","preciseIdentifier":"s:5Auth07RequestV1Txmfp","kind":"typeIdentifier"}]}],"kind":"declarations"},{"kind":"content","content":[{"text":"Discussion","anchor":"discussion","type":"heading","level":2},{"name":"Throws","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"An error that conforms to "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError"},{"type":"text","text":"; either an "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError"},{"type":"text","text":" or a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"},{"type":"text","text":"."}]}],"type":"aside","style":"note"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/request","kind":"symbol","abstract":[{"type":"text","text":"Auth0 API request."}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"type":"topic","url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","kind":"symbol","title":"ManagementError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"kind":"symbol","url":"\/documentation\/auth0\/authenticationerror","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","role":"symbol","title":"AuthenticationError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request/start()-8gjgk":{"role":"symbol","kind":"symbol","abstract":[{"type":"text","text":"Performs the request."}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"start","kind":"identifier"},{"text":"() ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"T","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV1Txmfp"}],"url":"\/documentation\/auth0\/request\/start()-8gjgk","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/start()-8gjgk","conformance":{"constraints":[{"type":"codeVoice","code":"E"},{"type":"text","text":" conforms to "},{"type":"codeVoice","code":"Auth0APIError"},{"type":"text","text":"."}],"availabilityPrefix":[{"type":"text","text":"Available when"}],"conformancePrefix":[{"type":"text","text":"Conforms when"}]},"title":"start()"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","type":"topic","url":"\/documentation\/auth0\/auth0apierror","title":"Auth0APIError","abstract":[{"type":"text","text":"Generic representation of Auth0 API errors."}],"role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Auth0APIError","kind":"identifier"}],"kind":"symbol","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\/Request"]]},"metadata":{"roleHeading":"Instance Method","symbolKind":"method","modules":[{"name":"Auth0"}],"title":"start()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"start"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"T","preciseIdentifier":"s:5Auth07RequestV1Txmfp"}],"externalID":"s:5Auth07RequestV5startxyYaKF","role":"symbol","conformance":{"conformancePrefix":[{"type":"text","text":"Conforms when"}],"availabilityPrefix":[{"type":"text","text":"Available when"}],"constraints":[{"code":"E","type":"codeVoice"},{"text":" conforms to ","type":"text"},{"code":"Auth0APIError","type":"codeVoice"},{"type":"text","text":"."}]},"extendedModule":"Auth0"},"sections":[],"abstract":[{"type":"text","text":"Performs the request."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/request\/start()-8gjgk"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/start()-8gjgk","interfaceLanguage":"swift"},"kind":"symbol","schemaVersion":{"minor":3,"patch":0,"major":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"start"},{"text":"() ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"T","preciseIdentifier":"s:5Auth07RequestV1Txmfp"}]}]},{"kind":"content","content":[{"type":"heading","level":2,"text":"Discussion","anchor":"discussion"},{"name":"Throws","style":"note","type":"aside","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"An error that conforms to "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","type":"reference","isActive":true},{"type":"text","text":"; either an "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","type":"reference","isActive":true},{"type":"text","text":" or a "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","type":"reference","isActive":true},{"type":"text","text":"."}]}]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError":{"url":"\/documentation\/auth0\/auth0apierror","abstract":[{"type":"text","text":"Generic representation of Auth0 API errors."}],"title":"Auth0APIError","navigatorTitle":[{"kind":"identifier","text":"Auth0APIError"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Auth0APIError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"title":"ManagementError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}]},"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationError":{"role":"symbol","title":"AuthenticationError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthenticationError"}],"navigatorTitle":[{"kind":"identifier","text":"AuthenticationError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Authentication API."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationError","url":"\/documentation\/auth0\/authenticationerror","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"title":"Request","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"abstract":[{"text":"Auth0 API request.","type":"text"}],"url":"\/documentation\/auth0\/request","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request/start()-8gjgk":{"kind":"symbol","conformance":{"availabilityPrefix":[{"type":"text","text":"Available when"}],"conformancePrefix":[{"type":"text","text":"Conforms when"}],"constraints":[{"type":"codeVoice","code":"E"},{"text":" conforms to ","type":"text"},{"type":"codeVoice","code":"Auth0APIError"},{"text":".","type":"text"}]},"title":"start()","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"start","kind":"identifier"},{"text":"() ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV1Txmfp","text":"T"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/start()-8gjgk","abstract":[{"type":"text","text":"Performs the request."}],"url":"\/documentation\/auth0\/request\/start()-8gjgk"}}} \ 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 58e2b25c7..a7205c187 100644 --- a/docs/data/documentation/auth0/request/start(_:).json +++ b/docs/data/documentation/auth0/request/start(_:).json @@ -1 +1 @@ -{"schemaVersion":{"patch":0,"major":0,"minor":3},"metadata":{"roleHeading":"Instance Method","title":"start(_:)","symbolKind":"method","externalID":"s:5Auth07RequestV5startyyys6ResultOyxq_GcF","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"start","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV8Callbacka","text":"Callback","kind":"typeIdentifier"},{"text":")","kind":"text"}],"role":"symbol","modules":[{"name":"Auth0"}]},"abstract":[{"type":"text","text":"Performs the request."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"start","kind":"identifier"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"callback","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"@escaping","kind":"attribute"},{"text":" ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/Callback","preciseIdentifier":"s:5Auth07RequestV8Callbacka","text":"Callback","kind":"typeIdentifier"},{"text":")","kind":"text"}],"platforms":["iOS"]}]},{"kind":"parameters","parameters":[{"name":"callback","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Callback that receives the result of the request when it completes."}]}]}]}],"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/start(_:)","interfaceLanguage":"swift"},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/request\/start(_:)"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Request":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/request","kind":"symbol","abstract":[{"type":"text","text":"Auth0 API request."}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Request/Callback":{"abstract":[{"type":"text","text":"The callback closure type for the request."}],"fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"Callback"}],"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/request\/callback","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Callback"}],"title":"Request.Callback","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/Callback"},"doc://com.auth0.Auth0/documentation/Auth0/Request/start(_:)":{"role":"symbol","url":"\/documentation\/auth0\/request\/start(_:)","title":"start(_:)","type":"topic","abstract":[{"type":"text","text":"Performs the request."}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"start"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV8Callbacka","text":"Callback"},{"kind":"text","text":")"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/start(_:)","kind":"symbol"}}} \ No newline at end of file +{"metadata":{"symbolKind":"method","modules":[{"name":"Auth0"}],"title":"start(_:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"start","kind":"identifier"},{"text":"(","kind":"text"},{"text":"Callback","preciseIdentifier":"s:5Auth07RequestV8Callbacka","kind":"typeIdentifier"},{"text":")","kind":"text"}],"externalID":"s:5Auth07RequestV5startyyys6ResultOyxq_GcF","role":"symbol","roleHeading":"Instance Method"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/request\/start(_:)"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/start(_:)","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"text":"Performs the request.","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"]]},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"start","kind":"identifier"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"callback","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"@escaping","kind":"attribute"},{"text":" ","kind":"text"},{"text":"Callback","preciseIdentifier":"s:5Auth07RequestV8Callbacka","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/Callback"},{"text":")","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"},{"parameters":[{"name":"callback","content":[{"inlineContent":[{"text":"Callback that receives the result of the request when it completes.","type":"text"}],"type":"paragraph"}]}],"kind":"parameters"}],"schemaVersion":{"minor":3,"patch":0,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"title":"Request","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"abstract":[{"text":"Auth0 API request.","type":"text"}],"url":"\/documentation\/auth0\/request","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request/Callback":{"role":"symbol","title":"Request.Callback","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Callback","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"Callback"}],"abstract":[{"type":"text","text":"The callback closure type for the request."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/Callback","url":"\/documentation\/auth0\/request\/callback","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Request/start(_:)":{"kind":"symbol","title":"start(_:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"start","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV8Callbacka","text":"Callback","kind":"typeIdentifier"},{"text":")","kind":"text"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request\/start(_:)","abstract":[{"type":"text","text":"Performs the request."}],"url":"\/documentation\/auth0\/request\/start(_:)"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/requestable.json b/docs/data/documentation/auth0/requestable.json new file mode 100644 index 000000000..0ad365d8d --- /dev/null +++ b/docs/data/documentation/auth0/requestable.json @@ -0,0 +1 @@ +{"topicSections":[{"generated":true,"title":"Associated Types","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Requestable\/ErrorType","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Requestable\/ResultType"],"anchor":"Associated-Types"},{"generated":true,"title":"Instance Methods","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Requestable\/start(_:)"],"anchor":"Instance-Methods"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"metadata":{"externalID":"s:5Auth011RequestableP","modules":[{"name":"Auth0"}],"title":"Requestable","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Requestable","kind":"identifier"}],"roleHeading":"Protocol","role":"symbol","navigatorTitle":[{"text":"Requestable","kind":"identifier"}],"symbolKind":"protocol"},"sections":[],"relationshipsSections":[{"title":"Conforming Types","kind":"relationships","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"],"type":"conformingTypes"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/requestable"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Requestable","interfaceLanguage":"swift"},"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Requestable","kind":"identifier"}]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Requestable/ErrorType":{"type":"topic","abstract":[],"title":"ErrorType","kind":"symbol","url":"\/documentation\/auth0\/requestable\/errortype","required":true,"role":"symbol","fragments":[{"kind":"keyword","text":"associatedtype"},{"kind":"text","text":" "},{"kind":"identifier","text":"ErrorType"},{"kind":"text","text":" : "},{"preciseIdentifier":"s:5Auth00A8APIErrorP","kind":"typeIdentifier","text":"Auth0APIError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Requestable\/ErrorType"},"doc://com.auth0.Auth0/documentation/Auth0/Requestable":{"kind":"symbol","abstract":[],"type":"topic","url":"\/documentation\/auth0\/requestable","title":"Requestable","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Requestable","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Requestable","navigatorTitle":[{"text":"Requestable","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Requestable/start(_:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Requestable\/start(_:)","kind":"symbol","title":"start(_:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"start","kind":"identifier"},{"text":"((","kind":"text"},{"text":"Result","preciseIdentifier":"s:s6ResultO","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"ResultType","preciseIdentifier":"s:5Auth011RequestableP10ResultTypeQa","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"ErrorType","preciseIdentifier":"s:5Auth011RequestableP9ErrorTypeQa","kind":"typeIdentifier"},{"text":">) -> ","kind":"text"},{"text":"Void","preciseIdentifier":"s:s4Voida","kind":"typeIdentifier"},{"text":")","kind":"text"}],"role":"symbol","required":true,"url":"\/documentation\/auth0\/requestable\/start(_:)","abstract":[],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Requestable/ResultType":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Requestable\/ResultType","kind":"symbol","title":"ResultType","fragments":[{"kind":"keyword","text":"associatedtype"},{"kind":"text","text":" "},{"kind":"identifier","text":"ResultType"}],"role":"symbol","required":true,"url":"\/documentation\/auth0\/requestable\/resulttype","abstract":[],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"title":"Request","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"abstract":[{"text":"Auth0 API request.","type":"text"}],"url":"\/documentation\/auth0\/request","navigatorTitle":[{"kind":"identifier","text":"Request"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/requestable/errortype.json b/docs/data/documentation/auth0/requestable/errortype.json new file mode 100644 index 000000000..a047cda0a --- /dev/null +++ b/docs/data/documentation/auth0/requestable/errortype.json @@ -0,0 +1 @@ +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/requestable\/errortype"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Requestable"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"associatedtype"},{"kind":"text","text":" "},{"kind":"identifier","text":"ErrorType"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","text":"Auth0APIError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","preciseIdentifier":"s:5Auth00A8APIErrorP"}],"platforms":["iOS"]}]}],"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"metadata":{"externalID":"s:5Auth011RequestableP9ErrorTypeQa","symbolKind":"associatedtype","title":"ErrorType","roleHeading":"Associated Type","role":"symbol","required":true,"fragments":[{"text":"associatedtype","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ErrorType","kind":"identifier"},{"text":" : ","kind":"text"},{"preciseIdentifier":"s:5Auth00A8APIErrorP","text":"Auth0APIError","kind":"typeIdentifier"}],"modules":[{"name":"Auth0"}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Requestable\/ErrorType"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Auth0APIError":{"url":"\/documentation\/auth0\/auth0apierror","abstract":[{"type":"text","text":"Generic representation of Auth0 API errors."}],"title":"Auth0APIError","navigatorTitle":[{"kind":"identifier","text":"Auth0APIError"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Auth0APIError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0APIError","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Requestable":{"kind":"symbol","abstract":[],"type":"topic","url":"\/documentation\/auth0\/requestable","title":"Requestable","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Requestable","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Requestable","navigatorTitle":[{"text":"Requestable","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Requestable/ErrorType":{"type":"topic","abstract":[],"title":"ErrorType","kind":"symbol","url":"\/documentation\/auth0\/requestable\/errortype","required":true,"role":"symbol","fragments":[{"kind":"keyword","text":"associatedtype"},{"kind":"text","text":" "},{"kind":"identifier","text":"ErrorType"},{"kind":"text","text":" : "},{"preciseIdentifier":"s:5Auth00A8APIErrorP","kind":"typeIdentifier","text":"Auth0APIError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Requestable\/ErrorType"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/requestable/resulttype.json b/docs/data/documentation/auth0/requestable/resulttype.json new file mode 100644 index 000000000..bdc825b44 --- /dev/null +++ b/docs/data/documentation/auth0/requestable/resulttype.json @@ -0,0 +1 @@ +{"metadata":{"symbolKind":"associatedtype","title":"ResultType","externalID":"s:5Auth011RequestableP10ResultTypeQa","roleHeading":"Associated Type","modules":[{"name":"Auth0"}],"fragments":[{"text":"associatedtype","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ResultType","kind":"identifier"}],"role":"symbol","required":true},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/requestable\/resulttype"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Requestable\/ResultType"},"kind":"symbol","primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"associatedtype","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ResultType","kind":"identifier"}],"platforms":["iOS"]}],"kind":"declarations"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Requestable"]]},"schemaVersion":{"patch":0,"minor":3,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Requestable":{"kind":"symbol","abstract":[],"type":"topic","url":"\/documentation\/auth0\/requestable","title":"Requestable","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Requestable","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Requestable","navigatorTitle":[{"text":"Requestable","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Requestable/ResultType":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Requestable\/ResultType","kind":"symbol","title":"ResultType","fragments":[{"kind":"keyword","text":"associatedtype"},{"kind":"text","text":" "},{"kind":"identifier","text":"ResultType"}],"role":"symbol","required":true,"url":"\/documentation\/auth0\/requestable\/resulttype","abstract":[],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/requestable/start(_:).json b/docs/data/documentation/auth0/requestable/start(_:).json new file mode 100644 index 000000000..318080df7 --- /dev/null +++ b/docs/data/documentation/auth0/requestable/start(_:).json @@ -0,0 +1 @@ +{"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"start","kind":"identifier"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"callback","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"@escaping","kind":"attribute"},{"text":" (","kind":"text"},{"preciseIdentifier":"s:s6ResultO","text":"Result","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth011RequestableP10ResultTypeQa","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Requestable\/ResultType","text":"ResultType","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Requestable\/ErrorType","preciseIdentifier":"s:5Auth011RequestableP9ErrorTypeQa","text":"ErrorType","kind":"typeIdentifier"},{"text":">) -> ","kind":"text"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"text":")","kind":"text"}],"platforms":["iOS"]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/requestable\/start(_:)"]}],"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Requestable"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Requestable\/start(_:)"},"metadata":{"roleHeading":"Instance Method","symbolKind":"method","role":"symbol","title":"start(_:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"start","kind":"identifier"},{"text":"((","kind":"text"},{"text":"Result","preciseIdentifier":"s:s6ResultO","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"ResultType","preciseIdentifier":"s:5Auth011RequestableP10ResultTypeQa","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"ErrorType","preciseIdentifier":"s:5Auth011RequestableP9ErrorTypeQa","kind":"typeIdentifier"},{"text":">) -> ","kind":"text"},{"text":"Void","preciseIdentifier":"s:s4Voida","kind":"typeIdentifier"},{"text":")","kind":"text"}],"required":true,"externalID":"s:5Auth011RequestableP5startyyys6ResultOy0D4TypeQz05ErrorE0QzGcF","modules":[{"name":"Auth0"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Requestable/ResultType":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Requestable\/ResultType","kind":"symbol","title":"ResultType","fragments":[{"kind":"keyword","text":"associatedtype"},{"kind":"text","text":" "},{"kind":"identifier","text":"ResultType"}],"role":"symbol","required":true,"url":"\/documentation\/auth0\/requestable\/resulttype","abstract":[],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Requestable/start(_:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Requestable\/start(_:)","kind":"symbol","title":"start(_:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"start","kind":"identifier"},{"text":"((","kind":"text"},{"text":"Result","preciseIdentifier":"s:s6ResultO","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"ResultType","preciseIdentifier":"s:5Auth011RequestableP10ResultTypeQa","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"ErrorType","preciseIdentifier":"s:5Auth011RequestableP9ErrorTypeQa","kind":"typeIdentifier"},{"text":">) -> ","kind":"text"},{"text":"Void","preciseIdentifier":"s:s4Voida","kind":"typeIdentifier"},{"text":")","kind":"text"}],"role":"symbol","required":true,"url":"\/documentation\/auth0\/requestable\/start(_:)","abstract":[],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Requestable/ErrorType":{"type":"topic","abstract":[],"title":"ErrorType","kind":"symbol","url":"\/documentation\/auth0\/requestable\/errortype","required":true,"role":"symbol","fragments":[{"kind":"keyword","text":"associatedtype"},{"kind":"text","text":" "},{"kind":"identifier","text":"ErrorType"},{"kind":"text","text":" : "},{"preciseIdentifier":"s:5Auth00A8APIErrorP","kind":"typeIdentifier","text":"Auth0APIError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Requestable\/ErrorType"},"doc://com.auth0.Auth0/documentation/Auth0/Requestable":{"kind":"symbol","abstract":[],"type":"topic","url":"\/documentation\/auth0\/requestable","title":"Requestable","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Requestable","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Requestable","navigatorTitle":[{"text":"Requestable","kind":"identifier"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/senderconstraining.json b/docs/data/documentation/auth0/senderconstraining.json index 44e8b3750..8a0210805 100644 --- a/docs/data/documentation/auth0/senderconstraining.json +++ b/docs/data/documentation/auth0/senderconstraining.json @@ -1 +1 @@ -{"schemaVersion":{"minor":3,"patch":0,"major":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SenderConstraining","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"abstract":[{"text":"A type that can use DPoP for securing requests.","type":"text"}],"kind":"symbol","metadata":{"externalID":"s:5Auth018SenderConstrainingP","modules":[{"name":"Auth0"}],"symbolKind":"protocol","navigatorTitle":[{"text":"SenderConstraining","kind":"identifier"}],"fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"SenderConstraining","kind":"identifier"}],"role":"symbol","title":"SenderConstraining","roleHeading":"Protocol"},"variants":[{"paths":["\/documentation\/auth0\/senderconstraining"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"relationshipsSections":[{"title":"Inherited By","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"],"kind":"relationships","type":"inheritedBy"}],"primaryContentSections":[{"declarations":[{"tokens":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"SenderConstraining","kind":"identifier"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"},{"kind":"content","content":[{"type":"heading","text":"Availability","anchor":"Availability","level":2},{"type":"paragraph","inlineContent":[{"type":"text","text":"This feature is currently available in"},{"type":"text","text":" "},{"type":"reference","isActive":true,"identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access"},{"type":"text","text":"."},{"type":"text","text":" "},{"type":"text","text":"Please reach out to Auth0 support to get it enabled for your tenant."}]}]}],"topicSections":[{"title":"Instance Properties","generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SenderConstraining\/dpop"],"anchor":"Instance-Properties"},{"title":"Instance Methods","generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SenderConstraining\/useDPoP(keychainIdentifier:)"],"anchor":"Instance-Methods"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"title":"WebAuth","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"url":"\/documentation\/auth0\/webauth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"kind":"symbol"},"https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access":{"title":"Early Access","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","type":"link","titleInlineContent":[{"type":"text","text":"Early Access"}],"url":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access"},"doc://com.auth0.Auth0/documentation/Auth0/SenderConstraining/dpop":{"role":"symbol","kind":"symbol","abstract":[{"text":"The ","type":"text"},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP"},{"text":" instance used for securing requests.","type":"text"}],"url":"\/documentation\/auth0\/senderconstraining\/dpop","required":true,"type":"topic","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"dpop"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"DPoP","preciseIdentifier":"s:5Auth04DPoPV"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SenderConstraining\/dpop","title":"dpop"},"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/Authentication":{"type":"topic","role":"symbol","title":"Authentication","abstract":[{"text":"Client for the ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"text":".","type":"text"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"doc://com.auth0.Auth0/documentation/Auth0/DPoP":{"role":"symbol","type":"topic","title":"DPoP","kind":"symbol","url":"\/documentation\/auth0\/dpop","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"DPoP","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP","abstract":[{"text":"Utilities for securing requests with DPoP (Demonstrating Proof of Possession) as described in","type":"text"},{"text":" ","type":"text"},{"type":"reference","identifier":"https:\/\/datatracker.ietf.org\/doc\/html\/rfc9449","isActive":true},{"text":".","type":"text"}],"navigatorTitle":[{"text":"DPoP","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/SenderConstraining":{"navigatorTitle":[{"kind":"identifier","text":"SenderConstraining"}],"role":"symbol","kind":"symbol","abstract":[{"text":"A type that can use DPoP for securing requests.","type":"text"}],"url":"\/documentation\/auth0\/senderconstraining","type":"topic","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"SenderConstraining"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SenderConstraining","title":"SenderConstraining"},"doc://com.auth0.Auth0/documentation/Auth0/SenderConstraining/useDPoP(keychainIdentifier:)":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"useDPoP","kind":"identifier"},{"text":"(","kind":"text"},{"text":"keychainIdentifier","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"abstract":[{"type":"text","text":"Enables DPoP for securing requests."}],"url":"\/documentation\/auth0\/senderconstraining\/usedpop(keychainidentifier:)","kind":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SenderConstraining\/useDPoP(keychainIdentifier:)","title":"useDPoP(keychainIdentifier:)","role":"symbol"}}} \ No newline at end of file +{"topicSections":[{"title":"Instance Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SenderConstraining\/dpop"],"anchor":"Instance-Properties","generated":true},{"title":"Instance Methods","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SenderConstraining\/useDPoP(keychainIdentifier:)"],"anchor":"Instance-Methods","generated":true}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"metadata":{"symbolKind":"protocol","modules":[{"name":"Auth0"}],"title":"SenderConstraining","navigatorTitle":[{"kind":"identifier","text":"SenderConstraining"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"SenderConstraining"}],"externalID":"s:5Auth018SenderConstrainingP","role":"symbol","roleHeading":"Protocol"},"sections":[],"abstract":[{"text":"A type that can use DPoP for securing requests.","type":"text"}],"relationshipsSections":[{"title":"Inherited By","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"],"type":"inheritedBy","kind":"relationships"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/senderconstraining"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SenderConstraining","interfaceLanguage":"swift"},"kind":"symbol","schemaVersion":{"patch":0,"major":0,"minor":3},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"SenderConstraining"}],"languages":["swift"],"platforms":["iOS"]}]},{"kind":"content","content":[{"anchor":"Availability","text":"Availability","type":"heading","level":2},{"inlineContent":[{"text":"This feature is currently available in","type":"text"},{"text":" ","type":"text"},{"isActive":true,"identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","type":"reference"},{"text":".","type":"text"},{"text":" ","type":"text"},{"text":"Please reach out to Auth0 support to get it enabled for your tenant.","type":"text"}],"type":"paragraph"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/SenderConstraining/useDPoP(keychainIdentifier:)":{"url":"\/documentation\/auth0\/senderconstraining\/usedpop(keychainidentifier:)","title":"useDPoP(keychainIdentifier:)","abstract":[{"text":"Enables DPoP for securing requests.","type":"text"}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"useDPoP"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keychainIdentifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SenderConstraining\/useDPoP(keychainIdentifier:)","role":"symbol","kind":"symbol","type":"topic"},"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/SenderConstraining/dpop":{"url":"\/documentation\/auth0\/senderconstraining\/dpop","title":"dpop","abstract":[{"text":"The ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP","type":"reference"},{"text":" instance used for securing requests.","type":"text"}],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"dpop"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth04DPoPV","kind":"typeIdentifier","text":"DPoP"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SenderConstraining\/dpop","required":true,"kind":"symbol","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/DPoP":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP","type":"topic","title":"DPoP","role":"symbol","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"DPoP","kind":"identifier"}],"abstract":[{"type":"text","text":"Utilities for securing requests with DPoP (Demonstrating Proof of Possession) as described in"},{"type":"text","text":" "},{"isActive":true,"type":"reference","identifier":"https:\/\/datatracker.ietf.org\/doc\/html\/rfc9449"},{"type":"text","text":"."}],"url":"\/documentation\/auth0\/dpop","navigatorTitle":[{"text":"DPoP","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","abstract":[{"type":"text","text":"Client for the "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","isActive":true},{"type":"text","text":"."}],"type":"topic","title":"Authentication","url":"\/documentation\/auth0\/authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"doc://com.auth0.Auth0/documentation/Auth0/SenderConstraining":{"kind":"symbol","abstract":[{"text":"A type that can use DPoP for securing requests.","type":"text"}],"type":"topic","title":"SenderConstraining","url":"\/documentation\/auth0\/senderconstraining","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"SenderConstraining"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SenderConstraining","navigatorTitle":[{"kind":"identifier","text":"SenderConstraining"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"url":"\/documentation\/auth0\/webauth","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"title":"WebAuth","navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","role":"symbol","kind":"symbol","type":"topic"},"https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access":{"title":"Early Access","type":"link","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","titleInlineContent":[{"text":"Early Access","type":"text"}],"url":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/senderconstraining/dpop.json b/docs/data/documentation/auth0/senderconstraining/dpop.json index 2c1e53511..cd1ef15a5 100644 --- a/docs/data/documentation/auth0/senderconstraining/dpop.json +++ b/docs/data/documentation/auth0/senderconstraining/dpop.json @@ -1 +1 @@ -{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SenderConstraining\/dpop"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/senderconstraining\/dpop"]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"dpop"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth04DPoPV","text":"DPoP","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP"},{"kind":"text","text":"? { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" "},{"kind":"keyword","text":"set"},{"kind":"text","text":" }"}]}]},{"kind":"content","content":[{"type":"heading","level":2,"text":"Discussion","anchor":"discussion"},{"style":"important","type":"aside","name":"Important","content":[{"inlineContent":[{"text":"This property must be set before making requests to ensure DPoP functionality.","type":"text"}],"type":"paragraph"}]}]}],"abstract":[{"text":"The ","type":"text"},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP"},{"text":" instance used for securing requests.","type":"text"}],"kind":"symbol","metadata":{"role":"symbol","required":true,"roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"symbolKind":"property","externalID":"s:5Auth018SenderConstrainingP4dpopAA4DPoPVSgvp","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"dpop","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth04DPoPV","text":"DPoP","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"title":"dpop"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SenderConstraining"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/DPoP":{"role":"symbol","type":"topic","title":"DPoP","kind":"symbol","url":"\/documentation\/auth0\/dpop","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"DPoP","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP","abstract":[{"text":"Utilities for securing requests with DPoP (Demonstrating Proof of Possession) as described in","type":"text"},{"text":" ","type":"text"},{"type":"reference","identifier":"https:\/\/datatracker.ietf.org\/doc\/html\/rfc9449","isActive":true},{"text":".","type":"text"}],"navigatorTitle":[{"text":"DPoP","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/SenderConstraining":{"navigatorTitle":[{"kind":"identifier","text":"SenderConstraining"}],"role":"symbol","kind":"symbol","abstract":[{"text":"A type that can use DPoP for securing requests.","type":"text"}],"url":"\/documentation\/auth0\/senderconstraining","type":"topic","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"SenderConstraining"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SenderConstraining","title":"SenderConstraining"},"https://datatracker.ietf.org/doc/html/rfc9449":{"identifier":"https:\/\/datatracker.ietf.org\/doc\/html\/rfc9449","title":"RFC 9449","titleInlineContent":[{"text":"RFC 9449","type":"text"}],"url":"https:\/\/datatracker.ietf.org\/doc\/html\/rfc9449","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/SenderConstraining/dpop":{"role":"symbol","kind":"symbol","abstract":[{"text":"The ","type":"text"},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP"},{"text":" instance used for securing requests.","type":"text"}],"url":"\/documentation\/auth0\/senderconstraining\/dpop","required":true,"type":"topic","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"dpop"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"DPoP","preciseIdentifier":"s:5Auth04DPoPV"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SenderConstraining\/dpop","title":"dpop"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"abstract":[{"text":"The ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP","isActive":true,"type":"reference"},{"text":" instance used for securing requests.","type":"text"}],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"dpop"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP","preciseIdentifier":"s:5Auth04DPoPV","text":"DPoP"},{"kind":"text","text":"? { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" "},{"kind":"keyword","text":"set"},{"text":" }","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"},{"content":[{"anchor":"discussion","level":2,"text":"Discussion","type":"heading"},{"content":[{"inlineContent":[{"text":"This property must be set before making requests to ensure DPoP functionality.","type":"text"}],"type":"paragraph"}],"style":"important","name":"Important","type":"aside"}],"kind":"content"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/senderconstraining\/dpop"]}],"schemaVersion":{"patch":0,"minor":3,"major":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SenderConstraining"]]},"metadata":{"modules":[{"name":"Auth0"}],"title":"dpop","roleHeading":"Instance Property","symbolKind":"property","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"dpop","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"DPoP","preciseIdentifier":"s:5Auth04DPoPV"},{"kind":"text","text":"?"}],"required":true,"externalID":"s:5Auth018SenderConstrainingP4dpopAA4DPoPVSgvp"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SenderConstraining\/dpop","interfaceLanguage":"swift"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/SenderConstraining/dpop":{"url":"\/documentation\/auth0\/senderconstraining\/dpop","title":"dpop","abstract":[{"text":"The ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP","type":"reference"},{"text":" instance used for securing requests.","type":"text"}],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"dpop"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth04DPoPV","kind":"typeIdentifier","text":"DPoP"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SenderConstraining\/dpop","required":true,"kind":"symbol","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/SenderConstraining":{"kind":"symbol","abstract":[{"text":"A type that can use DPoP for securing requests.","type":"text"}],"type":"topic","title":"SenderConstraining","url":"\/documentation\/auth0\/senderconstraining","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"SenderConstraining"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SenderConstraining","navigatorTitle":[{"kind":"identifier","text":"SenderConstraining"}]},"https://datatracker.ietf.org/doc/html/rfc9449":{"identifier":"https:\/\/datatracker.ietf.org\/doc\/html\/rfc9449","type":"link","title":"RFC 9449","titleInlineContent":[{"text":"RFC 9449","type":"text"}],"url":"https:\/\/datatracker.ietf.org\/doc\/html\/rfc9449"},"doc://com.auth0.Auth0/documentation/Auth0/DPoP":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP","type":"topic","title":"DPoP","role":"symbol","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"DPoP","kind":"identifier"}],"abstract":[{"type":"text","text":"Utilities for securing requests with DPoP (Demonstrating Proof of Possession) as described in"},{"type":"text","text":" "},{"isActive":true,"type":"reference","identifier":"https:\/\/datatracker.ietf.org\/doc\/html\/rfc9449"},{"type":"text","text":"."}],"url":"\/documentation\/auth0\/dpop","navigatorTitle":[{"text":"DPoP","kind":"identifier"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/senderconstraining/usedpop(keychainidentifier:).json b/docs/data/documentation/auth0/senderconstraining/usedpop(keychainidentifier:).json index f08a7bee0..5de983be7 100644 --- a/docs/data/documentation/auth0/senderconstraining/usedpop(keychainidentifier:).json +++ b/docs/data/documentation/auth0/senderconstraining/usedpop(keychainidentifier:).json @@ -1 +1 @@ -{"sections":[],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"useDPoP","kind":"identifier"},{"text":"(","kind":"text"},{"text":"keychainIdentifier","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" = DPoP.defaultKeychainIdentifier) -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}]}],"kind":"declarations"},{"parameters":[{"content":[{"inlineContent":[{"type":"text","text":"The identifier used to store the key pair on the Keychain. Defaults to the bundle identifier."}],"type":"paragraph"}],"name":"keychainIdentifier"}],"kind":"parameters"},{"content":[{"anchor":"return-value","text":"Return Value","level":2,"type":"heading"},{"inlineContent":[{"text":"A modified instance with DPoP enabled.","type":"text"}],"type":"paragraph"}],"kind":"content"},{"content":[{"text":"Discussion","level":2,"type":"heading","anchor":"discussion"},{"inlineContent":[{"text":"This method initializes a ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP","isActive":true,"type":"reference"},{"text":" instance with the specified keychain identifier and assigns it to the","type":"text"},{"text":" ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SenderConstraining\/dpop","isActive":true,"type":"reference"},{"text":" property.","type":"text"}],"type":"paragraph"},{"text":"Availability","level":2,"type":"heading","anchor":"Availability"},{"inlineContent":[{"text":"This feature is currently available in","type":"text"},{"text":" ","type":"text"},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","isActive":true},{"text":".","type":"text"},{"text":" ","type":"text"},{"text":"Please reach out to Auth0 support to get it enabled for your tenant.","type":"text"}],"type":"paragraph"}],"kind":"content"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"externalID":"s:5Auth018SenderConstrainingPAAE7useDPoP18keychainIdentifierxSS_tF","roleHeading":"Instance Method","modules":[{"name":"Auth0"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"useDPoP","kind":"identifier"},{"text":"(","kind":"text"},{"text":"keychainIdentifier","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"extendedModule":"Auth0","symbolKind":"method","title":"useDPoP(keychainIdentifier:)","role":"symbol"},"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SenderConstraining\/useDPoP(keychainIdentifier:)","interfaceLanguage":"swift"},"seeAlsoSections":[{"title":"Related Documentation","anchor":"Related-Documentation","identifiers":["https:\/\/www.rfc-editor.org\/rfc\/rfc9449.html"]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/senderconstraining\/usedpop(keychainidentifier:)"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SenderConstraining"]]},"abstract":[{"type":"text","text":"Enables DPoP for securing requests."}],"references":{"https://www.rfc-editor.org/rfc/rfc9449.html":{"titleInlineContent":[{"text":"RFC 9449","type":"text"}],"url":"https:\/\/www.rfc-editor.org\/rfc\/rfc9449.html","title":"RFC 9449","identifier":"https:\/\/www.rfc-editor.org\/rfc\/rfc9449.html","type":"link"},"https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access":{"type":"link","title":"Early Access","url":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","titleInlineContent":[{"type":"text","text":"Early Access"}]},"doc://com.auth0.Auth0/documentation/Auth0/SenderConstraining/useDPoP(keychainIdentifier:)":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"useDPoP","kind":"identifier"},{"text":"(","kind":"text"},{"text":"keychainIdentifier","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"abstract":[{"type":"text","text":"Enables DPoP for securing requests."}],"url":"\/documentation\/auth0\/senderconstraining\/usedpop(keychainidentifier:)","kind":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SenderConstraining\/useDPoP(keychainIdentifier:)","title":"useDPoP(keychainIdentifier:)","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/SenderConstraining":{"navigatorTitle":[{"kind":"identifier","text":"SenderConstraining"}],"role":"symbol","kind":"symbol","abstract":[{"text":"A type that can use DPoP for securing requests.","type":"text"}],"url":"\/documentation\/auth0\/senderconstraining","type":"topic","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"SenderConstraining"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SenderConstraining","title":"SenderConstraining"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/SenderConstraining/dpop":{"role":"symbol","kind":"symbol","abstract":[{"text":"The ","type":"text"},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP"},{"text":" instance used for securing requests.","type":"text"}],"url":"\/documentation\/auth0\/senderconstraining\/dpop","required":true,"type":"topic","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"dpop"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"DPoP","preciseIdentifier":"s:5Auth04DPoPV"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SenderConstraining\/dpop","title":"dpop"},"doc://com.auth0.Auth0/documentation/Auth0/DPoP":{"role":"symbol","type":"topic","title":"DPoP","kind":"symbol","url":"\/documentation\/auth0\/dpop","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"DPoP","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP","abstract":[{"text":"Utilities for securing requests with DPoP (Demonstrating Proof of Possession) as described in","type":"text"},{"text":" ","type":"text"},{"type":"reference","identifier":"https:\/\/datatracker.ietf.org\/doc\/html\/rfc9449","isActive":true},{"text":".","type":"text"}],"navigatorTitle":[{"text":"DPoP","kind":"identifier"}]},"https://datatracker.ietf.org/doc/html/rfc9449":{"titleInlineContent":[{"type":"text","text":"RFC 9449"}],"type":"link","title":"RFC 9449","url":"https:\/\/datatracker.ietf.org\/doc\/html\/rfc9449","identifier":"https:\/\/datatracker.ietf.org\/doc\/html\/rfc9449"}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/senderconstraining\/usedpop(keychainidentifier:)"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SenderConstraining"]]},"abstract":[{"type":"text","text":"Enables DPoP for securing requests."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"useDPoP","kind":"identifier"},{"text":"(","kind":"text"},{"text":"keychainIdentifier","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" = DPoP.defaultKeychainIdentifier) -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"languages":["swift"],"platforms":["iOS"]}]},{"parameters":[{"name":"keychainIdentifier","content":[{"inlineContent":[{"type":"text","text":"The identifier used to store the key pair on the Keychain. Defaults to the bundle identifier."}],"type":"paragraph"}]}],"kind":"parameters"},{"kind":"content","content":[{"type":"heading","text":"Return Value","anchor":"return-value","level":2},{"inlineContent":[{"text":"A modified instance with DPoP enabled.","type":"text"}],"type":"paragraph"}]},{"kind":"content","content":[{"anchor":"discussion","text":"Discussion","type":"heading","level":2},{"type":"paragraph","inlineContent":[{"text":"This method initializes a ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP","type":"reference"},{"text":" instance with the specified keychain identifier and assigns it to the","type":"text"},{"text":" ","type":"text"},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SenderConstraining\/dpop"},{"text":" property.","type":"text"}]},{"type":"heading","anchor":"Availability","level":2,"text":"Availability"},{"inlineContent":[{"type":"text","text":"This feature is currently available in"},{"text":" ","type":"text"},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","isActive":true},{"text":".","type":"text"},{"type":"text","text":" "},{"type":"text","text":"Please reach out to Auth0 support to get it enabled for your tenant."}],"type":"paragraph"}]}],"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/www.rfc-editor.org\/rfc\/rfc9449.html"],"anchor":"Related-Documentation"}],"metadata":{"externalID":"s:5Auth018SenderConstrainingPAAE7useDPoP18keychainIdentifierxSS_tF","extendedModule":"Auth0","symbolKind":"method","title":"useDPoP(keychainIdentifier:)","roleHeading":"Instance Method","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"useDPoP"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keychainIdentifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"modules":[{"name":"Auth0"}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SenderConstraining\/useDPoP(keychainIdentifier:)"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/SenderConstraining/dpop":{"url":"\/documentation\/auth0\/senderconstraining\/dpop","title":"dpop","abstract":[{"text":"The ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP","type":"reference"},{"text":" instance used for securing requests.","type":"text"}],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"dpop"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth04DPoPV","kind":"typeIdentifier","text":"DPoP"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SenderConstraining\/dpop","required":true,"kind":"symbol","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/SenderConstraining/useDPoP(keychainIdentifier:)":{"url":"\/documentation\/auth0\/senderconstraining\/usedpop(keychainidentifier:)","title":"useDPoP(keychainIdentifier:)","abstract":[{"text":"Enables DPoP for securing requests.","type":"text"}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"useDPoP"},{"kind":"text","text":"("},{"kind":"externalParam","text":"keychainIdentifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SenderConstraining\/useDPoP(keychainIdentifier:)","role":"symbol","kind":"symbol","type":"topic"},"https://www.rfc-editor.org/rfc/rfc9449.html":{"title":"RFC 9449","titleInlineContent":[{"text":"RFC 9449","type":"text"}],"url":"https:\/\/www.rfc-editor.org\/rfc\/rfc9449.html","identifier":"https:\/\/www.rfc-editor.org\/rfc\/rfc9449.html","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/SenderConstraining":{"kind":"symbol","abstract":[{"text":"A type that can use DPoP for securing requests.","type":"text"}],"type":"topic","title":"SenderConstraining","url":"\/documentation\/auth0\/senderconstraining","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"SenderConstraining"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SenderConstraining","navigatorTitle":[{"kind":"identifier","text":"SenderConstraining"}]},"doc://com.auth0.Auth0/documentation/Auth0/DPoP":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/DPoP","type":"topic","title":"DPoP","role":"symbol","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"DPoP","kind":"identifier"}],"abstract":[{"type":"text","text":"Utilities for securing requests with DPoP (Demonstrating Proof of Possession) as described in"},{"type":"text","text":" "},{"isActive":true,"type":"reference","identifier":"https:\/\/datatracker.ietf.org\/doc\/html\/rfc9449"},{"type":"text","text":"."}],"url":"\/documentation\/auth0\/dpop","navigatorTitle":[{"text":"DPoP","kind":"identifier"}]},"https://auth0.com/docs/troubleshoot/product-lifecycle/product-release-stages#early-access":{"url":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","title":"Early Access","identifier":"https:\/\/auth0.com\/docs\/troubleshoot\/product-lifecycle\/product-release-stages#early-access","titleInlineContent":[{"text":"Early Access","type":"text"}],"type":"link"},"https://datatracker.ietf.org/doc/html/rfc9449":{"url":"https:\/\/datatracker.ietf.org\/doc\/html\/rfc9449","title":"RFC 9449","identifier":"https:\/\/datatracker.ietf.org\/doc\/html\/rfc9449","titleInlineContent":[{"text":"RFC 9449","type":"text"}],"type":"link"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/signuppasskey.json b/docs/data/documentation/auth0/signuppasskey.json index ae97544f4..7ccda0ff1 100644 --- a/docs/data/documentation/auth0/signuppasskey.json +++ b/docs/data/documentation/auth0/signuppasskey.json @@ -1 +1 @@ -{"abstract":[{"type":"text","text":"The signup passkey credential obtained from the "},{"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","isActive":true},{"type":"text","text":" delegate."},{"type":"text","text":" "},{"type":"text","text":"Contains the subset of relevant properties from "},{"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialregistration","isActive":true},{"type":"text","text":"."}],"metadata":{"roleHeading":"Protocol","symbolKind":"protocol","platforms":[{"introducedAt":"16.6","deprecated":false,"unavailable":false,"name":"iOS","beta":false},{"introducedAt":"16.6","deprecated":false,"unavailable":false,"name":"iPadOS","beta":false},{"introducedAt":"16.6","deprecated":false,"unavailable":false,"name":"Mac Catalyst","beta":false},{"introducedAt":"13.5","deprecated":false,"unavailable":false,"name":"macOS","beta":false},{"introducedAt":"1.0","deprecated":false,"unavailable":false,"name":"visionOS","beta":false}],"modules":[{"name":"Auth0"}],"navigatorTitle":[{"kind":"identifier","text":"SignupPasskey"}],"title":"SignupPasskey","role":"symbol","externalID":"s:5Auth013SignupPasskeyP","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"SignupPasskey"}]},"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SignupPasskey","interfaceLanguage":"swift"},"relationshipsSections":[{"type":"inheritsFrom","title":"Inherits From","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/NewPasskey"],"kind":"relationships"},{"type":"conformingTypes","title":"Conforming Types","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationServices\/ASAuthorizationPlatformPublicKeyCredentialRegistration"],"kind":"relationships"}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/signuppasskey"]}],"primaryContentSections":[{"declarations":[{"tokens":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"SignupPasskey","kind":"identifier"},{"text":" : ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/NewPasskey","text":"NewPasskey","preciseIdentifier":"s:5Auth010NewPasskeyP","kind":"typeIdentifier"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationServices/ASAuthorizationPlatformPublicKeyCredentialRegistration":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationServices\/ASAuthorizationPlatformPublicKeyCredentialRegistration","title":"ASAuthorizationPlatformPublicKeyCredentialRegistration"},"https://developer.apple.com/documentation/authenticationservices/asauthorizationcontrollerdelegate":{"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","type":"link","titleInlineContent":[{"type":"codeVoice","code":"ASAuthorizationControllerDelegate"}],"title":"ASAuthorizationControllerDelegate"},"https://developer.apple.com/documentation/authenticationservices/asauthorizationplatformpublickeycredentialregistration":{"type":"link","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialregistration","title":"ASAuthorizationPlatformPublicKeyCredentialRegistration","url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialregistration","titleInlineContent":[{"type":"codeVoice","code":"ASAuthorizationPlatformPublicKeyCredentialRegistration"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/SignupPasskey":{"type":"topic","kind":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"SignupPasskey","kind":"identifier"}],"url":"\/documentation\/auth0\/signuppasskey","abstract":[{"type":"text","text":"The signup passkey credential obtained from the "},{"isActive":true,"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","type":"reference"},{"type":"text","text":" delegate."},{"type":"text","text":" "},{"type":"text","text":"Contains the subset of relevant properties from "},{"isActive":true,"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialregistration","type":"reference"},{"type":"text","text":"."}],"role":"symbol","navigatorTitle":[{"text":"SignupPasskey","kind":"identifier"}],"title":"SignupPasskey","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SignupPasskey"},"doc://com.auth0.Auth0/documentation/Auth0/NewPasskey":{"role":"symbol","title":"NewPasskey","abstract":[{"text":"The signup passkey credential obtained from the ","type":"text"},{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","isActive":true,"type":"reference"},{"text":" delegate.","type":"text"},{"text":" ","type":"text"},{"text":"Contains the subset of relevant properties from ","type":"text"},{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialregistration","isActive":true,"type":"reference"},{"text":".","type":"text"}],"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/newpasskey","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/NewPasskey","navigatorTitle":[{"text":"NewPasskey","kind":"identifier"}],"fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"NewPasskey","kind":"identifier"}]}}} \ No newline at end of file +{"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SignupPasskey"},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"SignupPasskey"},{"kind":"text","text":" : "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/NewPasskey","kind":"typeIdentifier","text":"NewPasskey","preciseIdentifier":"s:5Auth010NewPasskeyP"}],"platforms":["iOS"],"languages":["swift"]}]}],"relationshipsSections":[{"kind":"relationships","title":"Inherits From","type":"inheritsFrom","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/NewPasskey"]},{"kind":"relationships","title":"Conforming Types","type":"conformingTypes","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationServices\/ASAuthorizationPlatformPublicKeyCredentialRegistration"]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/signuppasskey"]}],"kind":"symbol","metadata":{"modules":[{"name":"Auth0"}],"platforms":[{"name":"iOS","deprecated":false,"introducedAt":"16.6","beta":false,"unavailable":false},{"name":"iPadOS","deprecated":false,"introducedAt":"16.6","beta":false,"unavailable":false},{"name":"Mac Catalyst","deprecated":false,"introducedAt":"16.6","beta":false,"unavailable":false},{"name":"macOS","deprecated":false,"introducedAt":"13.5","beta":false,"unavailable":false},{"name":"visionOS","deprecated":false,"introducedAt":"1.0","beta":false,"unavailable":false}],"title":"SignupPasskey","externalID":"s:5Auth013SignupPasskeyP","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"SignupPasskey"}],"roleHeading":"Protocol","symbolKind":"protocol","navigatorTitle":[{"kind":"identifier","text":"SignupPasskey"}]},"schemaVersion":{"patch":0,"minor":3,"major":0},"abstract":[{"type":"text","text":"The signup passkey credential obtained from the "},{"isActive":true,"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate"},{"type":"text","text":" delegate."},{"type":"text","text":" "},{"type":"text","text":"Contains the subset of relevant properties from "},{"isActive":true,"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialregistration"},{"type":"text","text":"."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/AuthenticationServices/ASAuthorizationPlatformPublicKeyCredentialRegistration":{"type":"unresolvable","title":"ASAuthorizationPlatformPublicKeyCredentialRegistration","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/AuthenticationServices\/ASAuthorizationPlatformPublicKeyCredentialRegistration"},"https://developer.apple.com/documentation/authenticationservices/asauthorizationcontrollerdelegate":{"titleInlineContent":[{"code":"ASAuthorizationControllerDelegate","type":"codeVoice"}],"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","type":"link","title":"ASAuthorizationControllerDelegate","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate"},"doc://com.auth0.Auth0/documentation/Auth0/SignupPasskey":{"title":"SignupPasskey","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SignupPasskey","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"SignupPasskey"}],"abstract":[{"text":"The signup passkey credential obtained from the ","type":"text"},{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate","isActive":true,"type":"reference"},{"text":" delegate.","type":"text"},{"text":" ","type":"text"},{"text":"Contains the subset of relevant properties from ","type":"text"},{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialregistration","isActive":true,"type":"reference"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/signuppasskey","navigatorTitle":[{"kind":"identifier","text":"SignupPasskey"}]},"doc://com.auth0.Auth0/documentation/Auth0/NewPasskey":{"title":"NewPasskey","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/NewPasskey","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"NewPasskey"}],"abstract":[{"type":"text","text":"The signup passkey credential obtained from the "},{"isActive":true,"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationcontrollerdelegate"},{"type":"text","text":" delegate."},{"type":"text","text":" "},{"type":"text","text":"Contains the subset of relevant properties from "},{"isActive":true,"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialregistration"},{"type":"text","text":"."}],"url":"\/documentation\/auth0\/newpasskey","navigatorTitle":[{"kind":"identifier","text":"NewPasskey"}]},"https://developer.apple.com/documentation/authenticationservices/asauthorizationplatformpublickeycredentialregistration":{"titleInlineContent":[{"code":"ASAuthorizationPlatformPublicKeyCredentialRegistration","type":"codeVoice"}],"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialregistration","type":"link","title":"ASAuthorizationPlatformPublicKeyCredentialRegistration","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/asauthorizationplatformpublickeycredentialregistration"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/simplekeychain.json b/docs/data/documentation/auth0/simplekeychain.json index 248cc0ebd..e814ecee4 100644 --- a/docs/data/documentation/auth0/simplekeychain.json +++ b/docs/data/documentation/auth0/simplekeychain.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/simplekeychain"]}],"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain"},"kind":"symbol","metadata":{"roleHeading":"Extended Module","symbolKind":"extension","modules":[{"name":"Auth0"}],"role":"collection","title":"SimpleKeychain","externalID":"s:m:s:e:s:14SimpleKeychainAAV5Auth0E8getEntry6forKey10Foundation4DataVSgSS_tF"},"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain"],"anchor":"Extended-Structures","title":"Extended Structures","generated":true}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain":{"type":"topic","title":"SimpleKeychain","url":"\/documentation\/auth0\/simplekeychain","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain","role":"collection","abstract":[],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage":{"title":"CredentialsStorage","kind":"symbol","navigatorTitle":[{"text":"CredentialsStorage","kind":"identifier"}],"role":"symbol","url":"\/documentation\/auth0\/credentialsstorage","abstract":[{"text":"Generic storage API for storing credentials.","type":"text"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsStorage","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain":{"type":"topic","fragments":[{"kind":"keyword","text":"extension"},{"kind":"text","text":" "},{"preciseIdentifier":"s:14SimpleKeychainAAV","kind":"identifier","text":"SimpleKeychain"}],"title":"SimpleKeychain","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain","navigatorTitle":[{"kind":"identifier","text":"SimpleKeychain"}],"url":"\/documentation\/auth0\/simplekeychain\/simplekeychain","abstract":[{"type":"text","text":"Conformance to "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","isActive":true},{"type":"text","text":"."}],"kind":"symbol"}}} \ No newline at end of file +{"metadata":{"modules":[{"name":"Auth0"}],"roleHeading":"Extended Module","role":"collection","title":"SimpleKeychain","externalID":"s:m:s:e:s:14SimpleKeychainAAV5Auth0E8getEntry6forKey10Foundation4DataVSgSS_tF","symbolKind":"extension"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/simplekeychain"]}],"topicSections":[{"title":"Extended Structures","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain"],"anchor":"Extended-Structures","generated":true}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain"},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"schemaVersion":{"patch":0,"major":0,"minor":3},"references":{"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain","type":"topic","title":"SimpleKeychain","role":"collection","kind":"symbol","abstract":[],"url":"\/documentation\/auth0\/simplekeychain"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage":{"title":"CredentialsStorage","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","role":"symbol","kind":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsStorage","kind":"identifier"}],"abstract":[{"text":"Generic storage API for storing credentials.","type":"text"}],"url":"\/documentation\/auth0\/credentialsstorage","navigatorTitle":[{"text":"CredentialsStorage","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain":{"type":"topic","title":"SimpleKeychain","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain","kind":"symbol","url":"\/documentation\/auth0\/simplekeychain\/simplekeychain","abstract":[{"type":"text","text":"Conformance to "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","isActive":true},{"type":"text","text":"."}],"role":"symbol","fragments":[{"kind":"keyword","text":"extension"},{"kind":"text","text":" "},{"kind":"identifier","preciseIdentifier":"s:14SimpleKeychainAAV","text":"SimpleKeychain"}],"navigatorTitle":[{"kind":"identifier","text":"SimpleKeychain"}]}}} \ 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 b34d20e3f..ffdf8ea65 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"]]},"schemaVersion":{"patch":0,"major":0,"minor":3},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/simplekeychain\/simplekeychain"]}],"kind":"symbol","sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain"},"metadata":{"fragments":[{"kind":"keyword","text":"extension"},{"kind":"text","text":" "},{"kind":"identifier","text":"SimpleKeychain","preciseIdentifier":"s:14SimpleKeychainAAV"}],"role":"symbol","roleHeading":"Extended Structure","externalID":"s:e:s:14SimpleKeychainAAV5Auth0E8getEntry6forKey10Foundation4DataVSgSS_tF","navigatorTitle":[{"kind":"identifier","text":"SimpleKeychain"}],"modules":[{"relatedModules":["SimpleKeychain"],"name":"Auth0"}],"symbolKind":"extension","title":"SimpleKeychain","extendedModule":"SimpleKeychain"},"abstract":[{"type":"text","text":"Conformance to "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","isActive":true,"type":"reference"},{"type":"text","text":"."}],"topicSections":[{"title":"Default Implementations","generated":true,"anchor":"Default-Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/CredentialsStorage-Implementations"]}],"relationshipsSections":[{"title":"Conforms To","kind":"relationships","type":"conformsTo","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","doc:\/\/com.auth0.Auth0\/s8CopyableP"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"extension"},{"kind":"text","text":" "},{"kind":"typeIdentifier","preciseIdentifier":"s:14SimpleKeychainAAV","text":"SimpleKeychain"}],"platforms":["iOS"],"languages":["swift"]}]}],"references":{"doc://com.auth0.Auth0/s8CopyableP":{"identifier":"doc:\/\/com.auth0.Auth0\/s8CopyableP","title":"Swift.Copyable","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain":{"type":"topic","title":"SimpleKeychain","url":"\/documentation\/auth0\/simplekeychain","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain","role":"collection","abstract":[],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage":{"title":"CredentialsStorage","kind":"symbol","navigatorTitle":[{"text":"CredentialsStorage","kind":"identifier"}],"role":"symbol","url":"\/documentation\/auth0\/credentialsstorage","abstract":[{"text":"Generic storage API for storing credentials.","type":"text"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsStorage","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain/CredentialsStorage-Implementations":{"url":"\/documentation\/auth0\/simplekeychain\/simplekeychain\/credentialsstorage-implementations","title":"CredentialsStorage Implementations","type":"topic","kind":"article","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/CredentialsStorage-Implementations","abstract":[],"role":"collectionGroup"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain":{"type":"topic","fragments":[{"kind":"keyword","text":"extension"},{"kind":"text","text":" "},{"preciseIdentifier":"s:14SimpleKeychainAAV","kind":"identifier","text":"SimpleKeychain"}],"title":"SimpleKeychain","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain","navigatorTitle":[{"kind":"identifier","text":"SimpleKeychain"}],"url":"\/documentation\/auth0\/simplekeychain\/simplekeychain","abstract":[{"type":"text","text":"Conformance to "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","isActive":true},{"type":"text","text":"."}],"kind":"symbol"}}} \ No newline at end of file +{"abstract":[{"text":"Conformance to ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","isActive":true,"type":"reference"},{"text":".","type":"text"}],"relationshipsSections":[{"title":"Conforms To","kind":"relationships","type":"conformsTo","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","doc:\/\/com.auth0.Auth0\/s8CopyableP"]}],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"extension"},{"kind":"text","text":" "},{"kind":"typeIdentifier","text":"SimpleKeychain","preciseIdentifier":"s:14SimpleKeychainAAV"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/simplekeychain\/simplekeychain"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain"]]},"topicSections":[{"generated":true,"title":"Default Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/CredentialsStorage-Implementations"],"anchor":"Default-Implementations"}],"metadata":{"externalID":"s:e:s:14SimpleKeychainAAV5Auth0E8getEntry6forKey10Foundation4DataVSgSS_tF","extendedModule":"SimpleKeychain","symbolKind":"extension","title":"SimpleKeychain","role":"symbol","roleHeading":"Extended Structure","fragments":[{"kind":"keyword","text":"extension"},{"kind":"text","text":" "},{"kind":"identifier","preciseIdentifier":"s:14SimpleKeychainAAV","text":"SimpleKeychain"}],"navigatorTitle":[{"kind":"identifier","text":"SimpleKeychain"}],"modules":[{"name":"Auth0","relatedModules":["SimpleKeychain"]}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain","interfaceLanguage":"swift"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain/CredentialsStorage-Implementations":{"type":"topic","abstract":[],"title":"CredentialsStorage Implementations","kind":"article","url":"\/documentation\/auth0\/simplekeychain\/simplekeychain\/credentialsstorage-implementations","role":"collectionGroup","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/CredentialsStorage-Implementations"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain","type":"topic","title":"SimpleKeychain","role":"collection","kind":"symbol","abstract":[],"url":"\/documentation\/auth0\/simplekeychain"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage":{"title":"CredentialsStorage","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","role":"symbol","kind":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsStorage","kind":"identifier"}],"abstract":[{"text":"Generic storage API for storing credentials.","type":"text"}],"url":"\/documentation\/auth0\/credentialsstorage","navigatorTitle":[{"text":"CredentialsStorage","kind":"identifier"}]},"doc://com.auth0.Auth0/s8CopyableP":{"title":"Swift.Copyable","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s8CopyableP"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain":{"type":"topic","title":"SimpleKeychain","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain","kind":"symbol","url":"\/documentation\/auth0\/simplekeychain\/simplekeychain","abstract":[{"type":"text","text":"Conformance to "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","isActive":true},{"type":"text","text":"."}],"role":"symbol","fragments":[{"kind":"keyword","text":"extension"},{"kind":"text","text":" "},{"kind":"identifier","preciseIdentifier":"s:14SimpleKeychainAAV","text":"SimpleKeychain"}],"navigatorTitle":[{"kind":"identifier","text":"SimpleKeychain"}]}}} \ 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 370221e81..24aac87c4 100644 --- a/docs/data/documentation/auth0/simplekeychain/simplekeychain/credentialsstorage-implementations.json +++ b/docs/data/documentation/auth0/simplekeychain/simplekeychain/credentialsstorage-implementations.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/simplekeychain\/simplekeychain\/credentialsstorage-implementations"]}],"schemaVersion":{"major":0,"patch":0,"minor":3},"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","anchor":"Instance-Methods"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/CredentialsStorage-Implementations"},"kind":"article","sections":[],"metadata":{"role":"collectionGroup","title":"CredentialsStorage Implementations","roleHeading":"API Collection","modules":[{"name":"Auth0"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage":{"title":"CredentialsStorage","kind":"symbol","navigatorTitle":[{"text":"CredentialsStorage","kind":"identifier"}],"role":"symbol","url":"\/documentation\/auth0\/credentialsstorage","abstract":[{"text":"Generic storage API for storing credentials.","type":"text"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsStorage","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain":{"type":"topic","title":"SimpleKeychain","url":"\/documentation\/auth0\/simplekeychain","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain","role":"collection","abstract":[],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain":{"type":"topic","fragments":[{"kind":"keyword","text":"extension"},{"kind":"text","text":" "},{"preciseIdentifier":"s:14SimpleKeychainAAV","kind":"identifier","text":"SimpleKeychain"}],"title":"SimpleKeychain","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain","navigatorTitle":[{"kind":"identifier","text":"SimpleKeychain"}],"url":"\/documentation\/auth0\/simplekeychain\/simplekeychain","abstract":[{"type":"text","text":"Conformance to "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","isActive":true},{"type":"text","text":"."}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain/deleteEntry(forKey:)":{"abstract":[{"type":"text","text":"Deletes a storage entry."}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"deleteEntry"},{"kind":"text","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":"deleteEntry(forKey:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/deleteEntry(forKey:)","role":"symbol","url":"\/documentation\/auth0\/simplekeychain\/simplekeychain\/deleteentry(forkey:)","type":"topic","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain/getEntry(forKey:)":{"url":"\/documentation\/auth0\/simplekeychain\/simplekeychain\/getentry(forkey:)","title":"getEntry(forKey:)","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/getEntry(forKey:)","kind":"symbol","abstract":[{"type":"text","text":"Retrieves a storage entry."}],"type":"topic","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getEntry","kind":"identifier"},{"text":"(","kind":"text"},{"text":"forKey","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"Data","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV"},{"text":"?","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain/setEntry(_:forKey:)":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/setEntry(_:forKey:)","type":"topic","title":"setEntry(_:forKey:)","url":"\/documentation\/auth0\/simplekeychain\/simplekeychain\/setentry(_:forkey:)","kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"setEntry"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"abstract":[{"type":"text","text":"Sets a storage entry."}]}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/simplekeychain\/simplekeychain\/credentialsstorage-implementations"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain"]]},"topicSections":[{"title":"Instance Methods","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/deleteEntry(forKey:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/getEntry(forKey:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/setEntry(_:forKey:)"],"anchor":"Instance-Methods","generated":true}],"kind":"article","sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"title":"CredentialsStorage Implementations","role":"collectionGroup","modules":[{"name":"Auth0"}],"roleHeading":"API Collection"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/CredentialsStorage-Implementations"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain":{"type":"topic","title":"SimpleKeychain","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain","kind":"symbol","url":"\/documentation\/auth0\/simplekeychain\/simplekeychain","abstract":[{"type":"text","text":"Conformance to "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","isActive":true},{"type":"text","text":"."}],"role":"symbol","fragments":[{"kind":"keyword","text":"extension"},{"kind":"text","text":" "},{"kind":"identifier","preciseIdentifier":"s:14SimpleKeychainAAV","text":"SimpleKeychain"}],"navigatorTitle":[{"kind":"identifier","text":"SimpleKeychain"}]},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain/getEntry(forKey:)":{"type":"topic","abstract":[{"type":"text","text":"Retrieves a storage entry."}],"kind":"symbol","title":"getEntry(forKey:)","url":"\/documentation\/auth0\/simplekeychain\/simplekeychain\/getentry(forkey:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getEntry","kind":"identifier"},{"text":"(","kind":"text"},{"text":"forKey","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:10Foundation4DataV","text":"Data","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/getEntry(forKey:)"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain","type":"topic","title":"SimpleKeychain","role":"collection","kind":"symbol","abstract":[],"url":"\/documentation\/auth0\/simplekeychain"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain/setEntry(_:forKey:)":{"type":"topic","abstract":[{"type":"text","text":"Sets a storage entry."}],"kind":"symbol","title":"setEntry(_:forKey:)","url":"\/documentation\/auth0\/simplekeychain\/simplekeychain\/setentry(_:forkey:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"setEntry","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:10Foundation4DataV","text":"Data","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"forKey","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/setEntry(_:forKey:)"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain/deleteEntry(forKey:)":{"type":"topic","abstract":[{"type":"text","text":"Deletes a storage entry."}],"kind":"symbol","title":"deleteEntry(forKey:)","url":"\/documentation\/auth0\/simplekeychain\/simplekeychain\/deleteentry(forkey:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"deleteEntry"},{"kind":"text","text":"("},{"text":"forKey","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/deleteEntry(forKey:)"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage":{"title":"CredentialsStorage","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","role":"symbol","kind":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsStorage","kind":"identifier"}],"abstract":[{"text":"Generic storage API for storing credentials.","type":"text"}],"url":"\/documentation\/auth0\/credentialsstorage","navigatorTitle":[{"text":"CredentialsStorage","kind":"identifier"}]}}} \ 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 24bd904a8..89b8e29b2 100644 --- a/docs/data/documentation/auth0/simplekeychain/simplekeychain/deleteentry(forkey:).json +++ b/docs/data/documentation/auth0/simplekeychain/simplekeychain/deleteentry(forkey:).json @@ -1 +1 @@ -{"metadata":{"role":"symbol","symbolKind":"method","extendedModule":"SimpleKeychain","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"deleteEntry","kind":"identifier"},{"text":"(","kind":"text"},{"text":"forKey","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"modules":[{"name":"Auth0","relatedModules":["SimpleKeychain"]}],"title":"deleteEntry(forKey:)","roleHeading":"Instance Method","externalID":"s:14SimpleKeychainAAV5Auth0E11deleteEntry6forKeySbSS_tF"},"sections":[],"abstract":[{"text":"Deletes a storage entry.","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/deleteEntry(forKey:)"},"schemaVersion":{"minor":3,"major":0,"patch":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/simplekeychain\/simplekeychain\/deleteentry(forkey:)"]}],"kind":"symbol","primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"deleteEntry","kind":"identifier"},{"text":"(","kind":"text"},{"text":"forKey","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"key","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"platforms":["iOS"]}],"kind":"declarations"},{"parameters":[{"content":[{"inlineContent":[{"type":"text","text":"The key to delete from the Keychain."}],"type":"paragraph"}],"name":"key"}],"kind":"parameters"},{"content":[{"text":"Return Value","anchor":"return-value","type":"heading","level":2},{"type":"paragraph","inlineContent":[{"text":"If the data was deleted.","type":"text"}]}],"kind":"content"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage":{"title":"CredentialsStorage","kind":"symbol","navigatorTitle":[{"text":"CredentialsStorage","kind":"identifier"}],"role":"symbol","url":"\/documentation\/auth0\/credentialsstorage","abstract":[{"text":"Generic storage API for storing credentials.","type":"text"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsStorage","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain":{"type":"topic","fragments":[{"kind":"keyword","text":"extension"},{"kind":"text","text":" "},{"preciseIdentifier":"s:14SimpleKeychainAAV","kind":"identifier","text":"SimpleKeychain"}],"title":"SimpleKeychain","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain","navigatorTitle":[{"kind":"identifier","text":"SimpleKeychain"}],"url":"\/documentation\/auth0\/simplekeychain\/simplekeychain","abstract":[{"type":"text","text":"Conformance to "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","isActive":true},{"type":"text","text":"."}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain":{"type":"topic","title":"SimpleKeychain","url":"\/documentation\/auth0\/simplekeychain","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain","role":"collection","abstract":[],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain/deleteEntry(forKey:)":{"abstract":[{"type":"text","text":"Deletes a storage entry."}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"deleteEntry"},{"kind":"text","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":"deleteEntry(forKey:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/deleteEntry(forKey:)","role":"symbol","url":"\/documentation\/auth0\/simplekeychain\/simplekeychain\/deleteentry(forkey:)","type":"topic","kind":"symbol"}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/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"]]},"abstract":[{"type":"text","text":"Deletes a storage entry."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"deleteEntry","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":" "},{"kind":"internalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"platforms":["iOS"],"languages":["swift"]}]},{"parameters":[{"content":[{"inlineContent":[{"type":"text","text":"The key to delete from the Keychain."}],"type":"paragraph"}],"name":"key"}],"kind":"parameters"},{"content":[{"type":"heading","anchor":"return-value","level":2,"text":"Return Value"},{"inlineContent":[{"type":"text","text":"If the data was deleted."}],"type":"paragraph"}],"kind":"content"}],"kind":"symbol","schemaVersion":{"patch":0,"minor":3,"major":0},"sections":[],"metadata":{"externalID":"s:14SimpleKeychainAAV5Auth0E11deleteEntry6forKeySbSS_tF","extendedModule":"SimpleKeychain","symbolKind":"method","title":"deleteEntry(forKey:)","role":"symbol","roleHeading":"Instance Method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"deleteEntry","kind":"identifier"},{"text":"(","kind":"text"},{"text":"forKey","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"modules":[{"name":"Auth0","relatedModules":["SimpleKeychain"]}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/deleteEntry(forKey:)","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain/deleteEntry(forKey:)":{"type":"topic","abstract":[{"type":"text","text":"Deletes a storage entry."}],"kind":"symbol","title":"deleteEntry(forKey:)","url":"\/documentation\/auth0\/simplekeychain\/simplekeychain\/deleteentry(forkey:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"deleteEntry"},{"kind":"text","text":"("},{"text":"forKey","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/deleteEntry(forKey:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain","type":"topic","title":"SimpleKeychain","role":"collection","kind":"symbol","abstract":[],"url":"\/documentation\/auth0\/simplekeychain"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage":{"title":"CredentialsStorage","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","role":"symbol","kind":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsStorage","kind":"identifier"}],"abstract":[{"text":"Generic storage API for storing credentials.","type":"text"}],"url":"\/documentation\/auth0\/credentialsstorage","navigatorTitle":[{"text":"CredentialsStorage","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain":{"type":"topic","title":"SimpleKeychain","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain","kind":"symbol","url":"\/documentation\/auth0\/simplekeychain\/simplekeychain","abstract":[{"type":"text","text":"Conformance to "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","isActive":true},{"type":"text","text":"."}],"role":"symbol","fragments":[{"kind":"keyword","text":"extension"},{"kind":"text","text":" "},{"kind":"identifier","preciseIdentifier":"s:14SimpleKeychainAAV","text":"SimpleKeychain"}],"navigatorTitle":[{"kind":"identifier","text":"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 87a6874e0..2ac8ad773 100644 --- a/docs/data/documentation/auth0/simplekeychain/simplekeychain/getentry(forkey:).json +++ b/docs/data/documentation/auth0/simplekeychain/simplekeychain/getentry(forkey:).json @@ -1 +1 @@ -{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/getEntry(forKey:)"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/simplekeychain\/simplekeychain\/getentry(forkey:)"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getEntry"},{"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:10Foundation4DataV","text":"Data"},{"kind":"text","text":"?"}],"languages":["swift"]}]},{"parameters":[{"name":"key","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The key to get from the Keychain."}]}]}],"kind":"parameters"},{"kind":"content","content":[{"type":"heading","level":2,"text":"Return Value","anchor":"return-value"},{"type":"paragraph","inlineContent":[{"text":"The stored data.","type":"text"}]}]}],"metadata":{"title":"getEntry(forKey:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getEntry"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV","text":"Data"},{"kind":"text","text":"?"}],"externalID":"s:14SimpleKeychainAAV5Auth0E8getEntry6forKey10Foundation4DataVSgSS_tF","modules":[{"relatedModules":["SimpleKeychain"],"name":"Auth0"}],"role":"symbol","roleHeading":"Instance Method","extendedModule":"SimpleKeychain","symbolKind":"method"},"kind":"symbol","sections":[],"schemaVersion":{"patch":0,"major":0,"minor":3},"abstract":[{"text":"Retrieves a storage entry.","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain":{"type":"topic","title":"SimpleKeychain","url":"\/documentation\/auth0\/simplekeychain","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain","role":"collection","abstract":[],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage":{"title":"CredentialsStorage","kind":"symbol","navigatorTitle":[{"text":"CredentialsStorage","kind":"identifier"}],"role":"symbol","url":"\/documentation\/auth0\/credentialsstorage","abstract":[{"text":"Generic storage API for storing credentials.","type":"text"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsStorage","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain":{"type":"topic","fragments":[{"kind":"keyword","text":"extension"},{"kind":"text","text":" "},{"preciseIdentifier":"s:14SimpleKeychainAAV","kind":"identifier","text":"SimpleKeychain"}],"title":"SimpleKeychain","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain","navigatorTitle":[{"kind":"identifier","text":"SimpleKeychain"}],"url":"\/documentation\/auth0\/simplekeychain\/simplekeychain","abstract":[{"type":"text","text":"Conformance to "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","isActive":true},{"type":"text","text":"."}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain/getEntry(forKey:)":{"url":"\/documentation\/auth0\/simplekeychain\/simplekeychain\/getentry(forkey:)","title":"getEntry(forKey:)","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/getEntry(forKey:)","kind":"symbol","abstract":[{"type":"text","text":"Retrieves a storage entry."}],"type":"topic","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getEntry","kind":"identifier"},{"text":"(","kind":"text"},{"text":"forKey","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"Data","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV"},{"text":"?","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"abstract":[{"text":"Retrieves a storage entry.","type":"text"}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getEntry"},{"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:10Foundation4DataV","text":"Data"},{"kind":"text","text":"?"}],"platforms":["iOS"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"text":"The key to get from the Keychain.","type":"text"}],"type":"paragraph"}],"name":"key"}]},{"content":[{"level":2,"text":"Return Value","type":"heading","anchor":"return-value"},{"inlineContent":[{"type":"text","text":"The stored data."}],"type":"paragraph"}],"kind":"content"}],"variants":[{"paths":["\/documentation\/auth0\/simplekeychain\/simplekeychain\/getentry(forkey:)"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"minor":3,"major":0,"patch":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain"]]},"metadata":{"modules":[{"name":"Auth0","relatedModules":["SimpleKeychain"]}],"title":"getEntry(forKey:)","roleHeading":"Instance Method","symbolKind":"method","role":"symbol","extendedModule":"SimpleKeychain","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getEntry"},{"kind":"text","text":"("},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"?"}],"externalID":"s:14SimpleKeychainAAV5Auth0E8getEntry6forKey10Foundation4DataVSgSS_tF"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/getEntry(forKey:)"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain","type":"topic","title":"SimpleKeychain","role":"collection","kind":"symbol","abstract":[],"url":"\/documentation\/auth0\/simplekeychain"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain/getEntry(forKey:)":{"type":"topic","abstract":[{"type":"text","text":"Retrieves a storage entry."}],"kind":"symbol","title":"getEntry(forKey:)","url":"\/documentation\/auth0\/simplekeychain\/simplekeychain\/getentry(forkey:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getEntry","kind":"identifier"},{"text":"(","kind":"text"},{"text":"forKey","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:10Foundation4DataV","text":"Data","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/getEntry(forKey:)"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain":{"type":"topic","title":"SimpleKeychain","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain","kind":"symbol","url":"\/documentation\/auth0\/simplekeychain\/simplekeychain","abstract":[{"type":"text","text":"Conformance to "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","isActive":true},{"type":"text","text":"."}],"role":"symbol","fragments":[{"kind":"keyword","text":"extension"},{"kind":"text","text":" "},{"kind":"identifier","preciseIdentifier":"s:14SimpleKeychainAAV","text":"SimpleKeychain"}],"navigatorTitle":[{"kind":"identifier","text":"SimpleKeychain"}]},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage":{"title":"CredentialsStorage","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","role":"symbol","kind":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsStorage","kind":"identifier"}],"abstract":[{"text":"Generic storage API for storing credentials.","type":"text"}],"url":"\/documentation\/auth0\/credentialsstorage","navigatorTitle":[{"text":"CredentialsStorage","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ 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 25fab2064..7cec6649e 100644 --- a/docs/data/documentation/auth0/simplekeychain/simplekeychain/setentry(_:forkey:).json +++ b/docs/data/documentation/auth0/simplekeychain/simplekeychain/setentry(_:forkey:).json @@ -1 +1 @@ -{"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain"]]},"abstract":[{"text":"Sets a storage entry.","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"setEntry"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"data"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":" "},{"kind":"internalParam","text":"key"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"platforms":["iOS"]}]},{"kind":"parameters","parameters":[{"name":"data","content":[{"inlineContent":[{"type":"text","text":"The data to be stored."}],"type":"paragraph"}]},{"name":"key","content":[{"inlineContent":[{"text":"The key to store it to.","type":"text"}],"type":"paragraph"}]}]},{"kind":"content","content":[{"level":2,"text":"Return Value","anchor":"return-value","type":"heading"},{"inlineContent":[{"text":"If the data was stored.","type":"text"}],"type":"paragraph"}]}],"metadata":{"roleHeading":"Instance Method","modules":[{"name":"Auth0","relatedModules":["SimpleKeychain"]}],"symbolKind":"method","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"setEntry"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"externalID":"s:14SimpleKeychainAAV5Auth0E8setEntry_6forKeySb10Foundation4DataV_SStF","title":"setEntry(_:forKey:)","extendedModule":"SimpleKeychain"},"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/setEntry(_:forKey:)"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/simplekeychain\/simplekeychain\/setentry(_:forkey:)"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage":{"title":"CredentialsStorage","kind":"symbol","navigatorTitle":[{"text":"CredentialsStorage","kind":"identifier"}],"role":"symbol","url":"\/documentation\/auth0\/credentialsstorage","abstract":[{"text":"Generic storage API for storing credentials.","type":"text"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsStorage","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain":{"type":"topic","title":"SimpleKeychain","url":"\/documentation\/auth0\/simplekeychain","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain","role":"collection","abstract":[],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain/setEntry(_:forKey:)":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/setEntry(_:forKey:)","type":"topic","title":"setEntry(_:forKey:)","url":"\/documentation\/auth0\/simplekeychain\/simplekeychain\/setentry(_:forkey:)","kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"setEntry"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"forKey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"abstract":[{"type":"text","text":"Sets a storage entry."}]},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain":{"type":"topic","fragments":[{"kind":"keyword","text":"extension"},{"kind":"text","text":" "},{"preciseIdentifier":"s:14SimpleKeychainAAV","kind":"identifier","text":"SimpleKeychain"}],"title":"SimpleKeychain","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain","navigatorTitle":[{"kind":"identifier","text":"SimpleKeychain"}],"url":"\/documentation\/auth0\/simplekeychain\/simplekeychain","abstract":[{"type":"text","text":"Conformance to "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","isActive":true},{"type":"text","text":"."}],"kind":"symbol"}}} \ No newline at end of file +{"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"kind":"declarations","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"},{"text":": ","kind":"text"},{"text":"Data","preciseIdentifier":"s:10Foundation4DataV","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"forKey","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"key","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"languages":["swift"],"platforms":["iOS"]}]},{"parameters":[{"name":"data","content":[{"inlineContent":[{"text":"The data to be stored.","type":"text"}],"type":"paragraph"}]},{"name":"key","content":[{"inlineContent":[{"text":"The key to store it to.","type":"text"}],"type":"paragraph"}]}],"kind":"parameters"},{"kind":"content","content":[{"type":"heading","text":"Return Value","anchor":"return-value","level":2},{"type":"paragraph","inlineContent":[{"text":"If the data was stored.","type":"text"}]}]}],"sections":[],"abstract":[{"type":"text","text":"Sets a storage entry."}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/simplekeychain\/simplekeychain\/setentry(_:forkey:)"]}],"metadata":{"role":"symbol","title":"setEntry(_:forKey:)","modules":[{"relatedModules":["SimpleKeychain"],"name":"Auth0"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"setEntry","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:10Foundation4DataV","text":"Data","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"forKey","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"externalID":"s:14SimpleKeychainAAV5Auth0E8setEntry_6forKeySb10Foundation4DataV_SStF","extendedModule":"SimpleKeychain","roleHeading":"Instance Method","symbolKind":"method"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/setEntry(_:forKey:)","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain","type":"topic","title":"SimpleKeychain","role":"collection","kind":"symbol","abstract":[],"url":"\/documentation\/auth0\/simplekeychain"},"doc://com.auth0.Auth0/documentation/Auth0/CredentialsStorage":{"title":"CredentialsStorage","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","role":"symbol","kind":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CredentialsStorage","kind":"identifier"}],"abstract":[{"text":"Generic storage API for storing credentials.","type":"text"}],"url":"\/documentation\/auth0\/credentialsstorage","navigatorTitle":[{"text":"CredentialsStorage","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain/setEntry(_:forKey:)":{"type":"topic","abstract":[{"type":"text","text":"Sets a storage entry."}],"kind":"symbol","title":"setEntry(_:forKey:)","url":"\/documentation\/auth0\/simplekeychain\/simplekeychain\/setentry(_:forkey:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"setEntry","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:10Foundation4DataV","text":"Data","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"forKey","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain\/setEntry(_:forKey:)"},"doc://com.auth0.Auth0/documentation/Auth0/SimpleKeychain/SimpleKeychain":{"type":"topic","title":"SimpleKeychain","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SimpleKeychain\/SimpleKeychain","kind":"symbol","url":"\/documentation\/auth0\/simplekeychain\/simplekeychain","abstract":[{"type":"text","text":"Conformance to "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/CredentialsStorage","isActive":true},{"type":"text","text":"."}],"role":"symbol","fragments":[{"kind":"keyword","text":"extension"},{"kind":"text","text":" "},{"kind":"identifier","preciseIdentifier":"s:14SimpleKeychainAAV","text":"SimpleKeychain"}],"navigatorTitle":[{"kind":"identifier","text":"SimpleKeychain"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/ssocredentials.json b/docs/data/documentation/auth0/ssocredentials.json index e1968daf8..75f1f9e9c 100644 --- a/docs/data/documentation/auth0/ssocredentials.json +++ b/docs/data/documentation/auth0/ssocredentials.json @@ -1 +1 @@ -{"kind":"symbol","abstract":[{"text":"Credentials obtained from Auth0 to perform web single sign-on (SSO).","type":"text"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials"},"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/init(sessionTransferToken:issuedTokenType:expiresIn:idToken:refreshToken:)"],"anchor":"Initializers","title":"Initializers","generated":true},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/description","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/expiresIn","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/idToken","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/issuedTokenType","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/refreshToken","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/sessionTransferToken"],"anchor":"Instance-Properties","title":"Instance Properties","generated":true},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/Decodable-Implementations","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/Encodable-Implementations"],"anchor":"Default-Implementations","title":"Default Implementations","generated":true}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"metadata":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"SSOCredentials","kind":"identifier"}],"symbolKind":"struct","title":"SSOCredentials","modules":[{"name":"Auth0"}],"navigatorTitle":[{"kind":"identifier","text":"SSOCredentials"}],"externalID":"s:5Auth014SSOCredentialsV","role":"symbol","roleHeading":"Structure"},"relationshipsSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/s8CopyableP","doc:\/\/com.auth0.Auth0\/s23CustomStringConvertibleP","doc:\/\/com.auth0.Auth0\/Se","doc:\/\/com.auth0.Auth0\/SE"],"type":"conformsTo","kind":"relationships","title":"Conforms To"}],"primaryContentSections":[{"declarations":[{"tokens":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"SSOCredentials","kind":"identifier"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"variants":[{"paths":["\/documentation\/auth0\/ssocredentials"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/SSOCredentials":{"url":"\/documentation\/auth0\/ssocredentials","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"SSOCredentials","kind":"identifier"}],"abstract":[{"type":"text","text":"Credentials obtained from Auth0 to perform web single sign-on (SSO)."}],"role":"symbol","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials","title":"SSOCredentials","type":"topic","navigatorTitle":[{"text":"SSOCredentials","kind":"identifier"}]},"doc://com.auth0.Auth0/Se":{"type":"unresolvable","title":"Swift.Decodable","identifier":"doc:\/\/com.auth0.Auth0\/Se"},"doc://com.auth0.Auth0/documentation/Auth0/SSOCredentials/init(sessionTransferToken:issuedTokenType:expiresIn:idToken:refreshToken:)":{"url":"\/documentation\/auth0\/ssocredentials\/init(sessiontransfertoken:issuedtokentype:expiresin:idtoken:refreshtoken:)","kind":"symbol","abstract":[{"text":"Default initializer.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/init(sessionTransferToken:issuedTokenType:expiresIn:idToken:refreshToken:)","title":"init(sessionTransferToken:issuedTokenType:expiresIn:idToken:refreshToken:)","type":"topic","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"sessionTransferToken","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"issuedTokenType","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"expiresIn","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation4DateV","text":"Date","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"idToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"refreshToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?)"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/SSOCredentials/expiresIn":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/expiresIn","abstract":[{"text":"When the session transfer token expires.","type":"text"}],"kind":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"expiresIn","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation4DateV","text":"Date","kind":"typeIdentifier"}],"role":"symbol","url":"\/documentation\/auth0\/ssocredentials\/expiresin","type":"topic","title":"expiresIn"},"doc://com.auth0.Auth0/SE":{"type":"unresolvable","title":"Swift.Encodable","identifier":"doc:\/\/com.auth0.Auth0\/SE"},"doc://com.auth0.Auth0/documentation/Auth0/SSOCredentials/issuedTokenType":{"title":"issuedTokenType","abstract":[{"text":"Type of the session transfer token.","type":"text"}],"type":"topic","url":"\/documentation\/auth0\/ssocredentials\/issuedtokentype","role":"symbol","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/issuedTokenType","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"issuedTokenType","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/SSOCredentials/Encodable-Implementations":{"role":"collectionGroup","abstract":[],"title":"Encodable Implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/Encodable-Implementations","kind":"article","url":"\/documentation\/auth0\/ssocredentials\/encodable-implementations","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/s23CustomStringConvertibleP":{"type":"unresolvable","title":"Swift.CustomStringConvertible","identifier":"doc:\/\/com.auth0.Auth0\/s23CustomStringConvertibleP"},"doc://com.auth0.Auth0/s8CopyableP":{"type":"unresolvable","title":"Swift.Copyable","identifier":"doc:\/\/com.auth0.Auth0\/s8CopyableP"},"doc://com.auth0.Auth0/documentation/Auth0/SSOCredentials/refreshToken":{"role":"symbol","type":"topic","url":"\/documentation\/auth0\/ssocredentials\/refreshtoken","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/refreshToken","abstract":[{"type":"text","text":"Rotated refresh token. Only available when Refresh Token Rotation is enabled."}],"title":"refreshToken","kind":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"refreshToken","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/SSOCredentials/idToken":{"role":"symbol","url":"\/documentation\/auth0\/ssocredentials\/idtoken","abstract":[{"text":"Token that contains the user information.","type":"text"}],"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/idToken","title":"idToken","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"idToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}]},"doc://com.auth0.Auth0/documentation/Auth0/SSOCredentials/description":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/description","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"description"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"title":"description","type":"topic","url":"\/documentation\/auth0\/ssocredentials\/description","kind":"symbol","abstract":[{"text":"Custom description that redacts the tokens with ","type":"text"},{"type":"codeVoice","code":""},{"text":".","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/SSOCredentials/Decodable-Implementations":{"role":"collectionGroup","abstract":[],"title":"Decodable Implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/Decodable-Implementations","kind":"article","url":"\/documentation\/auth0\/ssocredentials\/decodable-implementations","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/SSOCredentials/sessionTransferToken":{"type":"topic","url":"\/documentation\/auth0\/ssocredentials\/sessiontransfertoken","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/sessionTransferToken","abstract":[{"text":"Token that can be used to request a web session.","type":"text"}],"title":"sessionTransferToken","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"sessionTransferToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"kind":"symbol","role":"symbol"}}} \ No newline at end of file +{"topicSections":[{"generated":true,"title":"Initializers","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/init(sessionTransferToken:issuedTokenType:expiresIn:idToken:refreshToken:)"],"anchor":"Initializers"},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/description","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/expiresIn","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/idToken","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/issuedTokenType","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/refreshToken","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/sessionTransferToken"],"generated":true,"title":"Instance Properties","anchor":"Instance-Properties"},{"generated":true,"title":"Default Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/Decodable-Implementations","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/Encodable-Implementations"],"anchor":"Default-Implementations"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"relationshipsSections":[{"type":"conformsTo","identifiers":["doc:\/\/com.auth0.Auth0\/s8CopyableP","doc:\/\/com.auth0.Auth0\/s23CustomStringConvertibleP","doc:\/\/com.auth0.Auth0\/Se","doc:\/\/com.auth0.Auth0\/SE"],"kind":"relationships","title":"Conforms To"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"SSOCredentials"}]}]}],"sections":[],"abstract":[{"type":"text","text":"Credentials obtained from Auth0 to perform web single sign-on (SSO)."}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/ssocredentials"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials"},"metadata":{"role":"symbol","title":"SSOCredentials","modules":[{"name":"Auth0"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"SSOCredentials","kind":"identifier"}],"externalID":"s:5Auth014SSOCredentialsV","navigatorTitle":[{"kind":"identifier","text":"SSOCredentials"}],"roleHeading":"Structure","symbolKind":"struct"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"references":{"doc://com.auth0.Auth0/s23CustomStringConvertibleP":{"title":"Swift.CustomStringConvertible","identifier":"doc:\/\/com.auth0.Auth0\/s23CustomStringConvertibleP","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/SSOCredentials/idToken":{"url":"\/documentation\/auth0\/ssocredentials\/idtoken","title":"idToken","abstract":[{"type":"text","text":"Token that contains the user information."}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"idToken"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/idToken","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/SSOCredentials/refreshToken":{"type":"topic","abstract":[{"type":"text","text":"Rotated refresh token. Only available when Refresh Token Rotation is enabled."}],"kind":"symbol","url":"\/documentation\/auth0\/ssocredentials\/refreshtoken","title":"refreshToken","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"refreshToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/refreshToken"},"doc://com.auth0.Auth0/documentation/Auth0/SSOCredentials/init(sessionTransferToken:issuedTokenType:expiresIn:idToken:refreshToken:)":{"title":"init(sessionTransferToken:issuedTokenType:expiresIn:idToken:refreshToken:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/init(sessionTransferToken:issuedTokenType:expiresIn:idToken:refreshToken:)","type":"topic","role":"symbol","kind":"symbol","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"sessionTransferToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"issuedTokenType"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"expiresIn"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"idToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"refreshToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?)"}],"abstract":[{"type":"text","text":"Default initializer."}],"url":"\/documentation\/auth0\/ssocredentials\/init(sessiontransfertoken:issuedtokentype:expiresin:idtoken:refreshtoken:)"},"doc://com.auth0.Auth0/documentation/Auth0/SSOCredentials/Encodable-Implementations":{"role":"collectionGroup","title":"Encodable Implementations","abstract":[],"kind":"article","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/Encodable-Implementations","url":"\/documentation\/auth0\/ssocredentials\/encodable-implementations","type":"topic"},"doc://com.auth0.Auth0/Se":{"type":"unresolvable","title":"Swift.Decodable","identifier":"doc:\/\/com.auth0.Auth0\/Se"},"doc://com.auth0.Auth0/SE":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/SE","title":"Swift.Encodable"},"doc://com.auth0.Auth0/documentation/Auth0/SSOCredentials/expiresIn":{"role":"symbol","title":"expiresIn","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"expiresIn","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"}],"abstract":[{"text":"When the session transfer token expires.","type":"text"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/expiresIn","url":"\/documentation\/auth0\/ssocredentials\/expiresin","type":"topic"},"doc://com.auth0.Auth0/s8CopyableP":{"title":"Swift.Copyable","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s8CopyableP"},"doc://com.auth0.Auth0/documentation/Auth0/SSOCredentials/issuedTokenType":{"type":"topic","abstract":[{"type":"text","text":"Type of the session transfer token."}],"title":"issuedTokenType","url":"\/documentation\/auth0\/ssocredentials\/issuedtokentype","kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"issuedTokenType"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/issuedTokenType"},"doc://com.auth0.Auth0/documentation/Auth0/SSOCredentials/Decodable-Implementations":{"role":"collectionGroup","title":"Decodable Implementations","abstract":[],"kind":"article","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/Decodable-Implementations","url":"\/documentation\/auth0\/ssocredentials\/decodable-implementations","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/SSOCredentials/description":{"kind":"symbol","title":"description","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"description","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/description","abstract":[{"type":"text","text":"Custom description that redacts the tokens with "},{"type":"codeVoice","code":""},{"type":"text","text":"."}],"url":"\/documentation\/auth0\/ssocredentials\/description"},"doc://com.auth0.Auth0/documentation/Auth0/SSOCredentials/sessionTransferToken":{"type":"topic","title":"sessionTransferToken","url":"\/documentation\/auth0\/ssocredentials\/sessiontransfertoken","kind":"symbol","abstract":[{"text":"Token that can be used to request a web session.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/sessionTransferToken","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"sessionTransferToken","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/SSOCredentials":{"title":"SSOCredentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials","navigatorTitle":[{"kind":"identifier","text":"SSOCredentials"}],"url":"\/documentation\/auth0\/ssocredentials","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"SSOCredentials"}],"abstract":[{"type":"text","text":"Credentials obtained from Auth0 to perform web single sign-on (SSO)."}],"kind":"symbol","role":"symbol","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/ssocredentials/decodable-implementations.json b/docs/data/documentation/auth0/ssocredentials/decodable-implementations.json index 58397dc28..1bf9f514c 100644 --- a/docs/data/documentation/auth0/ssocredentials/decodable-implementations.json +++ b/docs/data/documentation/auth0/ssocredentials/decodable-implementations.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials"]]},"schemaVersion":{"minor":3,"patch":0,"major":0},"topicSections":[{"generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/init(from:)"],"title":"Initializers","anchor":"Initializers"}],"metadata":{"modules":[{"name":"Auth0"}],"roleHeading":"API Collection","title":"Decodable Implementations","role":"collectionGroup"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/Decodable-Implementations"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/ssocredentials\/decodable-implementations"]}],"kind":"article","references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/SSOCredentials":{"url":"\/documentation\/auth0\/ssocredentials","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"SSOCredentials","kind":"identifier"}],"abstract":[{"type":"text","text":"Credentials obtained from Auth0 to perform web single sign-on (SSO)."}],"role":"symbol","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials","title":"SSOCredentials","type":"topic","navigatorTitle":[{"text":"SSOCredentials","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/SSOCredentials/init(from:)":{"kind":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/init(from:)","url":"\/documentation\/auth0\/ssocredentials\/init(from:)","title":"init(from:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP","text":"Decoder"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"abstract":[{"type":"codeVoice","code":"Decodable"},{"type":"text","text":" initializer."}],"role":"symbol"}}} \ No newline at end of file +{"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/init(from:)"],"title":"Initializers","generated":true,"anchor":"Initializers"}],"schemaVersion":{"patch":0,"major":0,"minor":3},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/ssocredentials\/decodable-implementations"]}],"kind":"article","metadata":{"modules":[{"name":"Auth0"}],"roleHeading":"API Collection","role":"collectionGroup","title":"Decodable Implementations"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/Decodable-Implementations","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/SSOCredentials":{"title":"SSOCredentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials","navigatorTitle":[{"kind":"identifier","text":"SSOCredentials"}],"url":"\/documentation\/auth0\/ssocredentials","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"SSOCredentials"}],"abstract":[{"type":"text","text":"Credentials obtained from Auth0 to perform web single sign-on (SSO)."}],"kind":"symbol","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/SSOCredentials/init(from:)":{"role":"symbol","title":"init(from:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP","text":"Decoder"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"abstract":[{"type":"codeVoice","code":"Decodable"},{"type":"text","text":" initializer."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/init(from:)","url":"\/documentation\/auth0\/ssocredentials\/init(from:)","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/ssocredentials/description.json b/docs/data/documentation/auth0/ssocredentials/description.json index 378293cd7..b9a18f917 100644 --- a/docs/data/documentation/auth0/ssocredentials/description.json +++ b/docs/data/documentation/auth0/ssocredentials/description.json @@ -1 +1 @@ -{"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"description","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}]}],"kind":"declarations"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/ssocredentials\/description"]}],"kind":"symbol","sections":[],"schemaVersion":{"major":0,"patch":0,"minor":3},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/description","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Custom description that redacts the tokens with "},{"code":"","type":"codeVoice"},{"type":"text","text":"."}],"metadata":{"modules":[{"name":"Auth0"}],"role":"symbol","symbolKind":"property","title":"description","roleHeading":"Instance Property","externalID":"s:5Auth014SSOCredentialsV11descriptionSSvp","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"description","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}]},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/SSOCredentials":{"url":"\/documentation\/auth0\/ssocredentials","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"SSOCredentials","kind":"identifier"}],"abstract":[{"type":"text","text":"Credentials obtained from Auth0 to perform web single sign-on (SSO)."}],"role":"symbol","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials","title":"SSOCredentials","type":"topic","navigatorTitle":[{"text":"SSOCredentials","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/SSOCredentials/description":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/description","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"description"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"title":"description","type":"topic","url":"\/documentation\/auth0\/ssocredentials\/description","kind":"symbol","abstract":[{"text":"Custom description that redacts the tokens with ","type":"text"},{"type":"codeVoice","code":""},{"text":".","type":"text"}]}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/ssocredentials\/description"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials"]]},"abstract":[{"type":"text","text":"Custom description that redacts the tokens with "},{"type":"codeVoice","code":""},{"type":"text","text":"."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"description","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}]}]}],"kind":"symbol","sections":[],"schemaVersion":{"patch":0,"minor":3,"major":0},"metadata":{"roleHeading":"Instance Property","symbolKind":"property","title":"description","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"description"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"externalID":"s:5Auth014SSOCredentialsV11descriptionSSvp","modules":[{"name":"Auth0"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/description","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/SSOCredentials/description":{"kind":"symbol","title":"description","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"description","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/description","abstract":[{"type":"text","text":"Custom description that redacts the tokens with "},{"type":"codeVoice","code":""},{"type":"text","text":"."}],"url":"\/documentation\/auth0\/ssocredentials\/description"},"doc://com.auth0.Auth0/documentation/Auth0/SSOCredentials":{"title":"SSOCredentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials","navigatorTitle":[{"kind":"identifier","text":"SSOCredentials"}],"url":"\/documentation\/auth0\/ssocredentials","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"SSOCredentials"}],"abstract":[{"type":"text","text":"Credentials obtained from Auth0 to perform web single sign-on (SSO)."}],"kind":"symbol","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/ssocredentials/encodable-implementations.json b/docs/data/documentation/auth0/ssocredentials/encodable-implementations.json index e2abbff23..aec35b563 100644 --- a/docs/data/documentation/auth0/ssocredentials/encodable-implementations.json +++ b/docs/data/documentation/auth0/ssocredentials/encodable-implementations.json @@ -1 +1 @@ -{"metadata":{"title":"Encodable Implementations","roleHeading":"API Collection","modules":[{"name":"Auth0"}],"role":"collectionGroup"},"schemaVersion":{"patch":0,"major":0,"minor":3},"topicSections":[{"title":"Instance Methods","anchor":"Instance-Methods","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/encode(to:)"],"generated":true}],"variants":[{"paths":["\/documentation\/auth0\/ssocredentials\/encodable-implementations"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/Encodable-Implementations","interfaceLanguage":"swift"},"kind":"article","sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/SSOCredentials/encode(to:)":{"url":"\/documentation\/auth0\/ssocredentials\/encode(to:)","title":"encode(to:)","kind":"symbol","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"encode","kind":"identifier"},{"text":"(","kind":"text"},{"text":"to","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:s7EncoderP","text":"Encoder","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/encode(to:)","abstract":[{"type":"codeVoice","code":"Encodable"},{"text":" initializer.","type":"text"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/SSOCredentials":{"url":"\/documentation\/auth0\/ssocredentials","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"SSOCredentials","kind":"identifier"}],"abstract":[{"type":"text","text":"Credentials obtained from Auth0 to perform web single sign-on (SSO)."}],"role":"symbol","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials","title":"SSOCredentials","type":"topic","navigatorTitle":[{"text":"SSOCredentials","kind":"identifier"}]}}} \ No newline at end of file +{"kind":"article","topicSections":[{"generated":true,"title":"Instance Methods","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/encode(to:)"],"anchor":"Instance-Methods"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/ssocredentials\/encodable-implementations"]}],"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/Encodable-Implementations","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials"]]},"metadata":{"title":"Encodable Implementations","role":"collectionGroup","modules":[{"name":"Auth0"}],"roleHeading":"API Collection"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/SSOCredentials/encode(to:)":{"kind":"symbol","title":"encode(to:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"encode","kind":"identifier"},{"text":"(","kind":"text"},{"text":"to","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:s7EncoderP","text":"Encoder","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/encode(to:)","abstract":[{"type":"codeVoice","code":"Encodable"},{"type":"text","text":" initializer."}],"url":"\/documentation\/auth0\/ssocredentials\/encode(to:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/SSOCredentials":{"title":"SSOCredentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials","navigatorTitle":[{"kind":"identifier","text":"SSOCredentials"}],"url":"\/documentation\/auth0\/ssocredentials","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"SSOCredentials"}],"abstract":[{"type":"text","text":"Credentials obtained from Auth0 to perform web single sign-on (SSO)."}],"kind":"symbol","role":"symbol","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/ssocredentials/encode(to:).json b/docs/data/documentation/auth0/ssocredentials/encode(to:).json index 7a7799f40..e7ce6681b 100644 --- a/docs/data/documentation/auth0/ssocredentials/encode(to:).json +++ b/docs/data/documentation/auth0/ssocredentials/encode(to:).json @@ -1 +1 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/encode(to:)","interfaceLanguage":"swift"},"metadata":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"encode","kind":"identifier"},{"text":"(","kind":"text"},{"text":"to","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Encoder","kind":"typeIdentifier","preciseIdentifier":"s:s7EncoderP"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"externalID":"s:5Auth014SSOCredentialsV6encode2toys7Encoder_p_tKF","title":"encode(to:)","roleHeading":"Instance Method","modules":[{"name":"Auth0"}],"extendedModule":"Auth0","role":"symbol","symbolKind":"method"},"schemaVersion":{"major":0,"patch":0,"minor":3},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials"]]},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"encode"},{"kind":"text","text":"("},{"kind":"externalParam","text":"to"},{"kind":"text","text":" "},{"kind":"internalParam","text":"encoder"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Encoder","preciseIdentifier":"s:s7EncoderP"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}]}],"kind":"declarations"}],"variants":[{"paths":["\/documentation\/auth0\/ssocredentials\/encode(to:)"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","sections":[],"abstract":[{"type":"codeVoice","code":"Encodable"},{"type":"text","text":" initializer."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/SSOCredentials/encode(to:)":{"url":"\/documentation\/auth0\/ssocredentials\/encode(to:)","title":"encode(to:)","kind":"symbol","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"encode","kind":"identifier"},{"text":"(","kind":"text"},{"text":"to","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:s7EncoderP","text":"Encoder","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/encode(to:)","abstract":[{"type":"codeVoice","code":"Encodable"},{"text":" initializer.","type":"text"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/SSOCredentials":{"url":"\/documentation\/auth0\/ssocredentials","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"SSOCredentials","kind":"identifier"}],"abstract":[{"type":"text","text":"Credentials obtained from Auth0 to perform web single sign-on (SSO)."}],"role":"symbol","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials","title":"SSOCredentials","type":"topic","navigatorTitle":[{"text":"SSOCredentials","kind":"identifier"}]}}} \ No newline at end of file +{"kind":"symbol","primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"encode"},{"kind":"text","text":"("},{"kind":"externalParam","text":"to"},{"kind":"text","text":" "},{"kind":"internalParam","text":"encoder"},{"kind":"text","text":": "},{"text":"Encoder","preciseIdentifier":"s:s7EncoderP","kind":"typeIdentifier"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}]}],"kind":"declarations"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/ssocredentials\/encode(to:)"]}],"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/encode(to:)"},"abstract":[{"type":"codeVoice","code":"Encodable"},{"type":"text","text":" initializer."}],"metadata":{"roleHeading":"Instance Method","extendedModule":"Auth0","title":"encode(to:)","role":"symbol","symbolKind":"method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"encode"},{"kind":"text","text":"("},{"kind":"externalParam","text":"to"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:s7EncoderP","text":"Encoder"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"externalID":"s:5Auth014SSOCredentialsV6encode2toys7Encoder_p_tKF","modules":[{"name":"Auth0"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/SSOCredentials":{"title":"SSOCredentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials","navigatorTitle":[{"kind":"identifier","text":"SSOCredentials"}],"url":"\/documentation\/auth0\/ssocredentials","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"SSOCredentials"}],"abstract":[{"type":"text","text":"Credentials obtained from Auth0 to perform web single sign-on (SSO)."}],"kind":"symbol","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/SSOCredentials/encode(to:)":{"kind":"symbol","title":"encode(to:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"encode","kind":"identifier"},{"text":"(","kind":"text"},{"text":"to","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:s7EncoderP","text":"Encoder","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/encode(to:)","abstract":[{"type":"codeVoice","code":"Encodable"},{"type":"text","text":" initializer."}],"url":"\/documentation\/auth0\/ssocredentials\/encode(to:)"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/ssocredentials/expiresin.json b/docs/data/documentation/auth0/ssocredentials/expiresin.json index d7c43db44..d4840fc0d 100644 --- a/docs/data/documentation/auth0/ssocredentials/expiresin.json +++ b/docs/data/documentation/auth0/ssocredentials/expiresin.json @@ -1 +1 @@ -{"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"expiresIn","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Date","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DateV"}],"languages":["swift"]}]}],"sections":[],"metadata":{"externalID":"s:5Auth014SSOCredentialsV9expiresIn10Foundation4DateVvp","role":"symbol","roleHeading":"Instance Property","symbolKind":"property","modules":[{"name":"Auth0"}],"title":"expiresIn","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"expiresIn"},{"text":": ","kind":"text"},{"text":"Date","preciseIdentifier":"s:10Foundation4DateV","kind":"typeIdentifier"}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/expiresIn"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials"]]},"abstract":[{"type":"text","text":"When the session transfer token expires."}],"variants":[{"paths":["\/documentation\/auth0\/ssocredentials\/expiresin"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"references":{"doc://com.auth0.Auth0/documentation/Auth0/SSOCredentials":{"url":"\/documentation\/auth0\/ssocredentials","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"SSOCredentials","kind":"identifier"}],"abstract":[{"type":"text","text":"Credentials obtained from Auth0 to perform web single sign-on (SSO)."}],"role":"symbol","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials","title":"SSOCredentials","type":"topic","navigatorTitle":[{"text":"SSOCredentials","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/SSOCredentials/expiresIn":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/expiresIn","abstract":[{"text":"When the session transfer token expires.","type":"text"}],"kind":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"expiresIn","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation4DateV","text":"Date","kind":"typeIdentifier"}],"role":"symbol","url":"\/documentation\/auth0\/ssocredentials\/expiresin","type":"topic","title":"expiresIn"}}} \ No newline at end of file +{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/expiresIn"},"schemaVersion":{"minor":3,"major":0,"patch":0},"metadata":{"roleHeading":"Instance Property","symbolKind":"property","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"expiresIn"},{"kind":"text","text":": "},{"text":"Date","preciseIdentifier":"s:10Foundation4DateV","kind":"typeIdentifier"}],"modules":[{"name":"Auth0"}],"title":"expiresIn","externalID":"s:5Auth014SSOCredentialsV9expiresIn10Foundation4DateVvp"},"abstract":[{"type":"text","text":"When the session transfer token expires."}],"kind":"symbol","sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"expiresIn","kind":"identifier"},{"kind":"text","text":": "},{"text":"Date","preciseIdentifier":"s:10Foundation4DateV","kind":"typeIdentifier"}],"platforms":["iOS"],"languages":["swift"]}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials"]]},"variants":[{"paths":["\/documentation\/auth0\/ssocredentials\/expiresin"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/SSOCredentials":{"title":"SSOCredentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials","navigatorTitle":[{"kind":"identifier","text":"SSOCredentials"}],"url":"\/documentation\/auth0\/ssocredentials","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"SSOCredentials"}],"abstract":[{"type":"text","text":"Credentials obtained from Auth0 to perform web single sign-on (SSO)."}],"kind":"symbol","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"role":"collection","title":"Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","url":"\/documentation\/auth0","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/SSOCredentials/expiresIn":{"role":"symbol","title":"expiresIn","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"expiresIn","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"}],"abstract":[{"text":"When the session transfer token expires.","type":"text"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/expiresIn","url":"\/documentation\/auth0\/ssocredentials\/expiresin","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/ssocredentials/idtoken.json b/docs/data/documentation/auth0/ssocredentials/idtoken.json index 7f52dc3b4..065004b83 100644 --- a/docs/data/documentation/auth0/ssocredentials/idtoken.json +++ b/docs/data/documentation/auth0/ssocredentials/idtoken.json @@ -1 +1 @@ -{"schemaVersion":{"patch":0,"major":0,"minor":3},"seeAlsoSections":[{"title":"Related Documentation","anchor":"Related-Documentation","identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens","https:\/\/auth0.com\/docs\/secure\/tokens\/json-web-tokens","https:\/\/jwt.io"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/idToken"},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials"]]},"abstract":[{"type":"text","text":"Token that contains the user information."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"idToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"platforms":["iOS"]}]},{"kind":"content","content":[{"type":"heading","level":2,"anchor":"discussion","text":"Discussion"},{"style":"important","type":"aside","name":"Important","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"You must "},{"type":"reference","isActive":true,"identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens\/validate-id-tokens"},{"type":"text","text":" any ID"},{"type":"text","text":" "},{"type":"text","text":"tokens received from the Authentication API client before using the information they contain."}]}]}]}],"variants":[{"paths":["\/documentation\/auth0\/ssocredentials\/idtoken"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"externalID":"s:5Auth014SSOCredentialsV7idTokenSSvp","symbolKind":"property","modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","title":"idToken","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"idToken","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}]},"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"https://auth0.com/docs/secure/tokens/id-tokens/validate-id-tokens":{"title":"validate","titleInlineContent":[{"text":"validate","type":"text"}],"identifier":"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"},"https://auth0.com/docs/secure/tokens/json-web-tokens":{"url":"https:\/\/auth0.com\/docs\/secure\/tokens\/json-web-tokens","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/json-web-tokens","titleInlineContent":[{"text":"JSON Web Tokens","type":"text"}],"title":"JSON Web Tokens","type":"link"},"https://jwt.io":{"title":"jwt.io","titleInlineContent":[{"text":"jwt.io","type":"text"}],"identifier":"https:\/\/jwt.io","type":"link","url":"https:\/\/jwt.io"},"doc://com.auth0.Auth0/documentation/Auth0/SSOCredentials":{"url":"\/documentation\/auth0\/ssocredentials","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"SSOCredentials","kind":"identifier"}],"abstract":[{"type":"text","text":"Credentials obtained from Auth0 to perform web single sign-on (SSO)."}],"role":"symbol","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials","title":"SSOCredentials","type":"topic","navigatorTitle":[{"text":"SSOCredentials","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/SSOCredentials/idToken":{"role":"symbol","url":"\/documentation\/auth0\/ssocredentials\/idtoken","abstract":[{"text":"Token that contains the user information.","type":"text"}],"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/idToken","title":"idToken","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"idToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}]},"https://auth0.com/docs/secure/tokens/id-tokens":{"title":"ID Tokens","titleInlineContent":[{"text":"ID Tokens","type":"text"}],"identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens","type":"link","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens"}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/ssocredentials\/idtoken"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials"]]},"abstract":[{"text":"Token that contains the user information.","type":"text"}],"primaryContentSections":[{"declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"idToken","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"},{"content":[{"anchor":"discussion","level":2,"text":"Discussion","type":"heading"},{"content":[{"inlineContent":[{"text":"You must ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens\/validate-id-tokens"},{"text":" any ID","type":"text"},{"text":" ","type":"text"},{"text":"tokens received from the Authentication API client before using the information they contain.","type":"text"}],"type":"paragraph"}],"style":"important","name":"Important","type":"aside"}],"kind":"content"}],"sections":[],"schemaVersion":{"major":0,"patch":0,"minor":3},"kind":"symbol","seeAlsoSections":[{"anchor":"Related-Documentation","title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens","https:\/\/auth0.com\/docs\/secure\/tokens\/json-web-tokens","https:\/\/jwt.io"]}],"metadata":{"symbolKind":"property","modules":[{"name":"Auth0"}],"title":"idToken","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"idToken","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"externalID":"s:5Auth014SSOCredentialsV7idTokenSSvp","role":"symbol","roleHeading":"Instance Property"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/idToken","interfaceLanguage":"swift"},"references":{"https://auth0.com/docs/secure/tokens/json-web-tokens":{"title":"JSON Web Tokens","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/json-web-tokens","type":"link","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/json-web-tokens","titleInlineContent":[{"type":"text","text":"JSON Web Tokens"}]},"https://auth0.com/docs/secure/tokens/id-tokens/validate-id-tokens":{"title":"validate","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens\/validate-id-tokens","type":"link","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens\/validate-id-tokens","titleInlineContent":[{"type":"text","text":"validate"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/SSOCredentials":{"title":"SSOCredentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials","navigatorTitle":[{"kind":"identifier","text":"SSOCredentials"}],"url":"\/documentation\/auth0\/ssocredentials","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"SSOCredentials"}],"abstract":[{"type":"text","text":"Credentials obtained from Auth0 to perform web single sign-on (SSO)."}],"kind":"symbol","role":"symbol","type":"topic"},"https://jwt.io":{"title":"jwt.io","url":"https:\/\/jwt.io","type":"link","identifier":"https:\/\/jwt.io","titleInlineContent":[{"type":"text","text":"jwt.io"}]},"doc://com.auth0.Auth0/documentation/Auth0/SSOCredentials/idToken":{"url":"\/documentation\/auth0\/ssocredentials\/idtoken","title":"idToken","abstract":[{"type":"text","text":"Token that contains the user information."}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"idToken"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/idToken","role":"symbol","kind":"symbol","type":"topic"},"https://auth0.com/docs/secure/tokens/id-tokens":{"title":"ID Tokens","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens","type":"link","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/id-tokens","titleInlineContent":[{"type":"text","text":"ID Tokens"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/ssocredentials/init(from:).json b/docs/data/documentation/auth0/ssocredentials/init(from:).json index eb34d7f9e..f0a6c4e6d 100644 --- a/docs/data/documentation/auth0/ssocredentials/init(from:).json +++ b/docs/data/documentation/auth0/ssocredentials/init(from:).json @@ -1 +1 @@ -{"kind":"symbol","schemaVersion":{"major":0,"patch":0,"minor":3},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/init(from:)","interfaceLanguage":"swift"},"sections":[],"metadata":{"roleHeading":"Initializer","role":"symbol","title":"init(from:)","symbolKind":"init","externalID":"s:5Auth014SSOCredentialsV4fromACs7Decoder_p_tKcfc","extendedModule":"Auth0","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Decoder","kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"modules":[{"name":"Auth0"}]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/ssocredentials\/init(from:)"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials"]]},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":" "},{"kind":"internalParam","text":"decoder"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier","text":"Decoder"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"abstract":[{"code":"Decodable","type":"codeVoice"},{"type":"text","text":" initializer."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/SSOCredentials/init(from:)":{"kind":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/init(from:)","url":"\/documentation\/auth0\/ssocredentials\/init(from:)","title":"init(from:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP","text":"Decoder"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"abstract":[{"type":"codeVoice","code":"Decodable"},{"type":"text","text":" initializer."}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/SSOCredentials":{"url":"\/documentation\/auth0\/ssocredentials","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"SSOCredentials","kind":"identifier"}],"abstract":[{"type":"text","text":"Credentials obtained from Auth0 to perform web single sign-on (SSO)."}],"role":"symbol","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials","title":"SSOCredentials","type":"topic","navigatorTitle":[{"text":"SSOCredentials","kind":"identifier"}]}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/ssocredentials\/init(from:)"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials"]]},"abstract":[{"code":"Decodable","type":"codeVoice"},{"text":" initializer.","type":"text"}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":" "},{"kind":"internalParam","text":"decoder"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Decoder","preciseIdentifier":"s:s7DecoderP"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"platforms":["iOS"]}],"kind":"declarations"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","sections":[],"metadata":{"externalID":"s:5Auth014SSOCredentialsV4fromACs7Decoder_p_tKcfc","extendedModule":"Auth0","symbolKind":"init","title":"init(from:)","role":"symbol","roleHeading":"Initializer","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier","text":"Decoder"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"modules":[{"name":"Auth0"}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/init(from:)"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/SSOCredentials":{"title":"SSOCredentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials","navigatorTitle":[{"kind":"identifier","text":"SSOCredentials"}],"url":"\/documentation\/auth0\/ssocredentials","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"SSOCredentials"}],"abstract":[{"type":"text","text":"Credentials obtained from Auth0 to perform web single sign-on (SSO)."}],"kind":"symbol","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/SSOCredentials/init(from:)":{"role":"symbol","title":"init(from:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP","text":"Decoder"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"abstract":[{"type":"codeVoice","code":"Decodable"},{"type":"text","text":" initializer."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/init(from:)","url":"\/documentation\/auth0\/ssocredentials\/init(from:)","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/ssocredentials/init(sessiontransfertoken:issuedtokentype:expiresin:idtoken:refreshtoken:).json b/docs/data/documentation/auth0/ssocredentials/init(sessiontransfertoken:issuedtokentype:expiresin:idtoken:refreshtoken:).json index 712c4e07e..5262dab1e 100644 --- a/docs/data/documentation/auth0/ssocredentials/init(sessiontransfertoken:issuedtokentype:expiresin:idtoken:refreshtoken:).json +++ b/docs/data/documentation/auth0/ssocredentials/init(sessiontransfertoken:issuedtokentype:expiresin:idtoken:refreshtoken:).json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials"]]},"abstract":[{"type":"text","text":"Default initializer."}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/init(sessionTransferToken:issuedTokenType:expiresIn:idToken:refreshToken:)"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/ssocredentials\/init(sessiontransfertoken:issuedtokentype:expiresin:idtoken:refreshtoken:)"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","sections":[],"metadata":{"roleHeading":"Initializer","externalID":"s:5Auth014SSOCredentialsV20sessionTransferToken06issuedE4Type9expiresIn02idE007refreshE0ACSS_SS10Foundation4DateVS2SSgtcfc","title":"init(sessionTransferToken:issuedTokenType:expiresIn:idToken:refreshToken:)","role":"symbol","modules":[{"name":"Auth0"}],"fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"sessionTransferToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"issuedTokenType"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"expiresIn"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"idToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"refreshToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?)"}],"symbolKind":"init"},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"init","kind":"keyword"},{"text":"(","kind":"text"},{"text":"sessionTransferToken","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"issuedTokenType","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"expiresIn","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Date","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DateV"},{"text":", ","kind":"text"},{"text":"idToken","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"refreshToken","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"? = nil)","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/SSOCredentials/init(sessionTransferToken:issuedTokenType:expiresIn:idToken:refreshToken:)":{"url":"\/documentation\/auth0\/ssocredentials\/init(sessiontransfertoken:issuedtokentype:expiresin:idtoken:refreshtoken:)","kind":"symbol","abstract":[{"text":"Default initializer.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/init(sessionTransferToken:issuedTokenType:expiresIn:idToken:refreshToken:)","title":"init(sessionTransferToken:issuedTokenType:expiresIn:idToken:refreshToken:)","type":"topic","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"sessionTransferToken","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"issuedTokenType","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"expiresIn","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation4DateV","text":"Date","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"idToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"refreshToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?)"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/SSOCredentials":{"url":"\/documentation\/auth0\/ssocredentials","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"SSOCredentials","kind":"identifier"}],"abstract":[{"type":"text","text":"Credentials obtained from Auth0 to perform web single sign-on (SSO)."}],"role":"symbol","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials","title":"SSOCredentials","type":"topic","navigatorTitle":[{"text":"SSOCredentials","kind":"identifier"}]}}} \ No newline at end of file +{"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/init(sessionTransferToken:issuedTokenType:expiresIn:idToken:refreshToken:)"},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"sessionTransferToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"issuedTokenType"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"expiresIn"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DateV","text":"Date"},{"kind":"text","text":", "},{"kind":"externalParam","text":"idToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"refreshToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"? = nil)"}],"platforms":["iOS"],"languages":["swift"]}]}],"variants":[{"paths":["\/documentation\/auth0\/ssocredentials\/init(sessiontransfertoken:issuedtokentype:expiresin:idtoken:refreshtoken:)"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","metadata":{"externalID":"s:5Auth014SSOCredentialsV20sessionTransferToken06issuedE4Type9expiresIn02idE007refreshE0ACSS_SS10Foundation4DateVS2SSgtcfc","symbolKind":"init","title":"init(sessionTransferToken:issuedTokenType:expiresIn:idToken:refreshToken:)","roleHeading":"Initializer","role":"symbol","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"sessionTransferToken"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"issuedTokenType","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"expiresIn","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Date","preciseIdentifier":"s:10Foundation4DateV","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"idToken","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"refreshToken","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?)"}],"modules":[{"name":"Auth0"}]},"schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"type":"text","text":"Default initializer."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/SSOCredentials/init(sessionTransferToken:issuedTokenType:expiresIn:idToken:refreshToken:)":{"title":"init(sessionTransferToken:issuedTokenType:expiresIn:idToken:refreshToken:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/init(sessionTransferToken:issuedTokenType:expiresIn:idToken:refreshToken:)","type":"topic","role":"symbol","kind":"symbol","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"sessionTransferToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"issuedTokenType"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"expiresIn"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"idToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"refreshToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?)"}],"abstract":[{"type":"text","text":"Default initializer."}],"url":"\/documentation\/auth0\/ssocredentials\/init(sessiontransfertoken:issuedtokentype:expiresin:idtoken:refreshtoken:)"},"doc://com.auth0.Auth0/documentation/Auth0/SSOCredentials":{"title":"SSOCredentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials","navigatorTitle":[{"kind":"identifier","text":"SSOCredentials"}],"url":"\/documentation\/auth0\/ssocredentials","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"SSOCredentials"}],"abstract":[{"type":"text","text":"Credentials obtained from Auth0 to perform web single sign-on (SSO)."}],"kind":"symbol","role":"symbol","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/ssocredentials/issuedtokentype.json b/docs/data/documentation/auth0/ssocredentials/issuedtokentype.json index 99bc0622d..3c4162c89 100644 --- a/docs/data/documentation/auth0/ssocredentials/issuedtokentype.json +++ b/docs/data/documentation/auth0/ssocredentials/issuedtokentype.json @@ -1 +1 @@ -{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/issuedTokenType"},"metadata":{"role":"symbol","title":"issuedTokenType","roleHeading":"Instance Property","externalID":"s:5Auth014SSOCredentialsV15issuedTokenTypeSSvp","modules":[{"name":"Auth0"}],"symbolKind":"property","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"issuedTokenType","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}]},"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"issuedTokenType","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}]}]}],"abstract":[{"type":"text","text":"Type of the session transfer token."}],"variants":[{"paths":["\/documentation\/auth0\/ssocredentials\/issuedtokentype"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials"]]},"schemaVersion":{"minor":3,"patch":0,"major":0},"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/SSOCredentials":{"url":"\/documentation\/auth0\/ssocredentials","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"SSOCredentials","kind":"identifier"}],"abstract":[{"type":"text","text":"Credentials obtained from Auth0 to perform web single sign-on (SSO)."}],"role":"symbol","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials","title":"SSOCredentials","type":"topic","navigatorTitle":[{"text":"SSOCredentials","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/SSOCredentials/issuedTokenType":{"title":"issuedTokenType","abstract":[{"text":"Type of the session transfer token.","type":"text"}],"type":"topic","url":"\/documentation\/auth0\/ssocredentials\/issuedtokentype","role":"symbol","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/issuedTokenType","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"issuedTokenType","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}]}}} \ No newline at end of file +{"abstract":[{"text":"Type of the session transfer token.","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"issuedTokenType","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"platforms":["iOS"]}]}],"variants":[{"paths":["\/documentation\/auth0\/ssocredentials\/issuedtokentype"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials"]]},"metadata":{"externalID":"s:5Auth014SSOCredentialsV15issuedTokenTypeSSvp","symbolKind":"property","title":"issuedTokenType","roleHeading":"Instance Property","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"issuedTokenType","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"modules":[{"name":"Auth0"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/issuedTokenType","interfaceLanguage":"swift"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/SSOCredentials/issuedTokenType":{"type":"topic","abstract":[{"type":"text","text":"Type of the session transfer token."}],"title":"issuedTokenType","url":"\/documentation\/auth0\/ssocredentials\/issuedtokentype","kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"issuedTokenType"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/issuedTokenType"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/SSOCredentials":{"title":"SSOCredentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials","navigatorTitle":[{"kind":"identifier","text":"SSOCredentials"}],"url":"\/documentation\/auth0\/ssocredentials","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"SSOCredentials"}],"abstract":[{"type":"text","text":"Credentials obtained from Auth0 to perform web single sign-on (SSO)."}],"kind":"symbol","role":"symbol","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/ssocredentials/refreshtoken.json b/docs/data/documentation/auth0/ssocredentials/refreshtoken.json index 3cd657af4..6289746b4 100644 --- a/docs/data/documentation/auth0/ssocredentials/refreshtoken.json +++ b/docs/data/documentation/auth0/ssocredentials/refreshtoken.json @@ -1 +1 @@ -{"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens\/refresh-token-rotation"],"title":"Related Documentation","anchor":"Related-Documentation"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/ssocredentials\/refreshtoken"]}],"sections":[],"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/refreshToken","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"refreshToken","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]},{"kind":"content","content":[{"type":"heading","anchor":"discussion","text":"Discussion","level":2},{"type":"aside","style":"important","name":"Important","content":[{"type":"paragraph","inlineContent":[{"text":"If you’re using the Authentication API client directly to perform the SSO exchange, make sure to store this","type":"text"},{"text":" ","type":"text"},{"text":"new refresh token replacing the previous one.","type":"text"}]}]}]}],"metadata":{"modules":[{"name":"Auth0"}],"role":"symbol","title":"refreshToken","symbolKind":"property","externalID":"s:5Auth014SSOCredentialsV12refreshTokenSSSgvp","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"refreshToken","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"roleHeading":"Instance Property"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials"]]},"schemaVersion":{"minor":3,"major":0,"patch":0},"abstract":[{"type":"text","text":"Rotated refresh token. Only available when Refresh Token Rotation is enabled."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/SSOCredentials":{"url":"\/documentation\/auth0\/ssocredentials","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"SSOCredentials","kind":"identifier"}],"abstract":[{"type":"text","text":"Credentials obtained from Auth0 to perform web single sign-on (SSO)."}],"role":"symbol","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials","title":"SSOCredentials","type":"topic","navigatorTitle":[{"text":"SSOCredentials","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/SSOCredentials/refreshToken":{"role":"symbol","type":"topic","url":"\/documentation\/auth0\/ssocredentials\/refreshtoken","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/refreshToken","abstract":[{"type":"text","text":"Rotated refresh token. Only available when Refresh Token Rotation is enabled."}],"title":"refreshToken","kind":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"refreshToken","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"https://auth0.com/docs/secure/tokens/refresh-tokens/refresh-token-rotation":{"type":"link","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens\/refresh-token-rotation","title":"Refresh Token Rotation","titleInlineContent":[{"type":"text","text":"Refresh Token Rotation"}],"url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens\/refresh-token-rotation"}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/ssocredentials\/refreshtoken"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials"]]},"abstract":[{"text":"Rotated refresh token. Only available when Refresh Token Rotation is enabled.","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"refreshToken","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}]},{"kind":"content","content":[{"level":2,"anchor":"discussion","text":"Discussion","type":"heading"},{"style":"important","content":[{"inlineContent":[{"type":"text","text":"If you’re using the Authentication API client directly to perform the SSO exchange, make sure to store this"},{"type":"text","text":" "},{"type":"text","text":"new refresh token replacing the previous one."}],"type":"paragraph"}],"type":"aside","name":"Important"}]}],"schemaVersion":{"patch":0,"minor":3,"major":0},"kind":"symbol","sections":[],"seeAlsoSections":[{"anchor":"Related-Documentation","identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens\/refresh-token-rotation"],"title":"Related Documentation"}],"metadata":{"symbolKind":"property","roleHeading":"Instance Property","externalID":"s:5Auth014SSOCredentialsV12refreshTokenSSSgvp","title":"refreshToken","modules":[{"name":"Auth0"}],"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"refreshToken","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"role":"symbol"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/refreshToken","interfaceLanguage":"swift"},"references":{"https://auth0.com/docs/secure/tokens/refresh-tokens/refresh-token-rotation":{"titleInlineContent":[{"type":"text","text":"Refresh Token Rotation"}],"url":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens\/refresh-token-rotation","type":"link","title":"Refresh Token Rotation","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/refresh-tokens\/refresh-token-rotation"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/SSOCredentials/refreshToken":{"type":"topic","abstract":[{"type":"text","text":"Rotated refresh token. Only available when Refresh Token Rotation is enabled."}],"kind":"symbol","url":"\/documentation\/auth0\/ssocredentials\/refreshtoken","title":"refreshToken","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"refreshToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/refreshToken"},"doc://com.auth0.Auth0/documentation/Auth0/SSOCredentials":{"title":"SSOCredentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials","navigatorTitle":[{"kind":"identifier","text":"SSOCredentials"}],"url":"\/documentation\/auth0\/ssocredentials","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"SSOCredentials"}],"abstract":[{"type":"text","text":"Credentials obtained from Auth0 to perform web single sign-on (SSO)."}],"kind":"symbol","role":"symbol","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/ssocredentials/sessiontransfertoken.json b/docs/data/documentation/auth0/ssocredentials/sessiontransfertoken.json index 0911d2d70..138d49685 100644 --- a/docs/data/documentation/auth0/ssocredentials/sessiontransfertoken.json +++ b/docs/data/documentation/auth0/ssocredentials/sessiontransfertoken.json @@ -1 +1 @@ -{"schemaVersion":{"minor":3,"patch":0,"major":0},"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/sessionTransferToken","interfaceLanguage":"swift"},"metadata":{"roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"externalID":"s:5Auth014SSOCredentialsV20sessionTransferTokenSSvp","symbolKind":"property","role":"symbol","title":"sessionTransferToken","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"sessionTransferToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}]},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"sessionTransferToken","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}]}],"kind":"declarations"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/ssocredentials\/sessiontransfertoken"]}],"abstract":[{"text":"Token that can be used to request a web session.","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials"]]},"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/SSOCredentials/sessionTransferToken":{"type":"topic","url":"\/documentation\/auth0\/ssocredentials\/sessiontransfertoken","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/sessionTransferToken","abstract":[{"text":"Token that can be used to request a web session.","type":"text"}],"title":"sessionTransferToken","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"sessionTransferToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"kind":"symbol","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/SSOCredentials":{"url":"\/documentation\/auth0\/ssocredentials","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"SSOCredentials","kind":"identifier"}],"abstract":[{"type":"text","text":"Credentials obtained from Auth0 to perform web single sign-on (SSO)."}],"role":"symbol","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials","title":"SSOCredentials","type":"topic","navigatorTitle":[{"text":"SSOCredentials","kind":"identifier"}]}}} \ No newline at end of file +{"metadata":{"symbolKind":"property","roleHeading":"Instance Property","externalID":"s:5Auth014SSOCredentialsV20sessionTransferTokenSSvp","title":"sessionTransferToken","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"sessionTransferToken"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"role":"symbol"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/ssocredentials\/sessiontransfertoken"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/sessionTransferToken","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"text":"Token that can be used to request a web session.","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials"]]},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"sessionTransferToken"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"schemaVersion":{"major":0,"patch":0,"minor":3},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/SSOCredentials/sessionTransferToken":{"type":"topic","title":"sessionTransferToken","url":"\/documentation\/auth0\/ssocredentials\/sessiontransfertoken","kind":"symbol","abstract":[{"text":"Token that can be used to request a web session.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials\/sessionTransferToken","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"sessionTransferToken","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/SSOCredentials":{"title":"SSOCredentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SSOCredentials","navigatorTitle":[{"kind":"identifier","text":"SSOCredentials"}],"url":"\/documentation\/auth0\/ssocredentials","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"SSOCredentials"}],"abstract":[{"type":"text","text":"Credentials obtained from Auth0 to perform web single sign-on (SSO)."}],"kind":"symbol","role":"symbol","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/swift.json b/docs/data/documentation/auth0/swift.json index d3f826c05..7fe375453 100644 --- a/docs/data/documentation/auth0/swift.json +++ b/docs/data/documentation/auth0/swift.json @@ -1 +1 @@ -{"sections":[],"topicSections":[{"generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift\/String"],"anchor":"Extended-Structures","title":"Extended Structures"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift","interfaceLanguage":"swift"},"schemaVersion":{"minor":3,"major":0,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"metadata":{"role":"collection","title":"Swift","symbolKind":"extension","roleHeading":"Extended Module","externalID":"s:m:s:e:s:SS5Auth0E22a0_decodeBase64URLSafe10Foundation4DataVSgyF","modules":[{"name":"Auth0"}]},"variants":[{"paths":["\/documentation\/auth0\/swift"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/Swift":{"url":"\/documentation\/auth0\/swift","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift","abstract":[],"kind":"symbol","role":"collection","title":"Swift"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Swift/String":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift\/String","url":"\/documentation\/auth0\/swift\/string","title":"String","navigatorTitle":[{"text":"String","kind":"identifier"}],"type":"topic","fragments":[{"text":"extension","kind":"keyword"},{"text":" ","kind":"text"},{"text":"String","kind":"identifier","preciseIdentifier":"s:SS"}],"abstract":[{"type":"text","text":"Adds a utility method for decoding base64url-encoded data, like ID tokens."}],"role":"symbol"}}} \ No newline at end of file +{"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift"},"variants":[{"paths":["\/documentation\/auth0\/swift"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","metadata":{"title":"Swift","externalID":"s:m:s:e:s:SS5Auth0E22a0_decodeBase64URLSafe10Foundation4DataVSgyF","symbolKind":"extension","roleHeading":"Extended Module","role":"collection","modules":[{"name":"Auth0"}]},"schemaVersion":{"patch":0,"minor":3,"major":0},"topicSections":[{"title":"Extended Structures","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift\/String"],"generated":true,"anchor":"Extended-Structures"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Swift":{"title":"Swift","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift","role":"collection","kind":"symbol","abstract":[],"url":"\/documentation\/auth0\/swift"},"doc://com.auth0.Auth0/documentation/Auth0/Swift/String":{"title":"String","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift\/String","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"extension"},{"kind":"text","text":" "},{"preciseIdentifier":"s:SS","kind":"identifier","text":"String"}],"abstract":[{"type":"text","text":"Adds a utility method for decoding base64url-encoded data, like ID tokens."}],"url":"\/documentation\/auth0\/swift\/string","navigatorTitle":[{"kind":"identifier","text":"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 19b2afc5e..b6d7fcce9 100644 --- a/docs/data/documentation/auth0/swift/string.json +++ b/docs/data/documentation/auth0/swift/string.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/swift\/string"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"extension","kind":"keyword"},{"text":" ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"platforms":["iOS"]}]}],"kind":"symbol","topicSections":[{"generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift\/String\/a0_decodeBase64URLSafe()"],"anchor":"Instance-Methods","title":"Instance Methods"}],"abstract":[{"text":"Adds a utility method for decoding base64url-encoded data, like ID tokens.","type":"text"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift\/String"},"metadata":{"title":"String","role":"symbol","navigatorTitle":[{"text":"String","kind":"identifier"}],"externalID":"s:e:s:SS5Auth0E22a0_decodeBase64URLSafe10Foundation4DataVSgyF","symbolKind":"extension","extendedModule":"Swift","modules":[{"relatedModules":["Swift"],"name":"Auth0"}],"roleHeading":"Extended Structure","fragments":[{"text":"extension","kind":"keyword"},{"text":" ","kind":"text"},{"text":"String","kind":"identifier","preciseIdentifier":"s:SS"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Swift":{"url":"\/documentation\/auth0\/swift","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift","abstract":[],"kind":"symbol","role":"collection","title":"Swift"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Swift/String":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift\/String","url":"\/documentation\/auth0\/swift\/string","title":"String","navigatorTitle":[{"text":"String","kind":"identifier"}],"type":"topic","fragments":[{"text":"extension","kind":"keyword"},{"text":" ","kind":"text"},{"text":"String","kind":"identifier","preciseIdentifier":"s:SS"}],"abstract":[{"type":"text","text":"Adds a utility method for decoding base64url-encoded data, like ID tokens."}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Swift/String/a0_decodeBase64URLSafe()":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift\/String\/a0_decodeBase64URLSafe()","title":"a0_decodeBase64URLSafe()","url":"\/documentation\/auth0\/swift\/string\/a0_decodebase64urlsafe()","type":"topic","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"a0_decodeBase64URLSafe"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV","text":"Data"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"Decodes base64url-encoded data."}],"role":"symbol"}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/swift\/string"]}],"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":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift\/String\/a0_decodeBase64URLSafe()"],"generated":true,"title":"Instance Methods","anchor":"Instance-Methods"}],"kind":"symbol","sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"extension"},{"kind":"text","text":" "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"platforms":["iOS"],"languages":["swift"]}]}],"metadata":{"externalID":"s:e:s:SS5Auth0E22a0_decodeBase64URLSafe10Foundation4DataVSgyF","extendedModule":"Swift","symbolKind":"extension","title":"String","role":"symbol","roleHeading":"Extended Structure","fragments":[{"kind":"keyword","text":"extension"},{"kind":"text","text":" "},{"preciseIdentifier":"s:SS","kind":"identifier","text":"String"}],"navigatorTitle":[{"kind":"identifier","text":"String"}],"modules":[{"name":"Auth0","relatedModules":["Swift"]}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift\/String"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Swift":{"title":"Swift","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift","role":"collection","kind":"symbol","abstract":[],"url":"\/documentation\/auth0\/swift"},"doc://com.auth0.Auth0/documentation/Auth0/Swift/String/a0_decodeBase64URLSafe()":{"type":"topic","abstract":[{"text":"Decodes base64url-encoded data.","type":"text"}],"title":"a0_decodeBase64URLSafe()","kind":"symbol","url":"\/documentation\/auth0\/swift\/string\/a0_decodebase64urlsafe()","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"a0_decodeBase64URLSafe","kind":"identifier"},{"text":"() -> ","kind":"text"},{"preciseIdentifier":"s:10Foundation4DataV","text":"Data","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift\/String\/a0_decodeBase64URLSafe()"},"doc://com.auth0.Auth0/documentation/Auth0/Swift/String":{"title":"String","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift\/String","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"extension"},{"kind":"text","text":" "},{"preciseIdentifier":"s:SS","kind":"identifier","text":"String"}],"abstract":[{"type":"text","text":"Adds a utility method for decoding base64url-encoded data, like ID tokens."}],"url":"\/documentation\/auth0\/swift\/string","navigatorTitle":[{"kind":"identifier","text":"String"}]}}} \ 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 73d44caa5..e3cbd9d1a 100644 --- a/docs/data/documentation/auth0/swift/string/a0_decodebase64urlsafe().json +++ b/docs/data/documentation/auth0/swift/string/a0_decodebase64urlsafe().json @@ -1 +1 @@ -{"schemaVersion":{"patch":0,"major":0,"minor":3},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"a0_decodeBase64URLSafe"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"?"}],"languages":["swift"]}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift\/String\/a0_decodeBase64URLSafe()"},"kind":"symbol","metadata":{"externalID":"s:SS5Auth0E22a0_decodeBase64URLSafe10Foundation4DataVSgyF","role":"symbol","symbolKind":"method","modules":[{"name":"Auth0","relatedModules":["Swift"]}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"a0_decodeBase64URLSafe"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"?"}],"extendedModule":"Swift","title":"a0_decodeBase64URLSafe()","roleHeading":"Instance Method"},"sections":[],"abstract":[{"text":"Decodes base64url-encoded data.","type":"text"}],"variants":[{"paths":["\/documentation\/auth0\/swift\/string\/a0_decodebase64urlsafe()"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift\/String"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Swift/String":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift\/String","url":"\/documentation\/auth0\/swift\/string","title":"String","navigatorTitle":[{"text":"String","kind":"identifier"}],"type":"topic","fragments":[{"text":"extension","kind":"keyword"},{"text":" ","kind":"text"},{"text":"String","kind":"identifier","preciseIdentifier":"s:SS"}],"abstract":[{"type":"text","text":"Adds a utility method for decoding base64url-encoded data, like ID tokens."}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Swift":{"url":"\/documentation\/auth0\/swift","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift","abstract":[],"kind":"symbol","role":"collection","title":"Swift"},"doc://com.auth0.Auth0/documentation/Auth0/Swift/String/a0_decodeBase64URLSafe()":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift\/String\/a0_decodeBase64URLSafe()","title":"a0_decodeBase64URLSafe()","url":"\/documentation\/auth0\/swift\/string\/a0_decodebase64urlsafe()","type":"topic","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"a0_decodeBase64URLSafe"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV","text":"Data"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"Decodes base64url-encoded data."}],"role":"symbol"}}} \ No newline at end of file +{"metadata":{"roleHeading":"Instance Method","extendedModule":"Swift","role":"symbol","title":"a0_decodeBase64URLSafe()","symbolKind":"method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"a0_decodeBase64URLSafe"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV","text":"Data"},{"kind":"text","text":"?"}],"externalID":"s:SS5Auth0E22a0_decodeBase64URLSafe10Foundation4DataVSgyF","modules":[{"name":"Auth0","relatedModules":["Swift"]}]},"sections":[],"variants":[{"paths":["\/documentation\/auth0\/swift\/string\/a0_decodebase64urlsafe()"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift\/String\/a0_decodeBase64URLSafe()"},"kind":"symbol","abstract":[{"type":"text","text":"Decodes base64url-encoded data."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift\/String"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"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":"?"}]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Swift/String":{"title":"String","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift\/String","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"extension"},{"kind":"text","text":" "},{"preciseIdentifier":"s:SS","kind":"identifier","text":"String"}],"abstract":[{"type":"text","text":"Adds a utility method for decoding base64url-encoded data, like ID tokens."}],"url":"\/documentation\/auth0\/swift\/string","navigatorTitle":[{"kind":"identifier","text":"String"}]},"doc://com.auth0.Auth0/documentation/Auth0/Swift/String/a0_decodeBase64URLSafe()":{"type":"topic","abstract":[{"text":"Decodes base64url-encoded data.","type":"text"}],"title":"a0_decodeBase64URLSafe()","kind":"symbol","url":"\/documentation\/auth0\/swift\/string\/a0_decodebase64urlsafe()","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"a0_decodeBase64URLSafe","kind":"identifier"},{"text":"() -> ","kind":"text"},{"preciseIdentifier":"s:10Foundation4DataV","text":"Data","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift\/String\/a0_decodeBase64URLSafe()"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Swift":{"title":"Swift","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Swift","role":"collection","kind":"symbol","abstract":[],"url":"\/documentation\/auth0\/swift"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/telemetry.json b/docs/data/documentation/auth0/telemetry.json index e0bcc2c18..3112ffcb4 100644 --- a/docs/data/documentation/auth0/telemetry.json +++ b/docs/data/documentation/auth0/telemetry.json @@ -1 +1 @@ -{"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/telemetry"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry"},"schemaVersion":{"minor":3,"major":0,"patch":0},"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry\/init()"],"title":"Initializers","generated":true,"anchor":"Initializers"}],"abstract":[{"text":"Generates and sets the ","type":"text"},{"code":"Auth0-Client","type":"codeVoice"},{"text":" header.","type":"text"}],"metadata":{"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Telemetry"}],"externalID":"s:5Auth09TelemetryV","symbolKind":"struct","roleHeading":"Structure","title":"Telemetry","navigatorTitle":[{"text":"Telemetry","kind":"identifier"}],"modules":[{"name":"Auth0"}]},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Telemetry"}]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Telemetry":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Telemetry","kind":"identifier"}],"title":"Telemetry","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","url":"\/documentation\/auth0\/telemetry","kind":"symbol","abstract":[{"text":"Generates and sets the ","type":"text"},{"type":"codeVoice","code":"Auth0-Client"},{"text":" header.","type":"text"}],"role":"symbol","navigatorTitle":[{"text":"Telemetry","kind":"identifier"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Telemetry/init()":{"title":"init()","role":"symbol","type":"topic","url":"\/documentation\/auth0\/telemetry\/init()","abstract":[{"text":"Initializer that generates a base64url-encoded value with telemetry data.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry\/init()","kind":"symbol","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"()"}]}}} \ No newline at end of file +{"topicSections":[{"title":"Initializers","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry\/init()"],"anchor":"Initializers","generated":true}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"metadata":{"symbolKind":"struct","modules":[{"name":"Auth0"}],"title":"Telemetry","navigatorTitle":[{"text":"Telemetry","kind":"identifier"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Telemetry","kind":"identifier"}],"externalID":"s:5Auth09TelemetryV","role":"symbol","roleHeading":"Structure"},"sections":[],"abstract":[{"type":"text","text":"Generates and sets the "},{"type":"codeVoice","code":"Auth0-Client"},{"type":"text","text":" header."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/telemetry"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry"},"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Telemetry","kind":"identifier"}],"languages":["swift"],"platforms":["iOS"]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Telemetry":{"kind":"symbol","abstract":[{"text":"Generates and sets the ","type":"text"},{"code":"Auth0-Client","type":"codeVoice"},{"text":" header.","type":"text"}],"type":"topic","title":"Telemetry","url":"\/documentation\/auth0\/telemetry","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Telemetry"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","navigatorTitle":[{"kind":"identifier","text":"Telemetry"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Telemetry/init()":{"url":"\/documentation\/auth0\/telemetry\/init()","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"()"}],"title":"init()","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Initializer that generates a base64url-encoded value with telemetry data."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry\/init()","kind":"symbol"}}} \ 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 32af51202..d9d4c13a8 100644 --- a/docs/data/documentation/auth0/telemetry/init().json +++ b/docs/data/documentation/auth0/telemetry/init().json @@ -1 +1 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry\/init()","interfaceLanguage":"swift"},"kind":"symbol","sections":[],"abstract":[{"type":"text","text":"Initializer that generates a base64url-encoded value with telemetry data."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"init"},{"kind":"text","text":"()"}],"platforms":["iOS"],"languages":["swift"]}]}],"metadata":{"symbolKind":"init","role":"symbol","modules":[{"name":"Auth0"}],"roleHeading":"Initializer","fragments":[{"text":"init","kind":"identifier"},{"text":"()","kind":"text"}],"externalID":"s:5Auth09TelemetryVACycfc","title":"init()"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry"]]},"schemaVersion":{"minor":3,"patch":0,"major":0},"variants":[{"paths":["\/documentation\/auth0\/telemetry\/init()"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Telemetry/init()":{"title":"init()","role":"symbol","type":"topic","url":"\/documentation\/auth0\/telemetry\/init()","abstract":[{"text":"Initializer that generates a base64url-encoded value with telemetry data.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry\/init()","kind":"symbol","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"()"}]},"doc://com.auth0.Auth0/documentation/Auth0/Telemetry":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Telemetry","kind":"identifier"}],"title":"Telemetry","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","url":"\/documentation\/auth0\/telemetry","kind":"symbol","abstract":[{"text":"Generates and sets the ","type":"text"},{"type":"codeVoice","code":"Auth0-Client"},{"text":" header.","type":"text"}],"role":"symbol","navigatorTitle":[{"text":"Telemetry","kind":"identifier"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry\/init()","interfaceLanguage":"swift"},"kind":"symbol","metadata":{"externalID":"s:5Auth09TelemetryVACycfc","modules":[{"name":"Auth0"}],"title":"init()","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"()"}],"roleHeading":"Initializer","role":"symbol","symbolKind":"init"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/telemetry\/init()"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry"]]},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"init"},{"kind":"text","text":"()"}]}],"kind":"declarations"}],"abstract":[{"type":"text","text":"Initializer that generates a base64url-encoded value with telemetry data."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Telemetry":{"kind":"symbol","abstract":[{"text":"Generates and sets the ","type":"text"},{"code":"Auth0-Client","type":"codeVoice"},{"text":" header.","type":"text"}],"type":"topic","title":"Telemetry","url":"\/documentation\/auth0\/telemetry","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Telemetry"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","navigatorTitle":[{"kind":"identifier","text":"Telemetry"}]},"doc://com.auth0.Auth0/documentation/Auth0/Telemetry/init()":{"url":"\/documentation\/auth0\/telemetry\/init()","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"()"}],"title":"init()","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Initializer that generates a base64url-encoded value with telemetry data."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry\/init()","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/totpenrollmentchallenge.json b/docs/data/documentation/auth0/totpenrollmentchallenge.json index bcee43dc5..5d0accf4d 100644 --- a/docs/data/documentation/auth0/totpenrollmentchallenge.json +++ b/docs/data/documentation/auth0/totpenrollmentchallenge.json @@ -1 +1 @@ -{"metadata":{"modules":[{"name":"Auth0"}],"roleHeading":"Structure","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"TOTPEnrollmentChallenge","kind":"identifier"}],"role":"symbol","externalID":"s:5Auth023TOTPEnrollmentChallengeV","symbolKind":"struct","title":"TOTPEnrollmentChallenge","navigatorTitle":[{"kind":"identifier","text":"TOTPEnrollmentChallenge"}]},"sections":[],"topicSections":[{"title":"Instance Properties","generated":true,"anchor":"Instance-Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge\/authenticationId","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge\/authenticationSession","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge\/authenticatorManualInputCode","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge\/authenticatorQRCodeURI"]},{"title":"Default Implementations","generated":true,"anchor":"Default-Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge\/Decodable-Implementations"]}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"TOTPEnrollmentChallenge","kind":"identifier"}]}],"kind":"declarations"}],"schemaVersion":{"major":0,"patch":0,"minor":3},"abstract":[{"text":"A TOTP enrollment challenge.","type":"text"}],"relationshipsSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/s8CopyableP","doc:\/\/com.auth0.Auth0\/Se"],"kind":"relationships","type":"conformsTo","title":"Conforms To"}],"variants":[{"paths":["\/documentation\/auth0\/totpenrollmentchallenge"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge"},"kind":"symbol","references":{"doc://com.auth0.Auth0/s8CopyableP":{"identifier":"doc:\/\/com.auth0.Auth0\/s8CopyableP","type":"unresolvable","title":"Swift.Copyable"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/TOTPEnrollmentChallenge/authenticationId":{"abstract":[{"type":"text","text":"The unique identifier for the authentication method."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge\/authenticationId","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticationId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"title":"authenticationId","role":"symbol","type":"topic","url":"\/documentation\/auth0\/totpenrollmentchallenge\/authenticationid","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/TOTPEnrollmentChallenge/authenticatorManualInputCode":{"kind":"symbol","abstract":[{"type":"text","text":"The manual input code for the authenticator in case QR codes cannot be used."}],"role":"symbol","title":"authenticatorManualInputCode","url":"\/documentation\/auth0\/totpenrollmentchallenge\/authenticatormanualinputcode","type":"topic","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authenticatorManualInputCode","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge\/authenticatorManualInputCode"},"doc://com.auth0.Auth0/documentation/Auth0/TOTPEnrollmentChallenge/Decodable-Implementations":{"url":"\/documentation\/auth0\/totpenrollmentchallenge\/decodable-implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge\/Decodable-Implementations","type":"topic","abstract":[],"kind":"article","title":"Decodable Implementations","role":"collectionGroup"},"doc://com.auth0.Auth0/documentation/Auth0/TOTPEnrollmentChallenge/authenticatorQRCodeURI":{"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticatorQRCodeURI"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge\/authenticatorQRCodeURI","type":"topic","title":"authenticatorQRCodeURI","url":"\/documentation\/auth0\/totpenrollmentchallenge\/authenticatorqrcodeuri","role":"symbol","abstract":[{"type":"text","text":"The URI for the QR code to be scanned by the authenticator."}],"kind":"symbol"},"doc://com.auth0.Auth0/Se":{"type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/Se","title":"Swift.Decodable"},"doc://com.auth0.Auth0/documentation/Auth0/TOTPEnrollmentChallenge":{"kind":"symbol","navigatorTitle":[{"text":"TOTPEnrollmentChallenge","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge","url":"\/documentation\/auth0\/totpenrollmentchallenge","title":"TOTPEnrollmentChallenge","type":"topic","abstract":[{"type":"text","text":"A TOTP enrollment challenge."}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"TOTPEnrollmentChallenge","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/TOTPEnrollmentChallenge/authenticationSession":{"abstract":[{"type":"text","text":"The unique session identifier for the enrollment."}],"kind":"symbol","role":"symbol","type":"topic","url":"\/documentation\/auth0\/totpenrollmentchallenge\/authenticationsession","title":"authenticationSession","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge\/authenticationSession","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticationSession"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}]}}} \ No newline at end of file +{"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"TOTPEnrollmentChallenge","kind":"identifier"}]}]}],"relationshipsSections":[{"kind":"relationships","title":"Conforms To","identifiers":["doc:\/\/com.auth0.Auth0\/s8CopyableP","doc:\/\/com.auth0.Auth0\/Se"],"type":"conformsTo"}],"topicSections":[{"title":"Instance Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge\/authenticationId","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge\/authenticationSession","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge\/authenticatorManualInputCode","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge\/authenticatorQRCodeURI"],"generated":true,"anchor":"Instance-Properties"},{"title":"Default Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge\/Decodable-Implementations"],"generated":true,"anchor":"Default-Implementations"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/totpenrollmentchallenge"]}],"sections":[],"schemaVersion":{"patch":0,"minor":3,"major":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"abstract":[{"type":"text","text":"A TOTP enrollment challenge."}],"metadata":{"externalID":"s:5Auth023TOTPEnrollmentChallengeV","symbolKind":"struct","title":"TOTPEnrollmentChallenge","role":"symbol","roleHeading":"Structure","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"TOTPEnrollmentChallenge","kind":"identifier"}],"navigatorTitle":[{"text":"TOTPEnrollmentChallenge","kind":"identifier"}],"modules":[{"name":"Auth0"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/TOTPEnrollmentChallenge/Decodable-Implementations":{"type":"topic","title":"Decodable Implementations","url":"\/documentation\/auth0\/totpenrollmentchallenge\/decodable-implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge\/Decodable-Implementations","kind":"article","abstract":[],"role":"collectionGroup"},"doc://com.auth0.Auth0/documentation/Auth0/TOTPEnrollmentChallenge/authenticationId":{"role":"symbol","title":"authenticationId","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticationId"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"abstract":[{"type":"text","text":"The unique identifier for the authentication method."}],"kind":"symbol","url":"\/documentation\/auth0\/totpenrollmentchallenge\/authenticationid","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge\/authenticationId","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/TOTPEnrollmentChallenge/authenticationSession":{"kind":"symbol","title":"authenticationSession","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticationSession"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge\/authenticationSession","abstract":[{"type":"text","text":"The unique session identifier for the enrollment."}],"url":"\/documentation\/auth0\/totpenrollmentchallenge\/authenticationsession"},"doc://com.auth0.Auth0/documentation/Auth0/TOTPEnrollmentChallenge/authenticatorQRCodeURI":{"kind":"symbol","title":"authenticatorQRCodeURI","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticatorQRCodeURI"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge\/authenticatorQRCodeURI","abstract":[{"type":"text","text":"The URI for the QR code to be scanned by the authenticator."}],"url":"\/documentation\/auth0\/totpenrollmentchallenge\/authenticatorqrcodeuri"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/TOTPEnrollmentChallenge/authenticatorManualInputCode":{"kind":"symbol","title":"authenticatorManualInputCode","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticatorManualInputCode"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge\/authenticatorManualInputCode","abstract":[{"type":"text","text":"The manual input code for the authenticator in case QR codes cannot be used."}],"url":"\/documentation\/auth0\/totpenrollmentchallenge\/authenticatormanualinputcode"},"doc://com.auth0.Auth0/Se":{"title":"Swift.Decodable","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/Se"},"doc://com.auth0.Auth0/documentation/Auth0/TOTPEnrollmentChallenge":{"title":"TOTPEnrollmentChallenge","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"TOTPEnrollmentChallenge"}],"abstract":[{"text":"A TOTP enrollment challenge.","type":"text"}],"url":"\/documentation\/auth0\/totpenrollmentchallenge","navigatorTitle":[{"kind":"identifier","text":"TOTPEnrollmentChallenge"}]},"doc://com.auth0.Auth0/s8CopyableP":{"title":"Swift.Copyable","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s8CopyableP"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/totpenrollmentchallenge/authenticationid.json b/docs/data/documentation/auth0/totpenrollmentchallenge/authenticationid.json index 945f2cff5..3e4d4f8fe 100644 --- a/docs/data/documentation/auth0/totpenrollmentchallenge/authenticationid.json +++ b/docs/data/documentation/auth0/totpenrollmentchallenge/authenticationid.json @@ -1 +1 @@ -{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge\/authenticationId"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge"]]},"sections":[],"kind":"symbol","metadata":{"roleHeading":"Instance Property","title":"authenticationId","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authenticationId","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"role":"symbol","modules":[{"name":"Auth0"}],"externalID":"s:5Auth023TOTPEnrollmentChallengeV16authenticationIdSSvp","symbolKind":"property"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/totpenrollmentchallenge\/authenticationid"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authenticationId","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"type":"text","text":"The unique identifier for the authentication method."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/TOTPEnrollmentChallenge":{"kind":"symbol","navigatorTitle":[{"text":"TOTPEnrollmentChallenge","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge","url":"\/documentation\/auth0\/totpenrollmentchallenge","title":"TOTPEnrollmentChallenge","type":"topic","abstract":[{"type":"text","text":"A TOTP enrollment challenge."}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"TOTPEnrollmentChallenge","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/TOTPEnrollmentChallenge/authenticationId":{"abstract":[{"type":"text","text":"The unique identifier for the authentication method."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge\/authenticationId","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticationId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"title":"authenticationId","role":"symbol","type":"topic","url":"\/documentation\/auth0\/totpenrollmentchallenge\/authenticationid","kind":"symbol"}}} \ No newline at end of file +{"schemaVersion":{"patch":0,"major":0,"minor":3},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authenticationId","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"platforms":["iOS"]}]}],"sections":[],"abstract":[{"type":"text","text":"The unique identifier for the authentication method."}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/totpenrollmentchallenge\/authenticationid"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge\/authenticationId","interfaceLanguage":"swift"},"metadata":{"role":"symbol","title":"authenticationId","modules":[{"name":"Auth0"}],"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authenticationId","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"externalID":"s:5Auth023TOTPEnrollmentChallengeV16authenticationIdSSvp","roleHeading":"Instance Property","symbolKind":"property"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/TOTPEnrollmentChallenge/authenticationId":{"role":"symbol","title":"authenticationId","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticationId"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"abstract":[{"type":"text","text":"The unique identifier for the authentication method."}],"kind":"symbol","url":"\/documentation\/auth0\/totpenrollmentchallenge\/authenticationid","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge\/authenticationId","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/TOTPEnrollmentChallenge":{"title":"TOTPEnrollmentChallenge","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"TOTPEnrollmentChallenge"}],"abstract":[{"text":"A TOTP enrollment challenge.","type":"text"}],"url":"\/documentation\/auth0\/totpenrollmentchallenge","navigatorTitle":[{"kind":"identifier","text":"TOTPEnrollmentChallenge"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/totpenrollmentchallenge/authenticationsession.json b/docs/data/documentation/auth0/totpenrollmentchallenge/authenticationsession.json index 244328f64..58fff432f 100644 --- a/docs/data/documentation/auth0/totpenrollmentchallenge/authenticationsession.json +++ b/docs/data/documentation/auth0/totpenrollmentchallenge/authenticationsession.json @@ -1 +1 @@ -{"variants":[{"paths":["\/documentation\/auth0\/totpenrollmentchallenge\/authenticationsession"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticationSession"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}]}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge\/authenticationSession"},"sections":[],"metadata":{"title":"authenticationSession","externalID":"s:5Auth023TOTPEnrollmentChallengeV21authenticationSessionSSvp","symbolKind":"property","role":"symbol","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticationSession"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"roleHeading":"Instance Property"},"abstract":[{"type":"text","text":"The unique session identifier for the enrollment."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge"]]},"schemaVersion":{"minor":3,"patch":0,"major":0},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/TOTPEnrollmentChallenge/authenticationSession":{"abstract":[{"type":"text","text":"The unique session identifier for the enrollment."}],"kind":"symbol","role":"symbol","type":"topic","url":"\/documentation\/auth0\/totpenrollmentchallenge\/authenticationsession","title":"authenticationSession","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge\/authenticationSession","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticationSession"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}]},"doc://com.auth0.Auth0/documentation/Auth0/TOTPEnrollmentChallenge":{"kind":"symbol","navigatorTitle":[{"text":"TOTPEnrollmentChallenge","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge","url":"\/documentation\/auth0\/totpenrollmentchallenge","title":"TOTPEnrollmentChallenge","type":"topic","abstract":[{"type":"text","text":"A TOTP enrollment challenge."}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"TOTPEnrollmentChallenge","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge\/authenticationSession","interfaceLanguage":"swift"},"kind":"symbol","metadata":{"externalID":"s:5Auth023TOTPEnrollmentChallengeV21authenticationSessionSSvp","modules":[{"name":"Auth0"}],"title":"authenticationSession","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticationSession"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"roleHeading":"Instance Property","role":"symbol","symbolKind":"property"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/totpenrollmentchallenge\/authenticationsession"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge"]]},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticationSession"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}]}],"kind":"declarations"}],"abstract":[{"type":"text","text":"The unique session identifier for the enrollment."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/TOTPEnrollmentChallenge":{"title":"TOTPEnrollmentChallenge","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"TOTPEnrollmentChallenge"}],"abstract":[{"text":"A TOTP enrollment challenge.","type":"text"}],"url":"\/documentation\/auth0\/totpenrollmentchallenge","navigatorTitle":[{"kind":"identifier","text":"TOTPEnrollmentChallenge"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/TOTPEnrollmentChallenge/authenticationSession":{"kind":"symbol","title":"authenticationSession","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticationSession"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge\/authenticationSession","abstract":[{"type":"text","text":"The unique session identifier for the enrollment."}],"url":"\/documentation\/auth0\/totpenrollmentchallenge\/authenticationsession"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/totpenrollmentchallenge/authenticatormanualinputcode.json b/docs/data/documentation/auth0/totpenrollmentchallenge/authenticatormanualinputcode.json index 1cf20f1b0..0198e3595 100644 --- a/docs/data/documentation/auth0/totpenrollmentchallenge/authenticatormanualinputcode.json +++ b/docs/data/documentation/auth0/totpenrollmentchallenge/authenticatormanualinputcode.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticatorManualInputCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"platforms":["iOS"]}]}],"abstract":[{"type":"text","text":"The manual input code for the authenticator in case QR codes cannot be used."}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge\/authenticatorManualInputCode","interfaceLanguage":"swift"},"variants":[{"paths":["\/documentation\/auth0\/totpenrollmentchallenge\/authenticatormanualinputcode"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"minor":3,"major":0,"patch":0},"kind":"symbol","metadata":{"symbolKind":"property","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticatorManualInputCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"role":"symbol","roleHeading":"Instance Property","externalID":"s:5Auth023TOTPEnrollmentChallengeV28authenticatorManualInputCodeSSSgvp","title":"authenticatorManualInputCode"},"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/TOTPEnrollmentChallenge":{"kind":"symbol","navigatorTitle":[{"text":"TOTPEnrollmentChallenge","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge","url":"\/documentation\/auth0\/totpenrollmentchallenge","title":"TOTPEnrollmentChallenge","type":"topic","abstract":[{"type":"text","text":"A TOTP enrollment challenge."}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"TOTPEnrollmentChallenge","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/TOTPEnrollmentChallenge/authenticatorManualInputCode":{"kind":"symbol","abstract":[{"type":"text","text":"The manual input code for the authenticator in case QR codes cannot be used."}],"role":"symbol","title":"authenticatorManualInputCode","url":"\/documentation\/auth0\/totpenrollmentchallenge\/authenticatormanualinputcode","type":"topic","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authenticatorManualInputCode","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge\/authenticatorManualInputCode"}}} \ No newline at end of file +{"sections":[],"metadata":{"modules":[{"name":"Auth0"}],"title":"authenticatorManualInputCode","roleHeading":"Instance Property","symbolKind":"property","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authenticatorManualInputCode","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"externalID":"s:5Auth023TOTPEnrollmentChallengeV28authenticatorManualInputCodeSSSgvp"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge\/authenticatorManualInputCode","interfaceLanguage":"swift"},"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/totpenrollmentchallenge\/authenticatormanualinputcode"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authenticatorManualInputCode","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}]}],"kind":"declarations"}],"abstract":[{"type":"text","text":"The manual input code for the authenticator in case QR codes cannot be used."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/TOTPEnrollmentChallenge/authenticatorManualInputCode":{"kind":"symbol","title":"authenticatorManualInputCode","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticatorManualInputCode"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge\/authenticatorManualInputCode","abstract":[{"type":"text","text":"The manual input code for the authenticator in case QR codes cannot be used."}],"url":"\/documentation\/auth0\/totpenrollmentchallenge\/authenticatormanualinputcode"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/TOTPEnrollmentChallenge":{"title":"TOTPEnrollmentChallenge","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"TOTPEnrollmentChallenge"}],"abstract":[{"text":"A TOTP enrollment challenge.","type":"text"}],"url":"\/documentation\/auth0\/totpenrollmentchallenge","navigatorTitle":[{"kind":"identifier","text":"TOTPEnrollmentChallenge"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/totpenrollmentchallenge/authenticatorqrcodeuri.json b/docs/data/documentation/auth0/totpenrollmentchallenge/authenticatorqrcodeuri.json index d859f734d..cabab78a9 100644 --- a/docs/data/documentation/auth0/totpenrollmentchallenge/authenticatorqrcodeuri.json +++ b/docs/data/documentation/auth0/totpenrollmentchallenge/authenticatorqrcodeuri.json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticatorQRCodeURI"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"languages":["swift"]}]}],"abstract":[{"text":"The URI for the QR code to be scanned by the authenticator.","type":"text"}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/totpenrollmentchallenge\/authenticatorqrcodeuri"]}],"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge\/authenticatorQRCodeURI","interfaceLanguage":"swift"},"metadata":{"role":"symbol","title":"authenticatorQRCodeURI","symbolKind":"property","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authenticatorQRCodeURI","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"externalID":"s:5Auth023TOTPEnrollmentChallengeV22authenticatorQRCodeURISSvp","modules":[{"name":"Auth0"}],"roleHeading":"Instance Property"},"schemaVersion":{"minor":3,"major":0,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/TOTPEnrollmentChallenge":{"kind":"symbol","navigatorTitle":[{"text":"TOTPEnrollmentChallenge","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge","url":"\/documentation\/auth0\/totpenrollmentchallenge","title":"TOTPEnrollmentChallenge","type":"topic","abstract":[{"type":"text","text":"A TOTP enrollment challenge."}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"TOTPEnrollmentChallenge","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/TOTPEnrollmentChallenge/authenticatorQRCodeURI":{"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticatorQRCodeURI"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge\/authenticatorQRCodeURI","type":"topic","title":"authenticatorQRCodeURI","url":"\/documentation\/auth0\/totpenrollmentchallenge\/authenticatorqrcodeuri","role":"symbol","abstract":[{"type":"text","text":"The URI for the QR code to be scanned by the authenticator."}],"kind":"symbol"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge"]]},"metadata":{"modules":[{"name":"Auth0"}],"title":"authenticatorQRCodeURI","roleHeading":"Instance Property","symbolKind":"property","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticatorQRCodeURI"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"externalID":"s:5Auth023TOTPEnrollmentChallengeV22authenticatorQRCodeURISSvp"},"sections":[],"abstract":[{"type":"text","text":"The URI for the QR code to be scanned by the authenticator."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/totpenrollmentchallenge\/authenticatorqrcodeuri"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge\/authenticatorQRCodeURI","interfaceLanguage":"swift"},"kind":"symbol","schemaVersion":{"patch":0,"major":0,"minor":3},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticatorQRCodeURI"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/TOTPEnrollmentChallenge/authenticatorQRCodeURI":{"kind":"symbol","title":"authenticatorQRCodeURI","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"authenticatorQRCodeURI"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge\/authenticatorQRCodeURI","abstract":[{"type":"text","text":"The URI for the QR code to be scanned by the authenticator."}],"url":"\/documentation\/auth0\/totpenrollmentchallenge\/authenticatorqrcodeuri"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/TOTPEnrollmentChallenge":{"title":"TOTPEnrollmentChallenge","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"TOTPEnrollmentChallenge"}],"abstract":[{"text":"A TOTP enrollment challenge.","type":"text"}],"url":"\/documentation\/auth0\/totpenrollmentchallenge","navigatorTitle":[{"kind":"identifier","text":"TOTPEnrollmentChallenge"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/totpenrollmentchallenge/decodable-implementations.json b/docs/data/documentation/auth0/totpenrollmentchallenge/decodable-implementations.json index 68b761151..3543d56f6 100644 --- a/docs/data/documentation/auth0/totpenrollmentchallenge/decodable-implementations.json +++ b/docs/data/documentation/auth0/totpenrollmentchallenge/decodable-implementations.json @@ -1 +1 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge\/Decodable-Implementations","interfaceLanguage":"swift"},"metadata":{"roleHeading":"API Collection","role":"collectionGroup","modules":[{"name":"Auth0"}],"title":"Decodable Implementations"},"sections":[],"topicSections":[{"generated":true,"anchor":"Initializers","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge\/init(from:)"],"title":"Initializers"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge"]]},"kind":"article","schemaVersion":{"minor":3,"major":0,"patch":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/totpenrollmentchallenge\/decodable-implementations"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/TOTPEnrollmentChallenge/init(from:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge\/init(from:)","abstract":[{"code":"Decodable","type":"codeVoice"},{"text":" initializer.","type":"text"}],"fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Decoder","preciseIdentifier":"s:s7DecoderP"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"kind":"symbol","url":"\/documentation\/auth0\/totpenrollmentchallenge\/init(from:)","title":"init(from:)","type":"topic","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/TOTPEnrollmentChallenge":{"kind":"symbol","navigatorTitle":[{"text":"TOTPEnrollmentChallenge","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge","url":"\/documentation\/auth0\/totpenrollmentchallenge","title":"TOTPEnrollmentChallenge","type":"topic","abstract":[{"type":"text","text":"A TOTP enrollment challenge."}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"TOTPEnrollmentChallenge","kind":"identifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"metadata":{"roleHeading":"API Collection","modules":[{"name":"Auth0"}],"role":"collectionGroup","title":"Decodable Implementations"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/totpenrollmentchallenge\/decodable-implementations"]}],"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge\/init(from:)"],"generated":true,"title":"Initializers","anchor":"Initializers"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge\/Decodable-Implementations"},"kind":"article","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/TOTPEnrollmentChallenge":{"title":"TOTPEnrollmentChallenge","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"TOTPEnrollmentChallenge"}],"abstract":[{"text":"A TOTP enrollment challenge.","type":"text"}],"url":"\/documentation\/auth0\/totpenrollmentchallenge","navigatorTitle":[{"kind":"identifier","text":"TOTPEnrollmentChallenge"}]},"doc://com.auth0.Auth0/documentation/Auth0/TOTPEnrollmentChallenge/init(from:)":{"url":"\/documentation\/auth0\/totpenrollmentchallenge\/init(from:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier","text":"Decoder"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"title":"init(from:)","type":"topic","role":"symbol","abstract":[{"type":"codeVoice","code":"Decodable"},{"text":" initializer.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge\/init(from:)","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/totpenrollmentchallenge/init(from:).json b/docs/data/documentation/auth0/totpenrollmentchallenge/init(from:).json index eb651ab54..39cfaf84a 100644 --- a/docs/data/documentation/auth0/totpenrollmentchallenge/init(from:).json +++ b/docs/data/documentation/auth0/totpenrollmentchallenge/init(from:).json @@ -1 +1 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge\/init(from:)","interfaceLanguage":"swift"},"schemaVersion":{"minor":3,"major":0,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge"]]},"sections":[],"metadata":{"modules":[{"name":"Auth0"}],"role":"symbol","externalID":"s:5Auth023TOTPEnrollmentChallengeV4fromACs7Decoder_p_tKcfc","symbolKind":"init","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP","text":"Decoder"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"roleHeading":"Initializer","extendedModule":"Auth0","title":"init(from:)"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/totpenrollmentchallenge\/init(from:)"]}],"abstract":[{"code":"Decodable","type":"codeVoice"},{"type":"text","text":" initializer."}],"kind":"symbol","primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":" "},{"kind":"internalParam","text":"decoder"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP","text":"Decoder"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}]}],"kind":"declarations"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/TOTPEnrollmentChallenge/init(from:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge\/init(from:)","abstract":[{"code":"Decodable","type":"codeVoice"},{"text":" initializer.","type":"text"}],"fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Decoder","preciseIdentifier":"s:s7DecoderP"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"kind":"symbol","url":"\/documentation\/auth0\/totpenrollmentchallenge\/init(from:)","title":"init(from:)","type":"topic","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/TOTPEnrollmentChallenge":{"kind":"symbol","navigatorTitle":[{"text":"TOTPEnrollmentChallenge","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge","url":"\/documentation\/auth0\/totpenrollmentchallenge","title":"TOTPEnrollmentChallenge","type":"topic","abstract":[{"type":"text","text":"A TOTP enrollment challenge."}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"TOTPEnrollmentChallenge","kind":"identifier"}]}}} \ No newline at end of file +{"abstract":[{"code":"Decodable","type":"codeVoice"},{"text":" initializer.","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"init"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"from"},{"kind":"text","text":" "},{"kind":"internalParam","text":"decoder"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Decoder","preciseIdentifier":"s:s7DecoderP"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/totpenrollmentchallenge\/init(from:)"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge"]]},"metadata":{"modules":[{"name":"Auth0"}],"title":"init(from:)","roleHeading":"Initializer","symbolKind":"init","role":"symbol","extendedModule":"Auth0","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Decoder","preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"externalID":"s:5Auth023TOTPEnrollmentChallengeV4fromACs7Decoder_p_tKcfc"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge\/init(from:)"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/TOTPEnrollmentChallenge":{"title":"TOTPEnrollmentChallenge","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"TOTPEnrollmentChallenge"}],"abstract":[{"text":"A TOTP enrollment challenge.","type":"text"}],"url":"\/documentation\/auth0\/totpenrollmentchallenge","navigatorTitle":[{"kind":"identifier","text":"TOTPEnrollmentChallenge"}]},"doc://com.auth0.Auth0/documentation/Auth0/TOTPEnrollmentChallenge/init(from:)":{"url":"\/documentation\/auth0\/totpenrollmentchallenge\/init(from:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier","text":"Decoder"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"title":"init(from:)","type":"topic","role":"symbol","abstract":[{"type":"codeVoice","code":"Decodable"},{"text":" initializer.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/TOTPEnrollmentChallenge\/init(from:)","kind":"symbol"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/trackable.json b/docs/data/documentation/auth0/trackable.json index 6f6f01d65..7a66199ad 100644 --- a/docs/data/documentation/auth0/trackable.json +++ b/docs/data/documentation/auth0/trackable.json @@ -1 +1 @@ -{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable"},"topicSections":[{"title":"Instance Properties","generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable\/telemetry"],"anchor":"Instance-Properties"},{"title":"Instance Methods","generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable\/tracking(enabled:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable\/using(inLibrary:version:)"],"anchor":"Instance-Methods"}],"relationshipsSections":[{"title":"Inherited By","kind":"relationships","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccount","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountClient","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"],"type":"inheritedBy"}],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Trackable"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/trackable"]}],"metadata":{"roleHeading":"Protocol","externalID":"s:5Auth09TrackableP","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Trackable"}],"modules":[{"name":"Auth0"}],"title":"Trackable","role":"symbol","symbolKind":"protocol","navigatorTitle":[{"text":"Trackable","kind":"identifier"}]},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"schemaVersion":{"patch":0,"major":0,"minor":3},"abstract":[{"text":"A type that can send the ","type":"text"},{"type":"codeVoice","code":"Auth0-Client"},{"text":" header on every request to Auth0.","type":"text"}],"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"title":"WebAuth","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"url":"\/documentation\/auth0\/webauth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"kind":"symbol"},"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"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccount":{"fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccount","kind":"identifier"}],"type":"topic","kind":"symbol","url":"\/documentation\/auth0\/myaccount","navigatorTitle":[{"text":"MyAccount","kind":"identifier"}],"abstract":[{"type":"text","text":"My Account API client for managing the current user’s account."}],"title":"MyAccount","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccount"},"doc://com.auth0.Auth0/documentation/Auth0/Trackable/telemetry":{"title":"telemetry","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable\/telemetry","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"telemetry"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth09TelemetryV","text":"Telemetry"}],"type":"topic","kind":"symbol","role":"symbol","url":"\/documentation\/auth0\/trackable\/telemetry","abstract":[{"type":"text","text":"The "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","isActive":true},{"type":"text","text":" instance."}],"required":true},"doc://com.auth0.Auth0/documentation/Auth0/Trackable/using(inLibrary:version:)":{"title":"using(inLibrary:version:)","type":"topic","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"using"},{"kind":"text","text":"("},{"kind":"externalParam","text":"inLibrary"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"version"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":")"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable\/using(inLibrary:version:)","kind":"symbol","role":"symbol","url":"\/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"}]},"https://auth0.com/docs/api/authentication":{"titleInlineContent":[{"text":"Auth0 Authentication API","type":"text"}],"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","title":"Auth0 Authentication API","type":"link","url":"https:\/\/auth0.com\/docs\/api\/authentication"},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"type":"topic","role":"symbol","title":"Authentication","abstract":[{"text":"Client for the ","type":"text"},{"identifier":"https:\/\/auth0.com\/docs\/api\/authentication","type":"reference","isActive":true},{"text":".","type":"text"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Authentication"}],"url":"\/documentation\/auth0\/authentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"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","url":"\/documentation\/auth0\/trackable","role":"symbol","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Trackable"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable","title":"Trackable","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Trackable"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountClient":{"type":"topic","title":"MyAccountClient","kind":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountClient","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountClient","navigatorTitle":[{"text":"MyAccountClient","kind":"identifier"}],"role":"symbol","abstract":[{"type":"text","text":"A client for the My Account API."},{"type":"text","text":" "},{"type":"text","text":"Adopting types could be either the root client or a leaf sub-client."}],"url":"\/documentation\/auth0\/myaccountclient"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods":{"url":"\/documentation\/auth0\/myaccountauthenticationmethods","kind":"symbol","type":"topic","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"MyAccountAuthenticationMethods","kind":"identifier"}],"navigatorTitle":[{"text":"MyAccountAuthenticationMethods","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods","title":"MyAccountAuthenticationMethods","abstract":[{"type":"text","text":"My Account API sub-client for managing the current user’s authentication methods."}]},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"type":"topic","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Users","kind":"identifier"}],"title":"Users","navigatorTitle":[{"text":"Users","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","url":"\/documentation\/auth0\/users","kind":"symbol","abstract":[{"type":"text","text":"Client for the Users endpoints of the Auth0 "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"type":"text","text":"."}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Trackable/tracking(enabled:)":{"type":"topic","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"tracking"},{"kind":"text","text":"("},{"kind":"externalParam","text":"enabled"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":")"}],"kind":"symbol","role":"symbol","abstract":[{"type":"text","text":"Turn on\/off sending the "},{"code":"Auth0-Client","type":"codeVoice"},{"type":"text","text":" header on every request to Auth0."},{"type":"text","text":" "},{"type":"text","text":"By default we collect our libraries and SDKs versions to help us evaluate usage."}],"url":"\/documentation\/auth0\/trackable\/tracking(enabled:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable\/tracking(enabled:)","title":"tracking(enabled:)"},"doc://com.auth0.Auth0/documentation/Auth0/Telemetry":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Telemetry","kind":"identifier"}],"title":"Telemetry","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","url":"\/documentation\/auth0\/telemetry","kind":"symbol","abstract":[{"text":"Generates and sets the ","type":"text"},{"type":"codeVoice","code":"Auth0-Client"},{"text":" header.","type":"text"}],"role":"symbol","navigatorTitle":[{"text":"Telemetry","kind":"identifier"}],"type":"topic"}}} \ No newline at end of file +{"abstract":[{"type":"text","text":"A type that can send the "},{"type":"codeVoice","code":"Auth0-Client"},{"type":"text","text":" header on every request to Auth0."}],"relationshipsSections":[{"type":"inheritedBy","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccount","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountClient","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"],"kind":"relationships","title":"Inherited By"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Trackable","kind":"identifier"}],"languages":["swift"],"platforms":["iOS"]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/trackable"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable\/telemetry"],"generated":true,"title":"Instance Properties","anchor":"Instance-Properties"},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable\/tracking(enabled:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable\/using(inLibrary:version:)"],"generated":true,"title":"Instance Methods","anchor":"Instance-Methods"}],"metadata":{"symbolKind":"protocol","modules":[{"name":"Auth0"}],"title":"Trackable","navigatorTitle":[{"text":"Trackable","kind":"identifier"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Trackable"}],"externalID":"s:5Auth09TrackableP","role":"symbol","roleHeading":"Protocol"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/MyAccountClient":{"title":"MyAccountClient","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountClient","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccountClient"}],"abstract":[{"text":"A client for the My Account API.","type":"text"},{"text":" ","type":"text"},{"text":"Adopting types could be either the root client or a leaf sub-client.","type":"text"}],"url":"\/documentation\/auth0\/myaccountclient","navigatorTitle":[{"kind":"identifier","text":"MyAccountClient"}]},"doc://com.auth0.Auth0/documentation/Auth0/Trackable/telemetry":{"type":"topic","abstract":[{"text":"The ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","type":"reference","isActive":true},{"text":" instance.","type":"text"}],"title":"telemetry","url":"\/documentation\/auth0\/trackable\/telemetry","kind":"symbol","required":true,"role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"telemetry","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Telemetry","preciseIdentifier":"s:5Auth09TelemetryV","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable\/telemetry"},"doc://com.auth0.Auth0/documentation/Auth0/Trackable":{"title":"Trackable","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Trackable"}],"abstract":[{"text":"A type that can send the ","type":"text"},{"code":"Auth0-Client","type":"codeVoice"},{"text":" header on every request to Auth0.","type":"text"}],"url":"\/documentation\/auth0\/trackable","navigatorTitle":[{"kind":"identifier","text":"Trackable"}]},"doc://com.auth0.Auth0/documentation/Auth0/MyAccountAuthenticationMethods":{"role":"symbol","title":"MyAccountAuthenticationMethods","fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"kind":"identifier","text":"MyAccountAuthenticationMethods"}],"navigatorTitle":[{"text":"MyAccountAuthenticationMethods","kind":"identifier"}],"abstract":[{"type":"text","text":"My Account API sub-client for managing the current user’s authentication methods."}],"kind":"symbol","url":"\/documentation\/auth0\/myaccountauthenticationmethods","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccountAuthenticationMethods","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/MyAccount":{"url":"\/documentation\/auth0\/myaccount","abstract":[{"type":"text","text":"My Account API client for managing the current user’s account."}],"title":"MyAccount","navigatorTitle":[{"text":"MyAccount","kind":"identifier"}],"fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"MyAccount"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/MyAccount","role":"symbol","kind":"symbol","type":"topic"},"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/WebAuth":{"url":"\/documentation\/auth0\/webauth","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"title":"WebAuth","navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Telemetry":{"kind":"symbol","abstract":[{"text":"Generates and sets the ","type":"text"},{"code":"Auth0-Client","type":"codeVoice"},{"text":" header.","type":"text"}],"type":"topic","title":"Telemetry","url":"\/documentation\/auth0\/telemetry","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Telemetry"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","navigatorTitle":[{"kind":"identifier","text":"Telemetry"}]},"doc://com.auth0.Auth0/documentation/Auth0/Trackable/using(inLibrary:version:)":{"type":"topic","title":"using(inLibrary:version:)","url":"\/documentation\/auth0\/trackable\/using(inlibrary:version:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable\/using(inLibrary:version:)","kind":"symbol","abstract":[{"type":"text","text":"Includes the name and version of the library\/framework which has Auth0.swift as dependency."}],"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"using"},{"kind":"text","text":"("},{"kind":"externalParam","text":"inLibrary"},{"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"},{"kind":"text","text":")"}]},"doc://com.auth0.Auth0/documentation/Auth0/Authentication":{"kind":"symbol","abstract":[{"type":"text","text":"Client for the "},{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/authentication","isActive":true},{"type":"text","text":"."}],"type":"topic","title":"Authentication","url":"\/documentation\/auth0\/authentication","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"Authentication","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Authentication","navigatorTitle":[{"kind":"identifier","text":"Authentication"}]},"https://auth0.com/docs/api/management/v2":{"url":"https:\/\/auth0.com\/docs\/api\/management\/v2","title":"Management API v2","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","titleInlineContent":[{"type":"text","text":"Management API v2"}],"type":"link"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"url":"\/documentation\/auth0\/users","title":"Users","abstract":[{"type":"text","text":"Client for the Users endpoints of the Auth0 "},{"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","type":"reference","isActive":true},{"text":".","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"Users"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Users"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Trackable/tracking(enabled:)":{"url":"\/documentation\/auth0\/trackable\/tracking(enabled:)","title":"tracking(enabled:)","abstract":[{"type":"text","text":"Turn on\/off sending the "},{"type":"codeVoice","code":"Auth0-Client"},{"type":"text","text":" header on every request to Auth0."},{"type":"text","text":" "},{"type":"text","text":"By default we collect our libraries and SDKs versions to help us evaluate usage."}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"tracking","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"enabled"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"text":")","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable\/tracking(enabled:)","role":"symbol","kind":"symbol","type":"topic"}}} \ 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 a459920b5..e05a84899 100644 --- a/docs/data/documentation/auth0/trackable/telemetry.json +++ b/docs/data/documentation/auth0/trackable/telemetry.json @@ -1 +1 @@ -{"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"telemetry","kind":"identifier"},{"text":": ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","preciseIdentifier":"s:5Auth09TelemetryV","text":"Telemetry","kind":"typeIdentifier"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" ","kind":"text"},{"text":"set","kind":"keyword"},{"text":" }","kind":"text"}]}]}],"abstract":[{"type":"text","text":"The "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","isActive":true},{"type":"text","text":" instance."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable"]]},"metadata":{"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"telemetry"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth09TelemetryV","text":"Telemetry"}],"modules":[{"name":"Auth0"}],"title":"telemetry","externalID":"s:5Auth09TrackableP9telemetryAA9TelemetryVvp","required":true,"role":"symbol","symbolKind":"property","roleHeading":"Instance Property"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/trackable\/telemetry"]}],"schemaVersion":{"minor":3,"major":0,"patch":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable\/telemetry"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Telemetry":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Telemetry","kind":"identifier"}],"title":"Telemetry","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","url":"\/documentation\/auth0\/telemetry","kind":"symbol","abstract":[{"text":"Generates and sets the ","type":"text"},{"type":"codeVoice","code":"Auth0-Client"},{"text":" header.","type":"text"}],"role":"symbol","navigatorTitle":[{"text":"Telemetry","kind":"identifier"}],"type":"topic"},"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","url":"\/documentation\/auth0\/trackable","role":"symbol","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Trackable"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable","title":"Trackable","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Trackable"}]},"doc://com.auth0.Auth0/documentation/Auth0/Trackable/telemetry":{"title":"telemetry","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable\/telemetry","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"telemetry"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth09TelemetryV","text":"Telemetry"}],"type":"topic","kind":"symbol","role":"symbol","url":"\/documentation\/auth0\/trackable\/telemetry","abstract":[{"type":"text","text":"The "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","isActive":true},{"type":"text","text":" instance."}],"required":true}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/trackable\/telemetry"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable"]]},"abstract":[{"type":"text","text":"The "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","isActive":true,"type":"reference"},{"type":"text","text":" instance."}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"telemetry"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","preciseIdentifier":"s:5Auth09TelemetryV","text":"Telemetry"},{"kind":"text","text":" { "},{"text":"get","kind":"keyword"},{"text":" ","kind":"text"},{"text":"set","kind":"keyword"},{"kind":"text","text":" }"}]}],"kind":"declarations"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"kind":"symbol","metadata":{"roleHeading":"Instance Property","symbolKind":"property","role":"symbol","title":"telemetry","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"telemetry","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth09TelemetryV","text":"Telemetry","kind":"typeIdentifier"}],"required":true,"externalID":"s:5Auth09TrackableP9telemetryAA9TelemetryVvp","modules":[{"name":"Auth0"}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable\/telemetry"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Trackable/telemetry":{"type":"topic","abstract":[{"text":"The ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","type":"reference","isActive":true},{"text":" instance.","type":"text"}],"title":"telemetry","url":"\/documentation\/auth0\/trackable\/telemetry","kind":"symbol","required":true,"role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"telemetry","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Telemetry","preciseIdentifier":"s:5Auth09TelemetryV","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable\/telemetry"},"doc://com.auth0.Auth0/documentation/Auth0/Trackable":{"title":"Trackable","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Trackable"}],"abstract":[{"text":"A type that can send the ","type":"text"},{"code":"Auth0-Client","type":"codeVoice"},{"text":" header on every request to Auth0.","type":"text"}],"url":"\/documentation\/auth0\/trackable","navigatorTitle":[{"kind":"identifier","text":"Trackable"}]},"doc://com.auth0.Auth0/documentation/Auth0/Telemetry":{"kind":"symbol","abstract":[{"text":"Generates and sets the ","type":"text"},{"code":"Auth0-Client","type":"codeVoice"},{"text":" header.","type":"text"}],"type":"topic","title":"Telemetry","url":"\/documentation\/auth0\/telemetry","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Telemetry"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","navigatorTitle":[{"kind":"identifier","text":"Telemetry"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ 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 5333cc38a..8d6259dcf 100644 --- a/docs/data/documentation/auth0/trackable/tracking(enabled:).json +++ b/docs/data/documentation/auth0/trackable/tracking(enabled:).json @@ -1 +1 @@ -{"abstract":[{"text":"Turn on\/off sending the ","type":"text"},{"type":"codeVoice","code":"Auth0-Client"},{"text":" header on every request to Auth0.","type":"text"},{"text":" ","type":"text"},{"text":"By default we collect our libraries and SDKs versions to help us evaluate usage.","type":"text"}],"schemaVersion":{"patch":0,"major":0,"minor":3},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/trackable\/tracking(enabled:)"]}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"mutating","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"tracking","kind":"identifier"},{"text":"(","kind":"text"},{"text":"enabled","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"text":")","kind":"text"}],"languages":["swift"]}],"kind":"declarations"},{"parameters":[{"content":[{"type":"paragraph","inlineContent":[{"text":"Flag to turn telemetry on\/off.","type":"text"}]}],"name":"enabled"}],"kind":"parameters"}],"metadata":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"tracking","kind":"identifier"},{"text":"(","kind":"text"},{"text":"enabled","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"text":")","kind":"text"}],"externalID":"s:5Auth09TrackablePAAE8tracking7enabledySb_tF","role":"symbol","symbolKind":"method","extendedModule":"Auth0","modules":[{"name":"Auth0"}],"roleHeading":"Instance Method","title":"tracking(enabled:)"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable"]]},"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable\/tracking(enabled:)"},"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","url":"\/documentation\/auth0\/trackable","role":"symbol","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Trackable"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable","title":"Trackable","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Trackable"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Trackable/tracking(enabled:)":{"type":"topic","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"tracking"},{"kind":"text","text":"("},{"kind":"externalParam","text":"enabled"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":")"}],"kind":"symbol","role":"symbol","abstract":[{"type":"text","text":"Turn on\/off sending the "},{"code":"Auth0-Client","type":"codeVoice"},{"type":"text","text":" header on every request to Auth0."},{"type":"text","text":" "},{"type":"text","text":"By default we collect our libraries and SDKs versions to help us evaluate usage."}],"url":"\/documentation\/auth0\/trackable\/tracking(enabled:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable\/tracking(enabled:)","title":"tracking(enabled:)"}}} \ No newline at end of file +{"schemaVersion":{"patch":0,"major":0,"minor":3},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"mutating"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"tracking"},{"kind":"text","text":"("},{"kind":"externalParam","text":"enabled"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"},{"kind":"text","text":")"}],"platforms":["iOS"]}]},{"parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Flag to turn telemetry on\/off."}]}],"name":"enabled"}],"kind":"parameters"}],"sections":[],"abstract":[{"text":"Turn on\/off sending the ","type":"text"},{"code":"Auth0-Client","type":"codeVoice"},{"text":" header on every request to Auth0.","type":"text"},{"text":" ","type":"text"},{"text":"By default we collect our libraries and SDKs versions to help us evaluate usage.","type":"text"}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/trackable\/tracking(enabled:)"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable\/tracking(enabled:)","interfaceLanguage":"swift"},"metadata":{"role":"symbol","title":"tracking(enabled:)","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"tracking"},{"kind":"text","text":"("},{"kind":"externalParam","text":"enabled"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":")"}],"externalID":"s:5Auth09TrackablePAAE8tracking7enabledySb_tF","extendedModule":"Auth0","roleHeading":"Instance Method","symbolKind":"method"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Trackable":{"title":"Trackable","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Trackable"}],"abstract":[{"text":"A type that can send the ","type":"text"},{"code":"Auth0-Client","type":"codeVoice"},{"text":" header on every request to Auth0.","type":"text"}],"url":"\/documentation\/auth0\/trackable","navigatorTitle":[{"kind":"identifier","text":"Trackable"}]},"doc://com.auth0.Auth0/documentation/Auth0/Trackable/tracking(enabled:)":{"url":"\/documentation\/auth0\/trackable\/tracking(enabled:)","title":"tracking(enabled:)","abstract":[{"type":"text","text":"Turn on\/off sending the "},{"type":"codeVoice","code":"Auth0-Client"},{"type":"text","text":" header on every request to Auth0."},{"type":"text","text":" "},{"type":"text","text":"By default we collect our libraries and SDKs versions to help us evaluate usage."}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"tracking","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"enabled"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"text":")","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable\/tracking(enabled:)","role":"symbol","kind":"symbol","type":"topic"}}} \ 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 189c719fb..b486db23e 100644 --- a/docs/data/documentation/auth0/trackable/using(inlibrary:version:).json +++ b/docs/data/documentation/auth0/trackable/using(inlibrary:version:).json @@ -1 +1 @@ -{"sections":[],"abstract":[{"text":"Includes the name and version of the library\/framework which has Auth0.swift as dependency.","type":"text"}],"schemaVersion":{"minor":3,"major":0,"patch":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/trackable\/using(inlibrary:version:)"]}],"kind":"symbol","metadata":{"extendedModule":"Auth0","modules":[{"name":"Auth0"}],"role":"symbol","symbolKind":"method","externalID":"s:5Auth09TrackablePAAE5using9inLibrary7versionySS_SStF","roleHeading":"Instance Method","title":"using(inLibrary:version:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"using"},{"kind":"text","text":"("},{"kind":"externalParam","text":"inLibrary"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"version"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":")"}]},"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"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"mutating","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"using","kind":"identifier"},{"text":"(","kind":"text"},{"text":"inLibrary","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"name","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"version","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":")","kind":"text"}]}]},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"text":"Name of library or framework that uses Auth0.swift.","type":"text"}],"type":"paragraph"}],"name":"name"},{"content":[{"type":"paragraph","inlineContent":[{"text":"Version of library or framework.","type":"text"}]}],"name":"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","url":"\/documentation\/auth0\/trackable","role":"symbol","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Trackable"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable","title":"Trackable","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Trackable"}]},"doc://com.auth0.Auth0/documentation/Auth0/Trackable/using(inLibrary:version:)":{"title":"using(inLibrary:version:)","type":"topic","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"using"},{"kind":"text","text":"("},{"kind":"externalParam","text":"inLibrary"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"version"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":")"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable\/using(inLibrary:version:)","kind":"symbol","role":"symbol","url":"\/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"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"metadata":{"symbolKind":"method","title":"using(inLibrary:version:)","externalID":"s:5Auth09TrackablePAAE5using9inLibrary7versionySS_SStF","extendedModule":"Auth0","roleHeading":"Instance Method","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"using"},{"kind":"text","text":"("},{"kind":"externalParam","text":"inLibrary"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"version"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":")","kind":"text"}],"role":"symbol"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/trackable\/using(inlibrary:version:)"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable\/using(inLibrary:version:)","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"type":"text","text":"Includes the name and version of the library\/framework which has Auth0.swift as dependency."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"mutating","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"using","kind":"identifier"},{"text":"(","kind":"text"},{"text":"inLibrary","kind":"externalParam"},{"kind":"text","text":" "},{"kind":"internalParam","text":"name"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"version","kind":"externalParam"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":")","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}]},{"parameters":[{"content":[{"inlineContent":[{"text":"Name of library or framework that uses Auth0.swift.","type":"text"}],"type":"paragraph"}],"name":"name"},{"content":[{"inlineContent":[{"type":"text","text":"Version of library or framework."}],"type":"paragraph"}],"name":"version"}],"kind":"parameters"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Trackable/using(inLibrary:version:)":{"type":"topic","title":"using(inLibrary:version:)","url":"\/documentation\/auth0\/trackable\/using(inlibrary:version:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable\/using(inLibrary:version:)","kind":"symbol","abstract":[{"type":"text","text":"Includes the name and version of the library\/framework which has Auth0.swift as dependency."}],"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"using"},{"kind":"text","text":"("},{"kind":"externalParam","text":"inLibrary"},{"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"},{"kind":"text","text":")"}]},"doc://com.auth0.Auth0/documentation/Auth0/Trackable":{"title":"Trackable","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Trackable"}],"abstract":[{"text":"A type that can send the ","type":"text"},{"code":"Auth0-Client","type":"codeVoice"},{"text":" header on every request to Auth0.","type":"text"}],"url":"\/documentation\/auth0\/trackable","navigatorTitle":[{"kind":"identifier","text":"Trackable"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"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 c649c4956..4cb91b8a3 100644 --- a/docs/data/documentation/auth0/useragents.json +++ b/docs/data/documentation/auth0/useragents.json @@ -1 +1 @@ -{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/useragents"]}],"metadata":{"modules":[{"name":"Auth0"}],"roleHeading":"Article","role":"article","title":"ASWebAuthenticationSession vs SFSafariViewController (iOS)"},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"schemaVersion":{"patch":0,"major":0,"minor":3},"primaryContentSections":[{"kind":"content","content":[{"level":2,"anchor":"Overview","type":"heading","text":"Overview"},{"inlineContent":[{"type":"text","text":"Web-based authentication needs an in-app browser. Auth0.swift offers the choice of two system-provided browser APIs: "},{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/aswebauthenticationsession","isActive":true,"type":"reference"},{"type":"text","text":" and "},{"identifier":"https:\/\/developer.apple.com\/documentation\/safariservices\/sfsafariviewcontroller","isActive":true,"type":"reference"},{"type":"text","text":"."}],"type":"paragraph"},{"level":2,"anchor":"When-to-use-ASWebAuthenticationSession","type":"heading","text":"When to use ASWebAuthenticationSession"},{"inlineContent":[{"code":"ASWebAuthenticationSession","type":"codeVoice"},{"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"},{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/aswebauthenticationsession\/3237231-prefersephemeralwebbrowsersessio","isActive":true,"type":"reference"},{"text":" option.","type":"text"}],"type":"paragraph"},{"style":"note","type":"aside","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+."}]}]},{"level":3,"anchor":"Without-ephemeral-sessions-the-default","type":"heading","text":"Without ephemeral sessions (the default)"},{"code":["Auth0"," .webAuth()"," .start { result in"," \/\/ ..."," }"],"type":"codeListing","syntax":"swift"},{"inlineContent":[{"type":"text","text":"By default, Auth0.swift uses "},{"type":"codeVoice","code":"ASWebAuthenticationSession"},{"type":"text","text":" with "},{"type":"codeVoice","code":"prefersEphemeralWebBrowserSession"},{"type":"text","text":" set to "},{"type":"codeVoice","code":"false"},{"type":"text","text":". This means that:"}],"type":"paragraph"},{"items":[{"content":[{"type":"paragraph","inlineContent":[{"text":"The session cookie will be shared with the Safari app.","type":"text"}]}]},{"content":[{"inlineContent":[{"type":"text","text":"An alert box will be shown when logging in –and logging out– asking for consent, as the session cookie will be placed in a shared jar. This alert box is displayed and managed by "},{"type":"codeVoice","code":"ASWebAuthenticationSession"},{"type":"text","text":", not Auth0.swift, and unfortunately it is not customizable."}],"type":"paragraph"}]}],"type":"unorderedList"},{"level":4,"anchor":"You-want-this-if","type":"heading","text":"You want this if…"},{"items":[{"content":[{"inlineContent":[{"type":"strong","inlineContent":[{"text":"You need SSO between your app and your website","type":"text"}]},{"type":"text","text":", when your website is accessed through the Safari app. SSO will not work with any other browser, like Chrome or Firefox."}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"strong","inlineContent":[{"text":"You need SSO across apps","type":"text"}]},{"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"}]},{"type":"text","text":" apps."}]}]}],"type":"unorderedList"},{"level":3,"anchor":"With-ephemeral-sessions","type":"heading","text":"With ephemeral sessions"},{"inlineContent":[{"text":"Auth0.swift allows to set ","type":"text"},{"type":"codeVoice","code":"prefersEphemeralWebBrowserSession"},{"text":" to ","type":"text"},{"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"," \/\/ ..."," }"],"type":"codeListing","syntax":"swift"},{"inlineContent":[{"code":"prefersEphemeralWebBrowserSession","type":"codeVoice"},{"type":"text","text":" being set to "},{"code":"true","type":"codeVoice"},{"type":"text","text":" means that:"}],"type":"paragraph"},{"items":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The session cookie will not be persisted. As soon as the "},{"type":"codeVoice","code":"ASWebAuthenticationSession"},{"type":"text","text":" window closes, the cookie will be gone. This is akin to using a desktop browser in incognito mode."}]}]},{"content":[{"inlineContent":[{"type":"text","text":"Any features that rely on the persistence of cookies –like SSO, or “Remember this device”– "},{"type":"strong","inlineContent":[{"text":"will not work","type":"text"}]},{"type":"text","text":"."}],"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":[{"type":"text","text":"There will be no need to call "},{"code":"clearSession()","type":"codeVoice"},{"type":"text","text":". What "},{"code":"clearSession()","type":"codeVoice"},{"type":"text","text":" does is remove the persisted session cookie. Now there will be no session cookie to remove, so it won’t do anything. To log the user out, just delete any stored credentials –for example, by calling the "},{"code":"clear()","type":"codeVoice"},{"type":"text","text":" method of the Credentials Manager."}]}]}],"type":"unorderedList"},{"level":4,"anchor":"You-want-this-if","type":"heading","text":"You want this if…"},{"items":[{"content":[{"type":"paragraph","inlineContent":[{"type":"strong","inlineContent":[{"text":"You don’t need SSO at all","type":"text"}]},{"type":"text","text":". Since the session cookie won’t be persisted, SSO will be effectively disabled."}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"strong","inlineContent":[{"text":"You don’t need any features that rely on the persistence of cookies","type":"text"}]},{"type":"text","text":", like “Remember this device”."}]}]}],"type":"unorderedList"},{"level":2,"anchor":"When-to-use-SFSafariViewController","type":"heading","text":"When to use SFSafariViewController"},{"code":["Auth0"," .webAuth()"," .provider(WebAuthentication.safariProvider())"," .start { result in"," \/\/ ..."," }"],"type":"codeListing","syntax":"swift"},{"inlineContent":[{"code":"SFSafariViewController","type":"codeVoice"},{"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":"text"},{"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":"paragraph"},{"items":[{"content":[{"type":"paragraph","inlineContent":[{"text":"All the ","type":"text"},{"code":"SFSafariViewController","type":"codeVoice"},{"text":" instances used in your app will have access to the persisted session cookie.","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":[{"type":"text","text":"All the features that rely on the persistence of cookies –like “Remember this device”– "},{"type":"strong","inlineContent":[{"type":"text","text":"will work"}]},{"type":"text","text":" as expected."}]}]}],"type":"unorderedList"},{"style":"note","type":"aside","name":"Note","content":[{"inlineContent":[{"type":"text","text":""},{"type":"codeVoice","code":"SFSafariViewController"},{"type":"text","text":" does not support using Universal Links as callback URLs."}],"type":"paragraph"}]},{"level":4,"anchor":"You-want-this-if","type":"heading","text":"You want this if…"},{"items":[{"content":[{"inlineContent":[{"inlineContent":[{"text":"You need SSO between your app and your website","type":"text"}],"type":"strong"},{"type":"text","text":", when your website is accessed through another "},{"type":"codeVoice","code":"SFSafariViewController"},{"type":"text","text":" instance in your app."}],"type":"paragraph"}]}],"type":"unorderedList"}]}],"kind":"article","seeAlsoSections":[{"anchor":"Related-Documentation","identifiers":["https:\/\/github.com\/auth0\/Auth0.swift\/blob\/master\/FAQ.md"],"title":"Related Documentation"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserAgents","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"https://developer.apple.com/documentation/safariservices/sfsafariviewcontroller":{"type":"link","url":"https:\/\/developer.apple.com\/documentation\/safariservices\/sfsafariviewcontroller","identifier":"https:\/\/developer.apple.com\/documentation\/safariservices\/sfsafariviewcontroller","titleInlineContent":[{"code":"SFSafariViewController","type":"codeVoice"}],"title":"SFSafariViewController"},"https://developer.apple.com/documentation/authenticationservices/aswebauthenticationsession/3237231-prefersephemeralwebbrowsersessio":{"type":"link","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/aswebauthenticationsession\/3237231-prefersephemeralwebbrowsersessio","title":"prefersEphemeralWebBrowserSession","titleInlineContent":[{"code":"prefersEphemeralWebBrowserSession","type":"codeVoice"}],"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/aswebauthenticationsession\/3237231-prefersephemeralwebbrowsersessio"},"https://developer.apple.com/documentation/authenticationservices/aswebauthenticationsession":{"type":"link","url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/aswebauthenticationsession","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/aswebauthenticationsession","titleInlineContent":[{"code":"ASWebAuthenticationSession","type":"codeVoice"}],"title":"ASWebAuthenticationSession"},"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"}}} \ No newline at end of file +{"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserAgents","interfaceLanguage":"swift"},"kind":"article","metadata":{"modules":[{"name":"Auth0"}],"role":"article","title":"ASWebAuthenticationSession vs SFSafariViewController (iOS)","roleHeading":"Article"},"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/github.com\/auth0\/Auth0.swift\/blob\/master\/FAQ.md"],"anchor":"Related-Documentation"}],"variants":[{"paths":["\/documentation\/auth0\/useragents"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"primaryContentSections":[{"content":[{"level":2,"anchor":"Overview","type":"heading","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: "},{"identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/aswebauthenticationsession","type":"reference","isActive":true},{"type":"text","text":" and "},{"identifier":"https:\/\/developer.apple.com\/documentation\/safariservices\/sfsafariviewcontroller","type":"reference","isActive":true},{"type":"text","text":"."}]},{"type":"heading","text":"When to use ASWebAuthenticationSession","anchor":"When-to-use-ASWebAuthenticationSession","level":2},{"type":"paragraph","inlineContent":[{"code":"ASWebAuthenticationSession","type":"codeVoice"},{"type":"text","text":" is an API provided specifically for performing web-based authentication. It is not meant for general-purpose browsing, and exposes a pretty limited API. "},{"code":"ASWebAuthenticationSession","type":"codeVoice"},{"type":"text","text":" can be used with or without ephemeral sessions enabled –through the "},{"type":"reference","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/aswebauthenticationsession\/3237231-prefersephemeralwebbrowsersessio","isActive":true},{"type":"text","text":" option."}]},{"type":"aside","style":"note","content":[{"inlineContent":[{"type":"text","text":""},{"type":"codeVoice","code":"ASWebAuthenticationSession"},{"type":"text","text":" supports using Universal Links as callback and logout URLs on iOS 174+ and macOS 14.4+."}],"type":"paragraph"}],"name":"Note"},{"type":"heading","text":"Without ephemeral sessions (the default)","anchor":"Without-ephemeral-sessions-the-default","level":3},{"type":"codeListing","syntax":"swift","code":["Auth0"," .webAuth()"," .start { result in"," \/\/ ..."," }"]},{"type":"paragraph","inlineContent":[{"type":"text","text":"By default, Auth0.swift uses "},{"code":"ASWebAuthenticationSession","type":"codeVoice"},{"type":"text","text":" with "},{"code":"prefersEphemeralWebBrowserSession","type":"codeVoice"},{"type":"text","text":" set to "},{"code":"false","type":"codeVoice"},{"type":"text","text":". This means that:"}]},{"type":"unorderedList","items":[{"content":[{"inlineContent":[{"text":"The session cookie will be shared with the Safari app.","type":"text"}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"type":"text","text":"An alert box will be shown when logging in –and logging out– asking for consent, as the session cookie will be placed in a shared jar. This alert box is displayed and managed by "},{"type":"codeVoice","code":"ASWebAuthenticationSession"},{"type":"text","text":", not Auth0.swift, and unfortunately it is not customizable."}],"type":"paragraph"}]}]},{"type":"heading","level":4,"text":"You want this if…","anchor":"You-want-this-if"},{"type":"unorderedList","items":[{"content":[{"type":"paragraph","inlineContent":[{"inlineContent":[{"type":"text","text":"You need SSO between your app and your website"}],"type":"strong"},{"type":"text","text":", when your website is accessed through the Safari app. SSO will not work with any other browser, like Chrome or Firefox."}]}]},{"content":[{"type":"paragraph","inlineContent":[{"inlineContent":[{"type":"text","text":"You need SSO across apps"}],"type":"strong"},{"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 "},{"inlineContent":[{"type":"text","text":"all"}],"type":"emphasis"},{"type":"text","text":" apps."}]}]}]},{"type":"heading","text":"With ephemeral sessions","anchor":"With-ephemeral-sessions","level":3},{"type":"paragraph","inlineContent":[{"type":"text","text":"Auth0.swift allows to set "},{"type":"codeVoice","code":"prefersEphemeralWebBrowserSession"},{"type":"text","text":" to "},{"type":"codeVoice","code":"true"},{"type":"text","text":", by calling "},{"type":"codeVoice","code":"useEphemeralSession()"},{"type":"text","text":"."}]},{"type":"codeListing","syntax":"swift","code":["Auth0"," .webAuth()"," .useEphemeralSession()"," .start { result in"," \/\/ ..."," }"]},{"type":"paragraph","inlineContent":[{"type":"codeVoice","code":"prefersEphemeralWebBrowserSession"},{"type":"text","text":" being set to "},{"type":"codeVoice","code":"true"},{"type":"text","text":" means that:"}]},{"type":"unorderedList","items":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The session cookie will not be persisted. As soon as the "},{"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."}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Any features that rely on the persistence of cookies –like SSO, or “Remember this device”– "},{"inlineContent":[{"type":"text","text":"will not work"}],"type":"strong"},{"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":[{"type":"paragraph","inlineContent":[{"type":"text","text":"There will be no need to call "},{"code":"clearSession()","type":"codeVoice"},{"type":"text","text":". What "},{"code":"clearSession()","type":"codeVoice"},{"type":"text","text":" does is remove the persisted session cookie. Now there will be no session cookie to remove, so it won’t do anything. To log the user out, just delete any stored credentials –for example, by calling the "},{"code":"clear()","type":"codeVoice"},{"type":"text","text":" method of the Credentials Manager."}]}]}]},{"type":"heading","text":"You want this if…","anchor":"You-want-this-if","level":4},{"type":"unorderedList","items":[{"content":[{"type":"paragraph","inlineContent":[{"inlineContent":[{"type":"text","text":"You don’t need SSO at all"}],"type":"strong"},{"type":"text","text":". Since the session cookie won’t be persisted, SSO will be effectively disabled."}]}]},{"content":[{"type":"paragraph","inlineContent":[{"inlineContent":[{"type":"text","text":"You don’t need any features that rely on the persistence of cookies"}],"type":"strong"},{"type":"text","text":", like “Remember this device”."}]}]}]},{"type":"heading","text":"When to use SFSafariViewController","anchor":"When-to-use-SFSafariViewController","level":2},{"type":"codeListing","syntax":"swift","code":["Auth0"," .webAuth()"," .provider(WebAuthentication.safariProvider())"," .start { result in"," \/\/ ..."," }"]},{"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"},{"type":"text","text":" with and without ephemeral sessions. It persists cookies, but won’t share them outside of your app. This means that:"}]},{"type":"unorderedList","items":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"All the "},{"code":"SFSafariViewController","type":"codeVoice"},{"type":"text","text":" instances used in your app will have access to the persisted session cookie."}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"No consent alert box will be shown, as the session cookie won’t be placed in a shared cookie jar."}]}]},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"All the features that rely on the persistence of cookies –like “Remember this device”– "},{"inlineContent":[{"type":"text","text":"will work"}],"type":"strong"},{"type":"text","text":" as expected."}]}]}]},{"type":"aside","style":"note","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":""},{"type":"codeVoice","code":"SFSafariViewController"},{"type":"text","text":" does not support using Universal Links as callback URLs."}]}],"name":"Note"},{"type":"heading","text":"You want this if…","anchor":"You-want-this-if","level":4},{"type":"unorderedList","items":[{"content":[{"type":"paragraph","inlineContent":[{"inlineContent":[{"type":"text","text":"You need SSO between your app and your website"}],"type":"strong"},{"type":"text","text":", when your website is accessed through another "},{"code":"SFSafariViewController","type":"codeVoice"},{"type":"text","text":" instance in your app."}]}]}]}],"kind":"content"}],"references":{"https://developer.apple.com/documentation/safariservices/sfsafariviewcontroller":{"title":"SFSafariViewController","type":"link","identifier":"https:\/\/developer.apple.com\/documentation\/safariservices\/sfsafariviewcontroller","titleInlineContent":[{"type":"codeVoice","code":"SFSafariViewController"}],"url":"https:\/\/developer.apple.com\/documentation\/safariservices\/sfsafariviewcontroller"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"https://developer.apple.com/documentation/authenticationservices/aswebauthenticationsession":{"title":"ASWebAuthenticationSession","type":"link","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/aswebauthenticationsession","titleInlineContent":[{"type":"codeVoice","code":"ASWebAuthenticationSession"}],"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/aswebauthenticationsession"},"https://github.com/auth0/Auth0.swift/blob/master/FAQ.md":{"title":"FAQ","type":"link","identifier":"https:\/\/github.com\/auth0\/Auth0.swift\/blob\/master\/FAQ.md","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":{"title":"prefersEphemeralWebBrowserSession","type":"link","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/aswebauthenticationsession\/3237231-prefersephemeralwebbrowsersessio","titleInlineContent":[{"type":"codeVoice","code":"prefersEphemeralWebBrowserSession"}],"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/aswebauthenticationsession\/3237231-prefersephemeralwebbrowsersessio"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/userinfo.json b/docs/data/documentation/auth0/userinfo.json index 396405447..180d80076 100644 --- a/docs/data/documentation/auth0/userinfo.json +++ b/docs/data/documentation/auth0/userinfo.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"topicSections":[{"title":"Initializers","generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/init(json:)"],"anchor":"Initializers"},{"title":"Instance Properties","generated":true,"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"],"anchor":"Instance-Properties"},{"title":"Type Properties","generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/publicClaims"],"anchor":"Type-Properties"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"UserInfo"}],"languages":["swift"],"platforms":["iOS"]}]}],"metadata":{"externalID":"s:5Auth08UserInfoV","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"role":"symbol","roleHeading":"Structure","title":"UserInfo","modules":[{"name":"Auth0"}],"navigatorTitle":[{"kind":"identifier","text":"UserInfo"}],"symbolKind":"struct"},"schemaVersion":{"minor":3,"patch":0,"major":0},"variants":[{"paths":["\/documentation\/auth0\/userinfo"],"traits":[{"interfaceLanguage":"swift"}]}],"relationshipsSections":[{"kind":"relationships","title":"Conforms To","type":"conformsTo","identifiers":["doc:\/\/com.auth0.Auth0\/s8SendableP","doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP"]}],"kind":"symbol","seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/json-web-tokens\/json-web-token-claims"],"anchor":"Related-Documentation"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"},"sections":[],"abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/website":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/website","kind":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"website","kind":"identifier"},{"text":": ","kind":"text"},{"text":"URL","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV"},{"text":"?","kind":"text"}],"abstract":[{"type":"text","text":"The URL of the user’s website."}],"title":"website","url":"\/documentation\/auth0\/userinfo\/website","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/emailVerified":{"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"emailVerified","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/emailVerified","url":"\/documentation\/auth0\/userinfo\/emailverified","kind":"symbol","abstract":[{"type":"text","text":"If the user’s email is verified."}],"title":"emailVerified","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/name":{"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"name","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/name","url":"\/documentation\/auth0\/userinfo\/name","kind":"symbol","abstract":[{"text":"The name of the user.","type":"text"}],"title":"name","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/address":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/address","type":"topic","url":"\/documentation\/auth0\/userinfo\/address","kind":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"address","kind":"identifier"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"]?","kind":"text"}],"title":"address","abstract":[{"text":"The address of the user.","type":"text"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/familyName":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/familyName","abstract":[{"type":"text","text":"The last name of the user."}],"type":"topic","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"familyName","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/userinfo\/familyname","title":"familyName"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/zoneinfo":{"url":"\/documentation\/auth0\/userinfo\/zoneinfo","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"zoneinfo","kind":"identifier"},{"text":": ","kind":"text"},{"text":"TimeZone","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation8TimeZoneV"},{"text":"?","kind":"text"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/zoneinfo","title":"zoneinfo","type":"topic","role":"symbol","abstract":[{"type":"text","text":"The time zone of the user."}]},"doc://com.auth0.Auth0/s8SendableP":{"identifier":"doc:\/\/com.auth0.Auth0\/s8SendableP","title":"Swift.Sendable","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/init(json:)":{"title":"init(json:)","url":"\/documentation\/auth0\/userinfo\/init(json:)","kind":"symbol","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/init(json:)","fragments":[{"text":"init","kind":"identifier"},{"text":"?(","kind":"text"},{"text":"json","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"])","kind":"text"}],"abstract":[{"type":"text","text":"Creates a new "},{"code":"UserInfo","type":"codeVoice"},{"type":"text","text":" from a JSON dictionary."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/picture":{"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"picture","kind":"identifier"},{"text":": ","kind":"text"},{"text":"URL","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/picture","title":"picture","url":"\/documentation\/auth0\/userinfo\/picture","type":"topic","kind":"symbol","role":"symbol","abstract":[{"text":"The URL of the user’s picture.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/gender":{"abstract":[{"type":"text","text":"The gender of the user."}],"kind":"symbol","title":"gender","role":"symbol","url":"\/documentation\/auth0\/userinfo\/gender","type":"topic","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"gender","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/gender"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/updatedAt":{"url":"\/documentation\/auth0\/userinfo\/updatedat","abstract":[{"text":"The date and time the user’s information was last updated.","type":"text"}],"kind":"symbol","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"updatedAt","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Date","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DateV"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/updatedAt","title":"updatedAt","type":"topic"},"https://auth0.com/docs/secure/tokens/json-web-tokens/json-web-token-claims":{"identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/json-web-tokens\/json-web-token-claims","title":"Claims","type":"link","titleInlineContent":[{"type":"text","text":"Claims"}],"url":"https:\/\/auth0.com\/docs\/secure\/tokens\/json-web-tokens\/json-web-token-claims"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/profile":{"url":"\/documentation\/auth0\/userinfo\/profile","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"profile"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"URL","preciseIdentifier":"s:10Foundation3URLV"},{"kind":"text","text":"?"}],"abstract":[{"text":"The URL of the user’s profile page.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/profile","type":"topic","kind":"symbol","title":"profile","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/email":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/email","kind":"symbol","title":"email","abstract":[{"text":"The email of the user.","type":"text"}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"email"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"url":"\/documentation\/auth0\/userinfo\/email","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/nickname":{"role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"nickname","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/nickname","title":"nickname","url":"\/documentation\/auth0\/userinfo\/nickname","abstract":[{"text":"The nickname of the user.","type":"text"}],"type":"topic","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/preferredUsername":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/preferredUsername","url":"\/documentation\/auth0\/userinfo\/preferredusername","title":"preferredUsername","type":"topic","role":"symbol","abstract":[{"type":"text","text":"The preferred username of the user."}],"kind":"symbol","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"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/middleName":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/middleName","type":"topic","abstract":[{"text":"The middle name of the user.","type":"text"}],"title":"middleName","kind":"symbol","role":"symbol","url":"\/documentation\/auth0\/userinfo\/middlename","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"middleName","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}]},"doc://com.auth0.Auth0/s16SendableMetatypeP":{"identifier":"doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP","title":"Swift.SendableMetatype","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/publicClaims":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/publicClaims","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"publicClaims","kind":"identifier"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"]","kind":"text"}],"kind":"symbol","abstract":[{"text":"The list of public claims.","type":"text"}],"url":"\/documentation\/auth0\/userinfo\/publicclaims","title":"publicClaims","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"text":"UserInfo","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/userinfo","type":"topic","title":"UserInfo","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/phoneNumberVerified":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/phoneNumberVerified","kind":"symbol","title":"phoneNumberVerified","abstract":[{"type":"text","text":"If the user’s phone number is verified."}],"url":"\/documentation\/auth0\/userinfo\/phonenumberverified","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"phoneNumberVerified","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"text":"?","kind":"text"}],"role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/sub":{"url":"\/documentation\/auth0\/userinfo\/sub","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/sub","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"sub","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"type":"topic","role":"symbol","title":"sub","abstract":[{"text":"The Auth0 user identifier.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/locale":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/locale","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"locale","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Locale","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation6LocaleV"},{"text":"?","kind":"text"}],"abstract":[{"type":"text","text":"The locale of the user."}],"title":"locale","type":"topic","url":"\/documentation\/auth0\/userinfo\/locale","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/customClaims":{"role":"symbol","kind":"symbol","abstract":[{"text":"Any custom claims.","type":"text"}],"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"customClaims","kind":"identifier"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"]?","kind":"text"}],"url":"\/documentation\/auth0\/userinfo\/customclaims","title":"customClaims","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/customClaims"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/phoneNumber":{"type":"topic","abstract":[{"type":"text","text":"The phone number of the user."}],"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"phoneNumber","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/userinfo\/phonenumber","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/phoneNumber","title":"phoneNumber"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/givenName":{"title":"givenName","abstract":[{"type":"text","text":"The first name of the user."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/givenName","kind":"symbol","role":"symbol","url":"\/documentation\/auth0\/userinfo\/givenname","type":"topic","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"givenName","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/birthdate":{"kind":"symbol","url":"\/documentation\/auth0\/userinfo\/birthdate","type":"topic","role":"symbol","title":"birthdate","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"birthdate","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"abstract":[{"type":"text","text":"The birthdate of the user."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/birthdate"}}} \ No newline at end of file +{"sections":[],"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/init(json:)"],"title":"Initializers","generated":true,"anchor":"Initializers"},{"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","generated":true,"anchor":"Instance-Properties"},{"title":"Type Properties","generated":true,"anchor":"Type-Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/publicClaims"]}],"kind":"symbol","seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/json-web-tokens\/json-web-token-claims"],"title":"Related Documentation","anchor":"Related-Documentation"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"variants":[{"paths":["\/documentation\/auth0\/userinfo"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"text":"OIDC Standard Claims user information.","type":"text"}],"metadata":{"roleHeading":"Structure","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}],"role":"symbol","modules":[{"name":"Auth0"}],"title":"UserInfo","externalID":"s:5Auth08UserInfoV","symbolKind":"struct","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}]},"schemaVersion":{"minor":3,"patch":0,"major":0},"relationshipsSections":[{"kind":"relationships","identifiers":["doc:\/\/com.auth0.Auth0\/s8SendableP","doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP"],"type":"conformsTo","title":"Conforms To"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"UserInfo"}],"languages":["swift"],"platforms":["iOS"]}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/picture":{"url":"\/documentation\/auth0\/userinfo\/picture","title":"picture","abstract":[{"type":"text","text":"The URL of the user’s picture."}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"picture"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV","text":"URL"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/picture","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/gender":{"url":"\/documentation\/auth0\/userinfo\/gender","title":"gender","abstract":[{"type":"text","text":"The gender of the user."}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"gender"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/gender","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/phoneNumber":{"url":"\/documentation\/auth0\/userinfo\/phonenumber","title":"phoneNumber","abstract":[{"type":"text","text":"The phone number of the user."}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"phoneNumber"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/phoneNumber","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/publicClaims":{"url":"\/documentation\/auth0\/userinfo\/publicclaims","title":"publicClaims","abstract":[{"type":"text","text":"The list of public claims."}],"fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"publicClaims"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"]"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/publicClaims","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/middleName":{"kind":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"middleName","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"title":"middleName","type":"topic","role":"symbol","abstract":[{"text":"The middle name of the user.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/middleName","url":"\/documentation\/auth0\/userinfo\/middlename"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/updatedAt":{"url":"\/documentation\/auth0\/userinfo\/updatedat","title":"updatedAt","abstract":[{"type":"text","text":"The date and time the user’s information was last updated."}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"updatedAt"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DateV","text":"Date"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/updatedAt","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/address":{"url":"\/documentation\/auth0\/userinfo\/address","title":"address","abstract":[{"type":"text","text":"The address of the user."}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"address"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"]?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/address","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/name":{"url":"\/documentation\/auth0\/userinfo\/name","title":"name","abstract":[{"type":"text","text":"The name of the user."}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"name"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/name","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/profile":{"url":"\/documentation\/auth0\/userinfo\/profile","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"profile"},{"kind":"text","text":": "},{"preciseIdentifier":"s:10Foundation3URLV","kind":"typeIdentifier","text":"URL"},{"kind":"text","text":"?"}],"title":"profile","type":"topic","role":"symbol","abstract":[{"text":"The URL of the user’s profile page.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/profile","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/sub":{"url":"\/documentation\/auth0\/userinfo\/sub","title":"sub","abstract":[{"type":"text","text":"The Auth0 user identifier."}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"sub"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/sub","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"title":"UserInfo","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"UserInfo"}],"abstract":[{"text":"OIDC Standard Claims user information.","type":"text"}],"url":"\/documentation\/auth0\/userinfo","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]},"doc://com.auth0.Auth0/s16SendableMetatypeP":{"identifier":"doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP","title":"Swift.SendableMetatype","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/zoneinfo":{"url":"\/documentation\/auth0\/userinfo\/zoneinfo","title":"zoneinfo","abstract":[{"type":"text","text":"The time zone of the user."}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"zoneinfo"},{"kind":"text","text":": "},{"preciseIdentifier":"s:10Foundation8TimeZoneV","kind":"typeIdentifier","text":"TimeZone"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/zoneinfo","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/locale":{"url":"\/documentation\/auth0\/userinfo\/locale","title":"locale","abstract":[{"type":"text","text":"The locale of the user."}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"locale"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation6LocaleV","text":"Locale"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/locale","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/phoneNumberVerified":{"url":"\/documentation\/auth0\/userinfo\/phonenumberverified","title":"phoneNumberVerified","abstract":[{"type":"text","text":"If the user’s phone number is verified."}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"phoneNumberVerified"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/phoneNumberVerified","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/customClaims":{"url":"\/documentation\/auth0\/userinfo\/customclaims","title":"customClaims","abstract":[{"type":"text","text":"Any custom claims."}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"customClaims"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/customClaims","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/website":{"url":"\/documentation\/auth0\/userinfo\/website","title":"website","abstract":[{"type":"text","text":"The URL of the user’s website."}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"website"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV","text":"URL"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/website","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/emailVerified":{"url":"\/documentation\/auth0\/userinfo\/emailverified","title":"emailVerified","abstract":[{"type":"text","text":"If the user’s email is verified."}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"emailVerified"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/emailVerified","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/familyName":{"url":"\/documentation\/auth0\/userinfo\/familyname","title":"familyName","abstract":[{"type":"text","text":"The last name of the user."}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"familyName"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/familyName","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/birthdate":{"url":"\/documentation\/auth0\/userinfo\/birthdate","title":"birthdate","abstract":[{"type":"text","text":"The birthdate of the user."}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"birthdate"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/birthdate","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/s8SendableP":{"identifier":"doc:\/\/com.auth0.Auth0\/s8SendableP","title":"Swift.Sendable","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/givenName":{"url":"\/documentation\/auth0\/userinfo\/givenname","title":"givenName","abstract":[{"type":"text","text":"The first name of the user."}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"givenName"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/givenName","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/nickname":{"url":"\/documentation\/auth0\/userinfo\/nickname","title":"nickname","abstract":[{"type":"text","text":"The nickname of the user."}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"nickname"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/nickname","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/init(json:)":{"url":"\/documentation\/auth0\/userinfo\/init(json:)","title":"init(json:)","abstract":[{"type":"text","text":"Creates a new "},{"type":"codeVoice","code":"UserInfo"},{"type":"text","text":" from a JSON dictionary."}],"fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"?("},{"kind":"externalParam","text":"json"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"])"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/init(json:)","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/preferredUsername":{"url":"\/documentation\/auth0\/userinfo\/preferredusername","title":"preferredUsername","abstract":[{"type":"text","text":"The preferred username of the user."}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"preferredUsername"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/preferredUsername","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/email":{"url":"\/documentation\/auth0\/userinfo\/email","title":"email","abstract":[{"type":"text","text":"The email of the user."}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"email"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/email","role":"symbol","kind":"symbol","type":"topic"},"https://auth0.com/docs/secure/tokens/json-web-tokens/json-web-token-claims":{"titleInlineContent":[{"type":"text","text":"Claims"}],"identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/json-web-tokens\/json-web-token-claims","title":"Claims","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/json-web-tokens\/json-web-token-claims","type":"link"}}} \ 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 6687be6dd..6435f2407 100644 --- a/docs/data/documentation/auth0/userinfo/address.json +++ b/docs/data/documentation/auth0/userinfo/address.json @@ -1 +1 @@ -{"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/address"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/address"},"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"abstract":[{"text":"The address of the user.","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"address","kind":"identifier"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"]?","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]},{"kind":"content","content":[{"type":"heading","level":2,"text":"Discussion","anchor":"discussion"},{"type":"aside","style":"note","name":"Requires","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"type":"codeVoice","code":"address"},{"type":"text","text":" scope."}]}]}]}],"metadata":{"externalID":"s:5Auth08UserInfoV7addressSDyS2SGSgvp","modules":[{"name":"Auth0"}],"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"address","kind":"identifier"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"]?","kind":"text"}],"role":"symbol","roleHeading":"Instance Property","symbolKind":"property","title":"address"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/address":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/address","type":"topic","url":"\/documentation\/auth0\/userinfo\/address","kind":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"address","kind":"identifier"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"]?","kind":"text"}],"title":"address","abstract":[{"text":"The address of the user.","type":"text"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"text":"UserInfo","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/userinfo","type":"topic","title":"UserInfo","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/address"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"abstract":[{"text":"The address of the user.","type":"text"}],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"address"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" : "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"]?"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"},{"content":[{"type":"heading","level":2,"anchor":"discussion","text":"Discussion"},{"type":"aside","content":[{"inlineContent":[{"text":"The ","type":"text"},{"type":"codeVoice","code":"address"},{"type":"text","text":" scope."}],"type":"paragraph"}],"name":"Requires","style":"note"}],"kind":"content"}],"schemaVersion":{"major":0,"patch":0,"minor":3},"kind":"symbol","sections":[],"metadata":{"symbolKind":"property","roleHeading":"Instance Property","externalID":"s:5Auth08UserInfoV7addressSDyS2SGSgvp","title":"address","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"address"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" : "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"]?"}],"role":"symbol"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/address","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/address":{"url":"\/documentation\/auth0\/userinfo\/address","title":"address","abstract":[{"type":"text","text":"The address of the user."}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"address"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"]?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/address","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"title":"UserInfo","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"UserInfo"}],"abstract":[{"text":"OIDC Standard Claims user information.","type":"text"}],"url":"\/documentation\/auth0\/userinfo","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/userinfo/birthdate.json b/docs/data/documentation/auth0/userinfo/birthdate.json index b40a1f993..081369e07 100644 --- a/docs/data/documentation/auth0/userinfo/birthdate.json +++ b/docs/data/documentation/auth0/userinfo/birthdate.json @@ -1 +1 @@ -{"kind":"symbol","sections":[],"abstract":[{"text":"The birthdate of the user.","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"birthdate","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}]},{"content":[{"type":"heading","level":2,"text":"Discussion","anchor":"discussion"},{"style":"note","type":"aside","name":"Requires","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"type":"codeVoice","code":"profile"},{"type":"text","text":" scope."}]}]}],"kind":"content"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/birthdate","interfaceLanguage":"swift"},"schemaVersion":{"minor":3,"patch":0,"major":0},"metadata":{"symbolKind":"property","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"birthdate"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}],"externalID":"s:5Auth08UserInfoV9birthdateSSSgvp","role":"symbol","title":"birthdate","modules":[{"name":"Auth0"}],"roleHeading":"Instance Property"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/birthdate"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/birthdate":{"kind":"symbol","url":"\/documentation\/auth0\/userinfo\/birthdate","type":"topic","role":"symbol","title":"birthdate","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"birthdate","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"abstract":[{"type":"text","text":"The birthdate of the user."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/birthdate"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"text":"UserInfo","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/userinfo","type":"topic","title":"UserInfo","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"}}} \ No newline at end of file +{"abstract":[{"text":"The birthdate of the user.","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"birthdate","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"platforms":["iOS"]}]},{"content":[{"text":"Discussion","level":2,"type":"heading","anchor":"discussion"},{"content":[{"inlineContent":[{"type":"text","text":"The "},{"type":"codeVoice","code":"profile"},{"type":"text","text":" scope."}],"type":"paragraph"}],"style":"note","name":"Requires","type":"aside"}],"kind":"content"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/birthdate"]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"metadata":{"modules":[{"name":"Auth0"}],"title":"birthdate","roleHeading":"Instance Property","symbolKind":"property","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"birthdate","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"externalID":"s:5Auth08UserInfoV9birthdateSSSgvp"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/birthdate","interfaceLanguage":"swift"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/birthdate":{"url":"\/documentation\/auth0\/userinfo\/birthdate","title":"birthdate","abstract":[{"type":"text","text":"The birthdate of the user."}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"birthdate"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/birthdate","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"title":"UserInfo","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"UserInfo"}],"abstract":[{"text":"OIDC Standard Claims user information.","type":"text"}],"url":"\/documentation\/auth0\/userinfo","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ 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 2dcc76c38..8b14e6660 100644 --- a/docs/data/documentation/auth0/userinfo/customclaims.json +++ b/docs/data/documentation/auth0/userinfo/customclaims.json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"customClaims","kind":"identifier"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"]?","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/customclaims"]}],"kind":"symbol","abstract":[{"text":"Any custom claims.","type":"text"}],"metadata":{"role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"customClaims"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"text":"Any","kind":"keyword"},{"text":"]?","kind":"text"}],"roleHeading":"Instance Property","symbolKind":"property","title":"customClaims","externalID":"s:5Auth08UserInfoV12customClaimsSDySSypGSgvp","modules":[{"name":"Auth0"}]},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/customClaims"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/customClaims":{"role":"symbol","kind":"symbol","abstract":[{"text":"Any custom claims.","type":"text"}],"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"customClaims","kind":"identifier"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"]?","kind":"text"}],"url":"\/documentation\/auth0\/userinfo\/customclaims","title":"customClaims","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/customClaims"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"text":"UserInfo","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/userinfo","type":"topic","title":"UserInfo","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"}}} \ No newline at end of file +{"sections":[],"metadata":{"externalID":"s:5Auth08UserInfoV12customClaimsSDySSypGSgvp","modules":[{"name":"Auth0"}],"title":"customClaims","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"customClaims","kind":"identifier"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"]?","kind":"text"}],"roleHeading":"Instance Property","role":"symbol","symbolKind":"property"},"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/customClaims"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/customclaims"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"schemaVersion":{"patch":0,"minor":3,"major":0},"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"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"]?","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]}],"abstract":[{"type":"text","text":"Any custom claims."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/customClaims":{"url":"\/documentation\/auth0\/userinfo\/customclaims","title":"customClaims","abstract":[{"type":"text","text":"Any custom claims."}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"customClaims"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/customClaims","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"title":"UserInfo","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"UserInfo"}],"abstract":[{"text":"OIDC Standard Claims user information.","type":"text"}],"url":"\/documentation\/auth0\/userinfo","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/userinfo/email.json b/docs/data/documentation/auth0/userinfo/email.json index 26f3747c7..7f20fb584 100644 --- a/docs/data/documentation/auth0/userinfo/email.json +++ b/docs/data/documentation/auth0/userinfo/email.json @@ -1 +1 @@ -{"metadata":{"role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"email"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"modules":[{"name":"Auth0"}],"symbolKind":"property","externalID":"s:5Auth08UserInfoV5emailSSSgvp","roleHeading":"Instance Property","title":"email"},"kind":"symbol","schemaVersion":{"patch":0,"major":0,"minor":3},"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\/email"},"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"email","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"platforms":["iOS"]}],"kind":"declarations"},{"kind":"content","content":[{"level":2,"type":"heading","text":"Discussion","anchor":"discussion"},{"type":"aside","name":"Requires","style":"note","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"type":"codeVoice","code":"email"},{"type":"text","text":" scope."}]}]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/email"]}],"abstract":[{"type":"text","text":"The email of the user."}],"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/email":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/email","kind":"symbol","title":"email","abstract":[{"text":"The email of the user.","type":"text"}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"email"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"url":"\/documentation\/auth0\/userinfo\/email","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"text":"UserInfo","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/userinfo","type":"topic","title":"UserInfo","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"kind":"symbol","primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"kind":"identifier","text":"email"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?","kind":"text"}],"platforms":["iOS"]}],"kind":"declarations"},{"content":[{"type":"heading","text":"Discussion","anchor":"discussion","level":2},{"type":"aside","name":"Requires","style":"note","content":[{"inlineContent":[{"type":"text","text":"The "},{"type":"codeVoice","code":"email"},{"text":" scope.","type":"text"}],"type":"paragraph"}]}],"kind":"content"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/email"]}],"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"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\/email"},"abstract":[{"text":"The email of the user.","type":"text"}],"metadata":{"role":"symbol","modules":[{"name":"Auth0"}],"title":"email","fragments":[{"kind":"keyword","text":"let"},{"text":" ","kind":"text"},{"text":"email","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"?","kind":"text"}],"externalID":"s:5Auth08UserInfoV5emailSSSgvp","roleHeading":"Instance Property","symbolKind":"property"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/email":{"url":"\/documentation\/auth0\/userinfo\/email","title":"email","abstract":[{"type":"text","text":"The email of the user."}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"email"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/email","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"title":"UserInfo","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"UserInfo"}],"abstract":[{"text":"OIDC Standard Claims user information.","type":"text"}],"url":"\/documentation\/auth0\/userinfo","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]}}} \ 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 2ff45b836..8c53a495c 100644 --- a/docs/data/documentation/auth0/userinfo/emailverified.json +++ b/docs/data/documentation/auth0/userinfo/emailverified.json @@ -1 +1 @@ -{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/emailVerified"},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"emailVerified","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"text":"?","kind":"text"}]}]},{"kind":"content","content":[{"level":2,"type":"heading","text":"Discussion","anchor":"discussion"},{"type":"aside","style":"note","content":[{"inlineContent":[{"text":"The ","type":"text"},{"code":"email","type":"codeVoice"},{"text":" scope.","type":"text"}],"type":"paragraph"}],"name":"Requires"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"variants":[{"paths":["\/documentation\/auth0\/userinfo\/emailverified"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"kind":"symbol","metadata":{"modules":[{"name":"Auth0"}],"title":"emailVerified","symbolKind":"property","role":"symbol","externalID":"s:5Auth08UserInfoV13emailVerifiedSbSgvp","roleHeading":"Instance Property","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"emailVerified","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":"?"}]},"schemaVersion":{"minor":3,"patch":0,"major":0},"abstract":[{"type":"text","text":"If the user’s email is verified."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/emailVerified":{"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"emailVerified","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/emailVerified","url":"\/documentation\/auth0\/userinfo\/emailverified","kind":"symbol","abstract":[{"type":"text","text":"If the user’s email is verified."}],"title":"emailVerified","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"text":"UserInfo","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/userinfo","type":"topic","title":"UserInfo","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"}}} \ No newline at end of file +{"metadata":{"symbolKind":"property","title":"emailVerified","externalID":"s:5Auth08UserInfoV13emailVerifiedSbSgvp","roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"emailVerified","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"role":"symbol"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/emailverified"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/emailVerified"},"kind":"symbol","abstract":[{"text":"If the user’s email is verified.","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"emailVerified","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"platforms":["iOS"]}],"kind":"declarations"},{"content":[{"text":"Discussion","level":2,"anchor":"discussion","type":"heading"},{"name":"Requires","style":"note","content":[{"inlineContent":[{"text":"The ","type":"text"},{"code":"email","type":"codeVoice"},{"text":" scope.","type":"text"}],"type":"paragraph"}],"type":"aside"}],"kind":"content"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/emailVerified":{"url":"\/documentation\/auth0\/userinfo\/emailverified","title":"emailVerified","abstract":[{"type":"text","text":"If the user’s email is verified."}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"emailVerified"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/emailVerified","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"title":"UserInfo","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"UserInfo"}],"abstract":[{"text":"OIDC Standard Claims user information.","type":"text"}],"url":"\/documentation\/auth0\/userinfo","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ 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 1369cfd0c..4d1e9e9de 100644 --- a/docs/data/documentation/auth0/userinfo/familyname.json +++ b/docs/data/documentation/auth0/userinfo/familyname.json @@ -1 +1 @@ -{"sections":[],"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/userinfo\/familyname"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/familyName"},"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"metadata":{"role":"symbol","symbolKind":"property","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"familyName"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"title":"familyName","modules":[{"name":"Auth0"}],"externalID":"s:5Auth08UserInfoV10familyNameSSSgvp","roleHeading":"Instance Property"},"abstract":[{"text":"The last name of the user.","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"familyName"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"languages":["swift"]}]},{"kind":"content","content":[{"text":"Discussion","anchor":"discussion","type":"heading","level":2},{"name":"Requires","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"type":"codeVoice","code":"profile"},{"type":"text","text":" scope."}]}],"type":"aside","style":"note"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"text":"UserInfo","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/userinfo","type":"topic","title":"UserInfo","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/familyName":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/familyName","abstract":[{"type":"text","text":"The last name of the user."}],"type":"topic","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"familyName","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/userinfo\/familyname","title":"familyName"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/familyname"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"abstract":[{"text":"The last name of the user.","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"familyName","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}]},{"kind":"content","content":[{"level":2,"text":"Discussion","anchor":"discussion","type":"heading"},{"name":"Requires","style":"note","type":"aside","content":[{"inlineContent":[{"type":"text","text":"The "},{"code":"profile","type":"codeVoice"},{"type":"text","text":" scope."}],"type":"paragraph"}]}]}],"kind":"symbol","schemaVersion":{"minor":3,"major":0,"patch":0},"sections":[],"metadata":{"modules":[{"name":"Auth0"}],"symbolKind":"property","title":"familyName","roleHeading":"Instance Property","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"familyName","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"externalID":"s:5Auth08UserInfoV10familyNameSSSgvp"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/familyName","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"title":"UserInfo","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"UserInfo"}],"abstract":[{"text":"OIDC Standard Claims user information.","type":"text"}],"url":"\/documentation\/auth0\/userinfo","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/familyName":{"url":"\/documentation\/auth0\/userinfo\/familyname","title":"familyName","abstract":[{"type":"text","text":"The last name of the user."}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"familyName"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/familyName","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ 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 5fe3149c2..fd3c8aff1 100644 --- a/docs/data/documentation/auth0/userinfo/gender.json +++ b/docs/data/documentation/auth0/userinfo/gender.json @@ -1 +1 @@ -{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/gender"},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"gender","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}]}]},{"kind":"content","content":[{"level":2,"type":"heading","text":"Discussion","anchor":"discussion"},{"type":"aside","style":"note","content":[{"inlineContent":[{"text":"The ","type":"text"},{"code":"profile","type":"codeVoice"},{"text":" scope.","type":"text"}],"type":"paragraph"}],"name":"Requires"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"variants":[{"paths":["\/documentation\/auth0\/userinfo\/gender"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"kind":"symbol","metadata":{"title":"gender","modules":[{"name":"Auth0"}],"symbolKind":"property","role":"symbol","roleHeading":"Instance Property","externalID":"s:5Auth08UserInfoV6genderSSSgvp","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"gender","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}]},"schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"type":"text","text":"The gender of the user."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"text":"UserInfo","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/userinfo","type":"topic","title":"UserInfo","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/gender":{"abstract":[{"type":"text","text":"The gender of the user."}],"kind":"symbol","title":"gender","role":"symbol","url":"\/documentation\/auth0\/userinfo\/gender","type":"topic","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"gender","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/gender"}}} \ No newline at end of file +{"schemaVersion":{"patch":0,"major":0,"minor":3},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"gender","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"platforms":["iOS"]}]},{"content":[{"text":"Discussion","level":2,"type":"heading","anchor":"discussion"},{"content":[{"inlineContent":[{"type":"text","text":"The "},{"type":"codeVoice","code":"profile"},{"type":"text","text":" scope."}],"type":"paragraph"}],"style":"note","name":"Requires","type":"aside"}],"kind":"content"}],"sections":[],"abstract":[{"text":"The gender of the user.","type":"text"}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/gender"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/gender","interfaceLanguage":"swift"},"metadata":{"role":"symbol","title":"gender","modules":[{"name":"Auth0"}],"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"gender","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"externalID":"s:5Auth08UserInfoV6genderSSSgvp","roleHeading":"Instance Property","symbolKind":"property"},"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","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"UserInfo"}],"abstract":[{"text":"OIDC Standard Claims user information.","type":"text"}],"url":"\/documentation\/auth0\/userinfo","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/gender":{"url":"\/documentation\/auth0\/userinfo\/gender","title":"gender","abstract":[{"type":"text","text":"The gender of the user."}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"gender"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/gender","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ 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 814207ed1..a4943159a 100644 --- a/docs/data/documentation/auth0/userinfo/givenname.json +++ b/docs/data/documentation/auth0/userinfo/givenname.json @@ -1 +1 @@ -{"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"givenName"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}]}],"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":"profile"},{"type":"text","text":" scope."}]}],"style":"note"}]}],"metadata":{"roleHeading":"Instance Property","title":"givenName","modules":[{"name":"Auth0"}],"externalID":"s:5Auth08UserInfoV9givenNameSSSgvp","symbolKind":"property","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"givenName"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}]},"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/givenName","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"The first name of the user."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/givenname"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/givenName":{"title":"givenName","abstract":[{"type":"text","text":"The first name of the user."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/givenName","kind":"symbol","role":"symbol","url":"\/documentation\/auth0\/userinfo\/givenname","type":"topic","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"givenName","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"text":"UserInfo","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/userinfo","type":"topic","title":"UserInfo","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"}}} \ No newline at end of file +{"metadata":{"symbolKind":"property","roleHeading":"Instance Property","externalID":"s:5Auth08UserInfoV9givenNameSSSgvp","title":"givenName","modules":[{"name":"Auth0"}],"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"givenName","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"role":"symbol"},"sections":[],"variants":[{"paths":["\/documentation\/auth0\/userinfo\/givenname"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/givenName","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"text":"The first name of the user.","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"givenName","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"platforms":["iOS"]}]},{"content":[{"level":2,"text":"Discussion","type":"heading","anchor":"discussion"},{"name":"Requires","type":"aside","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"type":"codeVoice","code":"profile"},{"type":"text","text":" scope."}]}],"style":"note"}],"kind":"content"}],"schemaVersion":{"minor":3,"patch":0,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/givenName":{"url":"\/documentation\/auth0\/userinfo\/givenname","title":"givenName","abstract":[{"type":"text","text":"The first name of the user."}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"givenName"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/givenName","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"title":"UserInfo","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"UserInfo"}],"abstract":[{"text":"OIDC Standard Claims user information.","type":"text"}],"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 ecf4f0b3a..3dec761f1 100644 --- a/docs/data/documentation/auth0/userinfo/init(json:).json +++ b/docs/data/documentation/auth0/userinfo/init(json:).json @@ -1 +1 @@ -{"variants":[{"paths":["\/documentation\/auth0\/userinfo\/init(json:)"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"init"},{"kind":"text","text":"?("},{"kind":"externalParam","text":"json"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"])"}],"platforms":["iOS"]}]}],"abstract":[{"type":"text","text":"Creates a new "},{"type":"codeVoice","code":"UserInfo"},{"type":"text","text":" from a JSON dictionary."}],"metadata":{"role":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"?(","kind":"text"},{"text":"json","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"])","kind":"text"}],"externalID":"s:5Auth08UserInfoV4jsonACSgSDySSypG_tcfc","symbolKind":"init","title":"init(json:)","roleHeading":"Initializer","modules":[{"name":"Auth0"}],"extendedModule":"Auth0"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/init(json:)","interfaceLanguage":"swift"},"kind":"symbol","sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"schemaVersion":{"major":0,"patch":0,"minor":3},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/init(json:)":{"title":"init(json:)","url":"\/documentation\/auth0\/userinfo\/init(json:)","kind":"symbol","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/init(json:)","fragments":[{"text":"init","kind":"identifier"},{"text":"?(","kind":"text"},{"text":"json","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"])","kind":"text"}],"abstract":[{"type":"text","text":"Creates a new "},{"code":"UserInfo","type":"codeVoice"},{"type":"text","text":" from a JSON dictionary."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"text":"UserInfo","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/userinfo","type":"topic","title":"UserInfo","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"}}} \ No newline at end of file +{"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/init(json:)"},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"init","kind":"keyword"},{"text":"?(","kind":"text"},{"text":"json","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"])","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/init(json:)"]}],"kind":"symbol","metadata":{"modules":[{"name":"Auth0"}],"title":"init(json:)","externalID":"s:5Auth08UserInfoV4jsonACSgSDySSypG_tcfc","role":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"?(","kind":"text"},{"text":"json","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"])","kind":"text"}],"extendedModule":"Auth0","roleHeading":"Initializer","symbolKind":"init"},"schemaVersion":{"patch":0,"minor":3,"major":0},"abstract":[{"type":"text","text":"Creates a new "},{"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"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"title":"UserInfo","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"UserInfo"}],"abstract":[{"text":"OIDC Standard Claims user information.","type":"text"}],"url":"\/documentation\/auth0\/userinfo","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/init(json:)":{"url":"\/documentation\/auth0\/userinfo\/init(json:)","title":"init(json:)","abstract":[{"type":"text","text":"Creates a new "},{"type":"codeVoice","code":"UserInfo"},{"type":"text","text":" from a JSON dictionary."}],"fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"?("},{"kind":"externalParam","text":"json"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"])"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/init(json:)","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ 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 ca1caf2b8..590b585cf 100644 --- a/docs/data/documentation/auth0/userinfo/locale.json +++ b/docs/data/documentation/auth0/userinfo/locale.json @@ -1 +1 @@ -{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/locale"},"metadata":{"role":"symbol","title":"locale","roleHeading":"Instance Property","externalID":"s:5Auth08UserInfoV6locale10Foundation6LocaleVSgvp","symbolKind":"property","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"locale","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Locale","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation6LocaleV"},{"text":"?","kind":"text"}],"modules":[{"name":"Auth0"}]},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"abstract":[{"text":"The locale of the user.","type":"text"}],"schemaVersion":{"minor":3,"major":0,"patch":0},"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"locale","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Locale","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation6LocaleV"},{"text":"?","kind":"text"}],"languages":["swift"]}]},{"kind":"content","content":[{"anchor":"discussion","type":"heading","level":2,"text":"Discussion"},{"name":"Requires","type":"aside","style":"note","content":[{"inlineContent":[{"type":"text","text":"The "},{"code":"profile","type":"codeVoice"},{"type":"text","text":" scope."}],"type":"paragraph"}]}]}],"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/locale"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/locale":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/locale","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"locale","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Locale","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation6LocaleV"},{"text":"?","kind":"text"}],"abstract":[{"type":"text","text":"The locale of the user."}],"title":"locale","type":"topic","url":"\/documentation\/auth0\/userinfo\/locale","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"text":"UserInfo","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/userinfo","type":"topic","title":"UserInfo","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"metadata":{"symbolKind":"property","modules":[{"name":"Auth0"}],"title":"locale","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"locale","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Locale","preciseIdentifier":"s:10Foundation6LocaleV","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"externalID":"s:5Auth08UserInfoV6locale10Foundation6LocaleVSgvp","role":"symbol","roleHeading":"Instance Property"},"sections":[],"abstract":[{"type":"text","text":"The locale of the user."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/locale"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/locale","interfaceLanguage":"swift"},"kind":"symbol","schemaVersion":{"patch":0,"minor":3,"major":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"locale","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Locale","preciseIdentifier":"s:10Foundation6LocaleV","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}]},{"kind":"content","content":[{"type":"heading","level":2,"anchor":"discussion","text":"Discussion"},{"style":"note","content":[{"inlineContent":[{"type":"text","text":"The "},{"type":"codeVoice","code":"profile"},{"type":"text","text":" scope."}],"type":"paragraph"}],"type":"aside","name":"Requires"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/locale":{"url":"\/documentation\/auth0\/userinfo\/locale","title":"locale","abstract":[{"type":"text","text":"The locale of the user."}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"locale"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation6LocaleV","text":"Locale"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/locale","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"title":"UserInfo","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"UserInfo"}],"abstract":[{"text":"OIDC Standard Claims user information.","type":"text"}],"url":"\/documentation\/auth0\/userinfo","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ 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 715116bc0..4c41881f9 100644 --- a/docs/data/documentation/auth0/userinfo/middlename.json +++ b/docs/data/documentation/auth0/userinfo/middlename.json @@ -1 +1 @@ -{"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"abstract":[{"type":"text","text":"The middle name of the user."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/middlename"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/middleName"},"kind":"symbol","sections":[],"metadata":{"title":"middleName","roleHeading":"Instance Property","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"middleName"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"modules":[{"name":"Auth0"}],"externalID":"s:5Auth08UserInfoV10middleNameSSSgvp","role":"symbol","symbolKind":"property"},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"middleName"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"},{"content":[{"level":2,"anchor":"discussion","type":"heading","text":"Discussion"},{"style":"note","name":"Requires","type":"aside","content":[{"inlineContent":[{"text":"The ","type":"text"},{"code":"profile","type":"codeVoice"},{"text":" scope.","type":"text"}],"type":"paragraph"}]}],"kind":"content"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"text":"UserInfo","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/userinfo","type":"topic","title":"UserInfo","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/middleName":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/middleName","type":"topic","abstract":[{"text":"The middle name of the user.","type":"text"}],"title":"middleName","kind":"symbol","role":"symbol","url":"\/documentation\/auth0\/userinfo\/middlename","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"middleName","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}]}}} \ No newline at end of file +{"abstract":[{"text":"The middle name of the user.","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"middleName"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"platforms":["iOS"],"languages":["swift"]}]},{"content":[{"text":"Discussion","level":2,"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"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/middlename"]}],"schemaVersion":{"minor":3,"major":0,"patch":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"metadata":{"modules":[{"name":"Auth0"}],"title":"middleName","symbolKind":"property","roleHeading":"Instance Property","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"middleName"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"externalID":"s:5Auth08UserInfoV10middleNameSSSgvp"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/middleName","interfaceLanguage":"swift"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"title":"UserInfo","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"UserInfo"}],"abstract":[{"text":"OIDC Standard Claims user information.","type":"text"}],"url":"\/documentation\/auth0\/userinfo","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/middleName":{"kind":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"middleName","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"title":"middleName","type":"topic","role":"symbol","abstract":[{"text":"The middle name of the user.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/middleName","url":"\/documentation\/auth0\/userinfo\/middlename"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/userinfo/name.json b/docs/data/documentation/auth0/userinfo/name.json index 5ae4a5fa8..933992edf 100644 --- a/docs/data/documentation/auth0/userinfo/name.json +++ b/docs/data/documentation/auth0/userinfo/name.json @@ -1 +1 @@ -{"schemaVersion":{"minor":3,"patch":0,"major":0},"kind":"symbol","metadata":{"modules":[{"name":"Auth0"}],"externalID":"s:5Auth08UserInfoV4nameSSSgvp","symbolKind":"property","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"name","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"role":"symbol","roleHeading":"Instance Property","title":"name"},"abstract":[{"text":"The name of the user.","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"name","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}]}]},{"content":[{"text":"Discussion","type":"heading","level":2,"anchor":"discussion"},{"type":"aside","content":[{"inlineContent":[{"text":"The ","type":"text"},{"type":"codeVoice","code":"profile"},{"text":" scope.","type":"text"}],"type":"paragraph"}],"name":"Requires","style":"note"}],"kind":"content"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/name","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/name"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/name":{"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"name","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/name","url":"\/documentation\/auth0\/userinfo\/name","kind":"symbol","abstract":[{"text":"The name of the user.","type":"text"}],"title":"name","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"text":"UserInfo","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/userinfo","type":"topic","title":"UserInfo","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"abstract":[{"type":"text","text":"The name of the user."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"name","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}]}]},{"kind":"content","content":[{"type":"heading","anchor":"discussion","level":2,"text":"Discussion"},{"type":"aside","name":"Requires","content":[{"type":"paragraph","inlineContent":[{"text":"The ","type":"text"},{"code":"profile","type":"codeVoice"},{"text":" scope.","type":"text"}]}],"style":"note"}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/name"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"metadata":{"symbolKind":"property","title":"name","externalID":"s:5Auth08UserInfoV4nameSSSgvp","roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"name","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"role":"symbol"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/name"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/name":{"url":"\/documentation\/auth0\/userinfo\/name","title":"name","abstract":[{"type":"text","text":"The name of the user."}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"name"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/name","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"title":"UserInfo","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"UserInfo"}],"abstract":[{"text":"OIDC Standard Claims user information.","type":"text"}],"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 1481c868e..caa6ad7ec 100644 --- a/docs/data/documentation/auth0/userinfo/nickname.json +++ b/docs/data/documentation/auth0/userinfo/nickname.json @@ -1 +1 @@ -{"sections":[],"abstract":[{"type":"text","text":"The nickname of the user."}],"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"nickname","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}]},{"content":[{"text":"Discussion","anchor":"discussion","level":2,"type":"heading"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"code":"profile","type":"codeVoice"},{"type":"text","text":" scope."}]}],"name":"Requires","style":"note","type":"aside"}],"kind":"content"}],"variants":[{"paths":["\/documentation\/auth0\/userinfo\/nickname"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","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"]]},"metadata":{"title":"nickname","externalID":"s:5Auth08UserInfoV8nicknameSSSgvp","roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"nickname"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}],"role":"symbol","symbolKind":"property"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"text":"UserInfo","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/userinfo","type":"topic","title":"UserInfo","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/nickname":{"role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"nickname","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/nickname","title":"nickname","url":"\/documentation\/auth0\/userinfo\/nickname","abstract":[{"text":"The nickname of the user.","type":"text"}],"type":"topic","kind":"symbol"}}} \ No newline at end of file +{"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/nickname","interfaceLanguage":"swift"},"kind":"symbol","metadata":{"externalID":"s:5Auth08UserInfoV8nicknameSSSgvp","modules":[{"name":"Auth0"}],"title":"nickname","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"nickname"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"roleHeading":"Instance Property","role":"symbol","symbolKind":"property"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/nickname"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"schemaVersion":{"patch":0,"minor":3,"major":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"nickname"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"platforms":["iOS"],"languages":["swift"]}]},{"content":[{"anchor":"discussion","level":2,"text":"Discussion","type":"heading"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"type":"codeVoice","code":"profile"},{"type":"text","text":" scope."}]}],"style":"note","name":"Requires","type":"aside"}],"kind":"content"}],"abstract":[{"type":"text","text":"The nickname of the user."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"title":"UserInfo","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"UserInfo"}],"abstract":[{"text":"OIDC Standard Claims user information.","type":"text"}],"url":"\/documentation\/auth0\/userinfo","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/nickname":{"url":"\/documentation\/auth0\/userinfo\/nickname","title":"nickname","abstract":[{"type":"text","text":"The nickname of the user."}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"nickname"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/nickname","role":"symbol","kind":"symbol","type":"topic"}}} \ 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 5e2b61221..69938bee1 100644 --- a/docs/data/documentation/auth0/userinfo/phonenumber.json +++ b/docs/data/documentation/auth0/userinfo/phonenumber.json @@ -1 +1 @@ -{"abstract":[{"text":"The phone number of the user.","type":"text"}],"schemaVersion":{"minor":3,"patch":0,"major":0},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"phoneNumber"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"},{"content":[{"text":"Discussion","anchor":"discussion","type":"heading","level":2},{"style":"note","type":"aside","name":"Requires","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"type":"codeVoice","code":"phone_number"},{"type":"text","text":" scope."}]}]}],"kind":"content"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/phoneNumber"},"kind":"symbol","sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/phonenumber"]}],"metadata":{"title":"phoneNumber","roleHeading":"Instance Property","externalID":"s:5Auth08UserInfoV11phoneNumberSSSgvp","role":"symbol","modules":[{"name":"Auth0"}],"symbolKind":"property","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"phoneNumber","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/phoneNumber":{"type":"topic","abstract":[{"type":"text","text":"The phone number of the user."}],"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"phoneNumber","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/userinfo\/phonenumber","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/phoneNumber","title":"phoneNumber"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"text":"UserInfo","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/userinfo","type":"topic","title":"UserInfo","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"metadata":{"symbolKind":"property","title":"phoneNumber","externalID":"s:5Auth08UserInfoV11phoneNumberSSSgvp","roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"phoneNumber"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"role":"symbol"},"sections":[],"variants":[{"paths":["\/documentation\/auth0\/userinfo\/phonenumber"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/phoneNumber","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"text":"The phone number of the user.","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"phoneNumber"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"},{"content":[{"text":"Discussion","level":2,"anchor":"discussion","type":"heading"},{"name":"Requires","style":"note","content":[{"inlineContent":[{"text":"The ","type":"text"},{"type":"codeVoice","code":"phone_number"},{"text":" scope.","type":"text"}],"type":"paragraph"}],"type":"aside"}],"kind":"content"}],"schemaVersion":{"patch":0,"major":0,"minor":3},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/phoneNumber":{"url":"\/documentation\/auth0\/userinfo\/phonenumber","title":"phoneNumber","abstract":[{"type":"text","text":"The phone number of the user."}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"phoneNumber"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/phoneNumber","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"title":"UserInfo","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"UserInfo"}],"abstract":[{"text":"OIDC Standard Claims user information.","type":"text"}],"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 c52d692a9..c2ebc74be 100644 --- a/docs/data/documentation/auth0/userinfo/phonenumberverified.json +++ b/docs/data/documentation/auth0/userinfo/phonenumberverified.json @@ -1 +1 @@ -{"kind":"symbol","abstract":[{"text":"If the user’s phone number is verified.","type":"text"}],"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"},"metadata":{"role":"symbol","roleHeading":"Instance Property","externalID":"s:5Auth08UserInfoV19phoneNumberVerifiedSbSgvp","title":"phoneNumberVerified","modules":[{"name":"Auth0"}],"symbolKind":"property","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"phoneNumberVerified"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":"?"}]},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"phoneNumberVerified"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"},{"kind":"text","text":"?"}],"languages":["swift"]}],"kind":"declarations"},{"kind":"content","content":[{"level":2,"anchor":"discussion","text":"Discussion","type":"heading"},{"style":"note","name":"Requires","type":"aside","content":[{"inlineContent":[{"type":"text","text":"The "},{"type":"codeVoice","code":"phone_number"},{"type":"text","text":" scope."}],"type":"paragraph"}]}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"variants":[{"paths":["\/documentation\/auth0\/userinfo\/phonenumberverified"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"text":"UserInfo","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/userinfo","type":"topic","title":"UserInfo","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/phoneNumberVerified":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/phoneNumberVerified","kind":"symbol","title":"phoneNumberVerified","abstract":[{"type":"text","text":"If the user’s phone number is verified."}],"url":"\/documentation\/auth0\/userinfo\/phonenumberverified","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"phoneNumberVerified","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"text":"?","kind":"text"}],"role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"metadata":{"symbolKind":"property","roleHeading":"Instance Property","externalID":"s:5Auth08UserInfoV19phoneNumberVerifiedSbSgvp","title":"phoneNumberVerified","modules":[{"name":"Auth0"}],"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"phoneNumberVerified","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"role":"symbol"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/phonenumberverified"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/phoneNumberVerified","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"type":"text","text":"If the user’s phone number is verified."}],"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"},{"text":"phoneNumberVerified","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}]},{"kind":"content","content":[{"type":"heading","level":2,"anchor":"discussion","text":"Discussion"},{"style":"note","content":[{"inlineContent":[{"type":"text","text":"The "},{"type":"codeVoice","code":"phone_number"},{"type":"text","text":" scope."}],"type":"paragraph"}],"type":"aside","name":"Requires"}]}],"schemaVersion":{"patch":0,"minor":3,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"title":"UserInfo","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"UserInfo"}],"abstract":[{"text":"OIDC Standard Claims user information.","type":"text"}],"url":"\/documentation\/auth0\/userinfo","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/phoneNumberVerified":{"url":"\/documentation\/auth0\/userinfo\/phonenumberverified","title":"phoneNumberVerified","abstract":[{"type":"text","text":"If the user’s phone number is verified."}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"phoneNumberVerified"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/phoneNumberVerified","role":"symbol","kind":"symbol","type":"topic"}}} \ 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 15512e5c8..6d380995c 100644 --- a/docs/data/documentation/auth0/userinfo/picture.json +++ b/docs/data/documentation/auth0/userinfo/picture.json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"picture"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"URL","preciseIdentifier":"s:10Foundation3URLV"},{"kind":"text","text":"?"}],"platforms":["iOS"],"languages":["swift"]}]},{"kind":"content","content":[{"text":"Discussion","anchor":"discussion","level":2,"type":"heading"},{"content":[{"type":"paragraph","inlineContent":[{"text":"The ","type":"text"},{"code":"profile","type":"codeVoice"},{"text":" scope.","type":"text"}]}],"type":"aside","style":"note","name":"Requires"}]}],"kind":"symbol","schemaVersion":{"minor":3,"patch":0,"major":0},"metadata":{"modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","title":"picture","symbolKind":"property","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"picture","kind":"identifier"},{"text":": ","kind":"text"},{"text":"URL","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV"},{"text":"?","kind":"text"}],"externalID":"s:5Auth08UserInfoV7picture10Foundation3URLVSgvp"},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/picture","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"The URL of the user’s picture."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/picture"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/picture":{"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"picture","kind":"identifier"},{"text":": ","kind":"text"},{"text":"URL","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/picture","title":"picture","url":"\/documentation\/auth0\/userinfo\/picture","type":"topic","kind":"symbol","role":"symbol","abstract":[{"text":"The URL of the user’s picture.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"text":"UserInfo","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/userinfo","type":"topic","title":"UserInfo","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"}}} \ No newline at end of file +{"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/picture","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"picture"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV","text":"URL"},{"kind":"text","text":"?"}]}]},{"kind":"content","content":[{"level":2,"type":"heading","anchor":"discussion","text":"Discussion"},{"type":"aside","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"code":"profile","type":"codeVoice"},{"type":"text","text":" scope."}]}],"name":"Requires","style":"note"}]}],"variants":[{"paths":["\/documentation\/auth0\/userinfo\/picture"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","metadata":{"modules":[{"name":"Auth0"}],"title":"picture","externalID":"s:5Auth08UserInfoV7picture10Foundation3URLVSgvp","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"picture"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV","text":"URL"},{"kind":"text","text":"?"}],"roleHeading":"Instance Property","symbolKind":"property"},"schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"type":"text","text":"The URL of the user’s picture."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"title":"UserInfo","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"UserInfo"}],"abstract":[{"text":"OIDC Standard Claims user information.","type":"text"}],"url":"\/documentation\/auth0\/userinfo","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/picture":{"url":"\/documentation\/auth0\/userinfo\/picture","title":"picture","abstract":[{"type":"text","text":"The URL of the user’s picture."}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"picture"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV","text":"URL"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/picture","role":"symbol","kind":"symbol","type":"topic"}}} \ 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 4ce447b62..b60c060e2 100644 --- a/docs/data/documentation/auth0/userinfo/preferredusername.json +++ b/docs/data/documentation/auth0/userinfo/preferredusername.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"sections":[],"metadata":{"externalID":"s:5Auth08UserInfoV17preferredUsernameSSSgvp","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"}],"symbolKind":"property","roleHeading":"Instance Property","title":"preferredUsername","role":"symbol"},"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/preferredUsername"},"variants":[{"paths":["\/documentation\/auth0\/userinfo\/preferredusername"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"type":"text","text":"The preferred username of the user."}],"primaryContentSections":[{"declarations":[{"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"preferredUsername","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"},{"content":[{"type":"heading","anchor":"discussion","level":2,"text":"Discussion"},{"name":"Requires","type":"aside","style":"note","content":[{"type":"paragraph","inlineContent":[{"text":"The ","type":"text"},{"code":"profile","type":"codeVoice"},{"text":" scope.","type":"text"}]}]}],"kind":"content"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/preferredUsername":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/preferredUsername","url":"\/documentation\/auth0\/userinfo\/preferredusername","title":"preferredUsername","type":"topic","role":"symbol","abstract":[{"type":"text","text":"The preferred username of the user."}],"kind":"symbol","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"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"text":"UserInfo","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/userinfo","type":"topic","title":"UserInfo","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"metadata":{"symbolKind":"property","roleHeading":"Instance Property","externalID":"s:5Auth08UserInfoV17preferredUsernameSSSgvp","title":"preferredUsername","modules":[{"name":"Auth0"}],"fragments":[{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"preferredUsername","kind":"identifier"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":"?"}],"role":"symbol"},"sections":[],"variants":[{"paths":["\/documentation\/auth0\/userinfo\/preferredusername"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/preferredUsername","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"type":"text","text":"The preferred username of the user."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"preferredUsername","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}]}]},{"content":[{"level":2,"anchor":"discussion","type":"heading","text":"Discussion"},{"name":"Requires","content":[{"type":"paragraph","inlineContent":[{"text":"The ","type":"text"},{"code":"profile","type":"codeVoice"},{"text":" scope.","type":"text"}]}],"type":"aside","style":"note"}],"kind":"content"}],"schemaVersion":{"patch":0,"minor":3,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/preferredUsername":{"url":"\/documentation\/auth0\/userinfo\/preferredusername","title":"preferredUsername","abstract":[{"type":"text","text":"The preferred username of the user."}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"preferredUsername"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/preferredUsername","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"title":"UserInfo","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"UserInfo"}],"abstract":[{"text":"OIDC Standard Claims user information.","type":"text"}],"url":"\/documentation\/auth0\/userinfo","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/userinfo/profile.json b/docs/data/documentation/auth0/userinfo/profile.json index f571fc532..9528acbed 100644 --- a/docs/data/documentation/auth0/userinfo/profile.json +++ b/docs/data/documentation/auth0/userinfo/profile.json @@ -1 +1 @@ -{"abstract":[{"text":"The URL of the user’s profile page.","type":"text"}],"variants":[{"paths":["\/documentation\/auth0\/userinfo\/profile"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"kind":"symbol","primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"profile","kind":"identifier"},{"text":": ","kind":"text"},{"text":"URL","preciseIdentifier":"s:10Foundation3URLV","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"platforms":["iOS"]}],"kind":"declarations"},{"content":[{"anchor":"discussion","level":2,"type":"heading","text":"Discussion"},{"style":"note","type":"aside","content":[{"inlineContent":[{"text":"The ","type":"text"},{"code":"profile","type":"codeVoice"},{"text":" scope.","type":"text"}],"type":"paragraph"}],"name":"Requires"}],"kind":"content"}],"schemaVersion":{"major":0,"patch":0,"minor":3},"metadata":{"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"profile"},{"kind":"text","text":": "},{"preciseIdentifier":"s:10Foundation3URLV","kind":"typeIdentifier","text":"URL"},{"kind":"text","text":"?"}],"roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"symbolKind":"property","title":"profile","role":"symbol","externalID":"s:5Auth08UserInfoV7profile10Foundation3URLVSgvp"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/profile","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/profile":{"url":"\/documentation\/auth0\/userinfo\/profile","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"profile"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"URL","preciseIdentifier":"s:10Foundation3URLV"},{"kind":"text","text":"?"}],"abstract":[{"text":"The URL of the user’s profile page.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/profile","type":"topic","kind":"symbol","title":"profile","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"text":"UserInfo","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/userinfo","type":"topic","title":"UserInfo","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"metadata":{"symbolKind":"property","modules":[{"name":"Auth0"}],"title":"profile","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"profile"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"URL","preciseIdentifier":"s:10Foundation3URLV"},{"kind":"text","text":"?"}],"externalID":"s:5Auth08UserInfoV7profile10Foundation3URLVSgvp","role":"symbol","roleHeading":"Instance Property"},"sections":[],"abstract":[{"text":"The URL of the user’s profile page.","type":"text"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/profile"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/profile","interfaceLanguage":"swift"},"kind":"symbol","schemaVersion":{"patch":0,"major":0,"minor":3},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"profile"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"URL","preciseIdentifier":"s:10Foundation3URLV"},{"kind":"text","text":"?"}],"platforms":["iOS"]}]},{"kind":"content","content":[{"text":"Discussion","level":2,"type":"heading","anchor":"discussion"},{"content":[{"type":"paragraph","inlineContent":[{"text":"The ","type":"text"},{"code":"profile","type":"codeVoice"},{"text":" scope.","type":"text"}]}],"style":"note","name":"Requires","type":"aside"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/profile":{"url":"\/documentation\/auth0\/userinfo\/profile","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"profile"},{"kind":"text","text":": "},{"preciseIdentifier":"s:10Foundation3URLV","kind":"typeIdentifier","text":"URL"},{"kind":"text","text":"?"}],"title":"profile","type":"topic","role":"symbol","abstract":[{"text":"The URL of the user’s profile page.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/profile","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"title":"UserInfo","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"UserInfo"}],"abstract":[{"text":"OIDC Standard Claims user information.","type":"text"}],"url":"\/documentation\/auth0\/userinfo","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/userinfo/publicclaims.json b/docs/data/documentation/auth0/userinfo/publicclaims.json index 6dd4ac93c..4aa6330c9 100644 --- a/docs/data/documentation/auth0/userinfo/publicclaims.json +++ b/docs/data/documentation/auth0/userinfo/publicclaims.json @@ -1 +1 @@ -{"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\/publicClaims","interfaceLanguage":"swift"},"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"symbolKind":"property","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"publicClaims","kind":"identifier"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"]","kind":"text"}],"roleHeading":"Type Property","role":"symbol","title":"publicClaims","externalID":"s:5Auth08UserInfoV12publicClaimsSaySSGvpZ","modules":[{"name":"Auth0"}]},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"publicClaims"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"]"}]}],"kind":"declarations"}],"abstract":[{"text":"The list of public claims.","type":"text"}],"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/userinfo\/publicclaims"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"text":"UserInfo","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/userinfo","type":"topic","title":"UserInfo","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/publicClaims":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/publicClaims","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"publicClaims","kind":"identifier"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"]","kind":"text"}],"kind":"symbol","abstract":[{"text":"The list of public claims.","type":"text"}],"url":"\/documentation\/auth0\/userinfo\/publicclaims","title":"publicClaims","type":"topic"}}} \ No newline at end of file +{"metadata":{"symbolKind":"property","roleHeading":"Type Property","title":"publicClaims","externalID":"s:5Auth08UserInfoV12publicClaimsSaySSGvpZ","modules":[{"name":"Auth0"}],"fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"publicClaims","kind":"identifier"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"]","kind":"text"}],"role":"symbol"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/publicclaims"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/publicClaims"},"kind":"symbol","abstract":[{"type":"text","text":"The list of public claims."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"publicClaims","kind":"identifier"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"]","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/publicClaims":{"url":"\/documentation\/auth0\/userinfo\/publicclaims","title":"publicClaims","abstract":[{"type":"text","text":"The list of public claims."}],"fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"publicClaims"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"]"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/publicClaims","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"title":"UserInfo","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"UserInfo"}],"abstract":[{"text":"OIDC Standard Claims user information.","type":"text"}],"url":"\/documentation\/auth0\/userinfo","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/userinfo/sub.json b/docs/data/documentation/auth0/userinfo/sub.json index b5bb83786..5a83ecef0 100644 --- a/docs/data/documentation/auth0/userinfo/sub.json +++ b/docs/data/documentation/auth0/userinfo/sub.json @@ -1 +1 @@ -{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/sub"]}],"metadata":{"roleHeading":"Instance Property","title":"sub","externalID":"s:5Auth08UserInfoV3subSSvp","role":"symbol","symbolKind":"property","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"sub","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"modules":[{"name":"Auth0"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/sub","interfaceLanguage":"swift"},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"sub"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}]}],"kind":"declarations"}],"kind":"symbol","sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"schemaVersion":{"major":0,"patch":0,"minor":3},"abstract":[{"type":"text","text":"The Auth0 user identifier."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/sub":{"url":"\/documentation\/auth0\/userinfo\/sub","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/sub","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"sub","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"type":"topic","role":"symbol","title":"sub","abstract":[{"text":"The Auth0 user identifier.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"text":"UserInfo","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/userinfo","type":"topic","title":"UserInfo","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"}}} \ No newline at end of file +{"abstract":[{"text":"The Auth0 user identifier.","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"sub"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"platforms":["iOS"]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/sub"]}],"schemaVersion":{"major":0,"patch":0,"minor":3},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"metadata":{"modules":[{"name":"Auth0"}],"title":"sub","roleHeading":"Instance Property","symbolKind":"property","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"sub"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"externalID":"s:5Auth08UserInfoV3subSSvp"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/sub"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/sub":{"url":"\/documentation\/auth0\/userinfo\/sub","title":"sub","abstract":[{"type":"text","text":"The Auth0 user identifier."}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"sub"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/sub","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"title":"UserInfo","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"UserInfo"}],"abstract":[{"text":"OIDC Standard Claims user information.","type":"text"}],"url":"\/documentation\/auth0\/userinfo","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]}}} \ 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 1e2150c70..f0a3dbd72 100644 --- a/docs/data/documentation/auth0/userinfo/updatedat.json +++ b/docs/data/documentation/auth0/userinfo/updatedat.json @@ -1 +1 @@ -{"variants":[{"paths":["\/documentation\/auth0\/userinfo\/updatedat"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"kind":"symbol","sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/updatedAt","interfaceLanguage":"swift"},"metadata":{"roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"role":"symbol","symbolKind":"property","title":"updatedAt","externalID":"s:5Auth08UserInfoV9updatedAt10Foundation4DateVSgvp","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"updatedAt","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Date","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DateV"},{"text":"?","kind":"text"}]},"abstract":[{"text":"The date and time the user’s information was last updated.","type":"text"}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"updatedAt","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Date","preciseIdentifier":"s:10Foundation4DateV","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"platforms":["iOS"]}],"kind":"declarations"},{"content":[{"type":"heading","anchor":"discussion","level":2,"text":"Discussion"},{"type":"aside","name":"Requires","style":"note","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"type":"codeVoice","code":"profile"},{"type":"text","text":" scope."}]}]}],"kind":"content"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"text":"UserInfo","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/userinfo","type":"topic","title":"UserInfo","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/updatedAt":{"url":"\/documentation\/auth0\/userinfo\/updatedat","abstract":[{"text":"The date and time the user’s information was last updated.","type":"text"}],"kind":"symbol","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"updatedAt","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Date","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DateV"},{"text":"?","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/updatedAt","title":"updatedAt","type":"topic"}}} \ No newline at end of file +{"abstract":[{"text":"The date and time the user’s information was last updated.","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"updatedAt","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation4DateV","text":"Date","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"platforms":["iOS"]}]},{"content":[{"text":"Discussion","level":2,"type":"heading","anchor":"discussion"},{"content":[{"inlineContent":[{"type":"text","text":"The "},{"type":"codeVoice","code":"profile"},{"type":"text","text":" scope."}],"type":"paragraph"}],"style":"note","name":"Requires","type":"aside"}],"kind":"content"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/updatedat"]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"metadata":{"modules":[{"name":"Auth0"}],"title":"updatedAt","roleHeading":"Instance Property","symbolKind":"property","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"updatedAt","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation4DateV","text":"Date","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"externalID":"s:5Auth08UserInfoV9updatedAt10Foundation4DateVSgvp"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/updatedAt","interfaceLanguage":"swift"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"title":"UserInfo","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"UserInfo"}],"abstract":[{"text":"OIDC Standard Claims user information.","type":"text"}],"url":"\/documentation\/auth0\/userinfo","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/updatedAt":{"url":"\/documentation\/auth0\/userinfo\/updatedat","title":"updatedAt","abstract":[{"type":"text","text":"The date and time the user’s information was last updated."}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"updatedAt"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DateV","text":"Date"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/updatedAt","role":"symbol","kind":"symbol","type":"topic"}}} \ 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 411d3f8af..85701fa71 100644 --- a/docs/data/documentation/auth0/userinfo/website.json +++ b/docs/data/documentation/auth0/userinfo/website.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"metadata":{"title":"website","roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"externalID":"s:5Auth08UserInfoV7website10Foundation3URLVSgvp","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"website"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"URL","preciseIdentifier":"s:10Foundation3URLV"},{"kind":"text","text":"?"}],"symbolKind":"property"},"sections":[],"abstract":[{"text":"The URL of the user’s website.","type":"text"}],"kind":"symbol","schemaVersion":{"major":0,"patch":0,"minor":3},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/website"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/website"},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"website"},{"kind":"text","text":": "},{"preciseIdentifier":"s:10Foundation3URLV","kind":"typeIdentifier","text":"URL"},{"kind":"text","text":"?"}]}],"kind":"declarations"},{"content":[{"text":"Discussion","type":"heading","anchor":"discussion","level":2},{"name":"Requires","style":"note","type":"aside","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"type":"codeVoice","code":"profile"},{"type":"text","text":" scope."}]}]}],"kind":"content"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/website":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/website","kind":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"website","kind":"identifier"},{"text":": ","kind":"text"},{"text":"URL","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV"},{"text":"?","kind":"text"}],"abstract":[{"type":"text","text":"The URL of the user’s website."}],"title":"website","url":"\/documentation\/auth0\/userinfo\/website","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"text":"UserInfo","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/userinfo","type":"topic","title":"UserInfo","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"}}} \ No newline at end of file +{"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"website"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV","text":"URL"},{"kind":"text","text":"?"}],"platforms":["iOS"],"languages":["swift"]}]},{"kind":"content","content":[{"level":2,"anchor":"discussion","text":"Discussion","type":"heading"},{"content":[{"inlineContent":[{"text":"The ","type":"text"},{"type":"codeVoice","code":"profile"},{"text":" scope.","type":"text"}],"type":"paragraph"}],"name":"Requires","style":"note","type":"aside"}]}],"variants":[{"paths":["\/documentation\/auth0\/userinfo\/website"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"schemaVersion":{"patch":0,"major":0,"minor":3},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/website","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"abstract":[{"type":"text","text":"The URL of the user’s website."}],"metadata":{"roleHeading":"Instance Property","symbolKind":"property","title":"website","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"text":"website","kind":"identifier"},{"kind":"text","text":": "},{"text":"URL","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV"},{"kind":"text","text":"?"}],"externalID":"s:5Auth08UserInfoV7website10Foundation3URLVSgvp","modules":[{"name":"Auth0"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/website":{"url":"\/documentation\/auth0\/userinfo\/website","title":"website","abstract":[{"type":"text","text":"The URL of the user’s website."}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"website"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV","text":"URL"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/website","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"title":"UserInfo","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"UserInfo"}],"abstract":[{"text":"OIDC Standard Claims user information.","type":"text"}],"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 8e071892f..c9e661ed0 100644 --- a/docs/data/documentation/auth0/userinfo/zoneinfo.json +++ b/docs/data/documentation/auth0/userinfo/zoneinfo.json @@ -1 +1 @@ -{"schemaVersion":{"minor":3,"major":0,"patch":0},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/zoneinfo","interfaceLanguage":"swift"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/zoneinfo"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"zoneinfo","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation8TimeZoneV","text":"TimeZone","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"languages":["swift"]}]},{"content":[{"level":2,"anchor":"discussion","type":"heading","text":"Discussion"},{"style":"note","content":[{"inlineContent":[{"text":"The ","type":"text"},{"code":"profile","type":"codeVoice"},{"text":" scope.","type":"text"}],"type":"paragraph"}],"type":"aside","name":"Requires"}],"kind":"content"}],"abstract":[{"text":"The time zone of the user.","type":"text"}],"sections":[],"metadata":{"roleHeading":"Instance Property","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"zoneinfo","kind":"identifier"},{"text":": ","kind":"text"},{"text":"TimeZone","preciseIdentifier":"s:10Foundation8TimeZoneV","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"modules":[{"name":"Auth0"}],"externalID":"s:5Auth08UserInfoV8zoneinfo10Foundation8TimeZoneVSgvp","role":"symbol","title":"zoneinfo","symbolKind":"property"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/zoneinfo":{"url":"\/documentation\/auth0\/userinfo\/zoneinfo","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"zoneinfo","kind":"identifier"},{"text":": ","kind":"text"},{"text":"TimeZone","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation8TimeZoneV"},{"text":"?","kind":"text"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/zoneinfo","title":"zoneinfo","type":"topic","role":"symbol","abstract":[{"type":"text","text":"The time zone of the user."}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"text":"UserInfo","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/userinfo","type":"topic","title":"UserInfo","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"]]},"metadata":{"symbolKind":"property","modules":[{"name":"Auth0"}],"title":"zoneinfo","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"zoneinfo","kind":"identifier"},{"text":": ","kind":"text"},{"text":"TimeZone","preciseIdentifier":"s:10Foundation8TimeZoneV","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"externalID":"s:5Auth08UserInfoV8zoneinfo10Foundation8TimeZoneVSgvp","role":"symbol","roleHeading":"Instance Property"},"sections":[],"abstract":[{"type":"text","text":"The time zone of the user."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userinfo\/zoneinfo"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/zoneinfo","interfaceLanguage":"swift"},"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"zoneinfo","kind":"identifier"},{"text":": ","kind":"text"},{"text":"TimeZone","preciseIdentifier":"s:10Foundation8TimeZoneV","kind":"typeIdentifier"},{"text":"?","kind":"text"}]}],"kind":"declarations"},{"content":[{"level":2,"anchor":"discussion","type":"heading","text":"Discussion"},{"name":"Requires","content":[{"inlineContent":[{"type":"text","text":"The "},{"type":"codeVoice","code":"profile"},{"type":"text","text":" scope."}],"type":"paragraph"}],"type":"aside","style":"note"}],"kind":"content"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserInfo/zoneinfo":{"url":"\/documentation\/auth0\/userinfo\/zoneinfo","title":"zoneinfo","abstract":[{"type":"text","text":"The time zone of the user."}],"fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"zoneinfo"},{"kind":"text","text":": "},{"preciseIdentifier":"s:10Foundation8TimeZoneV","kind":"typeIdentifier","text":"TimeZone"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo\/zoneinfo","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"title":"UserInfo","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"UserInfo"}],"abstract":[{"text":"OIDC Standard Claims user information.","type":"text"}],"url":"\/documentation\/auth0\/userinfo","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/userpatchattributes.json b/docs/data/documentation/auth0/userpatchattributes.json index 4b6e50ed9..8d5db6585 100644 --- a/docs/data/documentation/auth0/userpatchattributes.json +++ b/docs/data/documentation/auth0/userpatchattributes.json @@ -1 +1 @@ -{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userpatchattributes"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","interfaceLanguage":"swift"},"abstract":[{"text":"User attributes that can be updated using the ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","isActive":true,"type":"reference"},{"text":" method of ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","isActive":true,"type":"reference"},{"text":".","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/init(dictionary:)"],"title":"Initializers","generated":true,"anchor":"Initializers"},{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/appMetadata(_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/blocked(_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/email(_:verified:verify:connection:clientId:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/emailVerified(_:connection:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/password(_:verify:connection:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/phoneNumber(_:verified:verify:connection:clientId:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/phoneVerified(_:connection:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/userMetadata(_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/username(_:connection:)"],"title":"Instance Methods","generated":true,"anchor":"Instance-Methods"}],"metadata":{"fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"UserPatchAttributes"}],"role":"symbol","externalID":"s:5Auth019UserPatchAttributesC","roleHeading":"Class","navigatorTitle":[{"kind":"identifier","text":"UserPatchAttributes"}],"title":"UserPatchAttributes","modules":[{"name":"Auth0"}],"symbolKind":"class"},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"final"},{"kind":"text","text":" "},{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"UserPatchAttributes"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"sections":[],"schemaVersion":{"minor":3,"major":0,"patch":0},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/userMetadata(_:)":{"url":"\/documentation\/auth0\/userpatchattributes\/usermetadata(_:)","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/userMetadata(_:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"userMetadata","kind":"identifier"},{"text":"([","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"]) -> ","kind":"text"},{"text":"UserPatchAttributes","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}],"title":"userMetadata(_:)","abstract":[{"type":"text","text":"Update user metadata."}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"type":"topic","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Users","kind":"identifier"}],"title":"Users","navigatorTitle":[{"text":"Users","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","url":"\/documentation\/auth0\/users","kind":"symbol","abstract":[{"type":"text","text":"Client for the Users endpoints of the Auth0 "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"type":"text","text":"."}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/username(_:connection:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/username(_:connection:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"username"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}],"url":"\/documentation\/auth0\/userpatchattributes\/username(_:connection:)","role":"symbol","deprecated":true,"kind":"symbol","type":"topic","title":"username(_:connection:)","abstract":[{"type":"text","text":"Change the username."}]},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/phoneNumber(_:verified:verify:connection:clientId:)":{"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"phoneNumber","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"verified","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"verify","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"clientId","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes","kind":"typeIdentifier"}],"type":"topic","deprecated":true,"title":"phoneNumber(_:verified:verify:connection:clientId:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/phoneNumber(_:verified:verify:connection:clientId:)","url":"\/documentation\/auth0\/userpatchattributes\/phonenumber(_:verified:verify:connection:clientid:)","abstract":[{"text":"Change the phone number of the user (SMS connection only).","type":"text"}]},"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":[{"type":"text","text":"Management API v2"}],"type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/emailVerified(_:connection:)":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"emailVerified","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes","kind":"typeIdentifier"}],"kind":"symbol","url":"\/documentation\/auth0\/userpatchattributes\/emailverified(_:connection:)","role":"symbol","deprecated":true,"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/emailVerified(_:connection:)","title":"emailVerified(_:connection:)","abstract":[{"type":"text","text":"Set the verified status of the email."}]},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/email(_:verified:verify:connection:clientId:)":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"email"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"verified"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"verify"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"text":"?, ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"clientId","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"UserPatchAttributes","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}],"kind":"symbol","url":"\/documentation\/auth0\/userpatchattributes\/email(_:verified:verify:connection:clientid:)","role":"symbol","deprecated":true,"title":"email(_:verified:verify:connection:clientId:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/email(_:verified:verify:connection:clientId:)","abstract":[{"type":"text","text":"Change the email of the user."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/phoneVerified(_:connection:)":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"phoneVerified","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes","kind":"typeIdentifier"}],"kind":"symbol","url":"\/documentation\/auth0\/userpatchattributes\/phoneverified(_:connection:)","role":"symbol","deprecated":true,"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/phoneVerified(_:connection:)","title":"phoneVerified(_:connection:)","abstract":[{"type":"text","text":"Set the verified status of the phone number."}]},"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"required":true,"kind":"symbol","url":"\/documentation\/auth0\/users\/patch(_:attributes:)","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"patch"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"attributes"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","kind":"typeIdentifier","text":"UserPatchAttributes"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError"},{"kind":"text","text":">"}],"deprecated":true,"title":"patch(_:attributes:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","abstract":[{"type":"text","text":"Updates a user’s root values (those which are allowed to be updated)."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/init(dictionary:)":{"fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"dictionary","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"])","kind":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/userpatchattributes\/init(dictionary:)","role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/init(dictionary:)","title":"init(dictionary:)","abstract":[{"type":"text","text":"Creates a new "},{"code":"UserPatchAttributes","type":"codeVoice"},{"type":"text","text":" instance."}]},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes":{"url":"\/documentation\/auth0\/userpatchattributes","kind":"symbol","role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserPatchAttributes","kind":"identifier"}],"navigatorTitle":[{"text":"UserPatchAttributes","kind":"identifier"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","title":"UserPatchAttributes","abstract":[{"type":"text","text":"User attributes that can be updated using the "},{"type":"reference","isActive":true,"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"},{"type":"text","text":"."}]},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/password(_:verify:connection:)":{"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"password","kind":"identifier"},{"text":"(","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"verify","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"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"}],"url":"\/documentation\/auth0\/userpatchattributes\/password(_:verify:connection:)","type":"topic","kind":"symbol","deprecated":true,"abstract":[{"type":"text","text":"Change the user’s password."}],"title":"password(_:verify:connection:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/password(_:verify:connection:)"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/appMetadata(_:)":{"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"appMetadata","kind":"identifier"},{"text":"([","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"]) -> ","kind":"text"},{"text":"UserPatchAttributes","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}],"url":"\/documentation\/auth0\/userpatchattributes\/appmetadata(_:)","type":"topic","kind":"symbol","deprecated":true,"abstract":[{"type":"text","text":"Update app metadata."}],"title":"appMetadata(_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/appMetadata(_:)"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/blocked(_:)":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"blocked"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}],"role":"symbol","type":"topic","abstract":[{"type":"text","text":"Mark\/unmark a user as blocked."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/blocked(_:)","title":"blocked(_:)","url":"\/documentation\/auth0\/userpatchattributes\/blocked(_:)","deprecated":true,"kind":"symbol"}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userpatchattributes"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"abstract":[{"type":"text","text":"User attributes that can be updated using the "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","isActive":true},{"type":"text","text":" method of "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","isActive":true},{"type":"text","text":"."}],"topicSections":[{"title":"Initializers","generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/init(dictionary:)"],"anchor":"Initializers"},{"title":"Instance Methods","generated":true,"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:)"],"anchor":"Instance-Methods"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","sections":[],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"final"},{"kind":"text","text":" "},{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"UserPatchAttributes"}]}],"kind":"declarations"}],"metadata":{"externalID":"s:5Auth019UserPatchAttributesC","symbolKind":"class","title":"UserPatchAttributes","roleHeading":"Class","role":"symbol","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"UserPatchAttributes"}],"navigatorTitle":[{"kind":"identifier","text":"UserPatchAttributes"}],"modules":[{"name":"Auth0"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/password(_:verify:connection:)":{"kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"password","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"verify","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes","kind":"typeIdentifier"}],"deprecated":true,"title":"password(_:verify:connection:)","type":"topic","role":"symbol","abstract":[{"text":"Change the user’s password.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/password(_:verify:connection:)","url":"\/documentation\/auth0\/userpatchattributes\/password(_:verify:connection:)"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/appMetadata(_:)":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/appMetadata(_:)","title":"appMetadata(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"appMetadata"},{"kind":"text","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"}],"role":"symbol","deprecated":true,"url":"\/documentation\/auth0\/userpatchattributes\/appmetadata(_:)","abstract":[{"type":"text","text":"Update app metadata."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes":{"title":"UserPatchAttributes","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"UserPatchAttributes"}],"abstract":[{"text":"User attributes that can be updated using the ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","isActive":true,"type":"reference"},{"text":" method of ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","isActive":true,"type":"reference"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/userpatchattributes","navigatorTitle":[{"kind":"identifier","text":"UserPatchAttributes"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/phoneVerified(_:connection:)":{"url":"\/documentation\/auth0\/userpatchattributes\/phoneverified(_:connection:)","abstract":[{"type":"text","text":"Set the verified status of the phone number."}],"title":"phoneVerified(_:connection:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"phoneVerified","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/phoneVerified(_:connection:)","role":"symbol","kind":"symbol","deprecated":true,"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"role":"symbol","title":"patch(_:attributes:)","deprecated":true,"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"patch","kind":"identifier"},{"text":"(","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"attributes","kind":"externalParam"},{"kind":"text","text":": "},{"text":"UserPatchAttributes","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError","kind":"typeIdentifier"},{"kind":"text","text":">"}],"abstract":[{"type":"text","text":"Updates a user’s root values (those which are allowed to be updated)."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","url":"\/documentation\/auth0\/users\/patch(_:attributes:)","required":true,"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/phoneNumber(_:verified:verify:connection:clientId:)":{"type":"topic","title":"phoneNumber(_:verified:verify:connection:clientId:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/phoneNumber(_:verified:verify:connection:clientId:)","kind":"symbol","abstract":[{"type":"text","text":"Change the phone number of the user (SMS connection only)."}],"url":"\/documentation\/auth0\/userpatchattributes\/phonenumber(_:verified:verify:connection:clientid:)","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"phoneNumber"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"verified"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"verify"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"clientId"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","kind":"typeIdentifier","text":"UserPatchAttributes"}],"deprecated":true},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/username(_:connection:)":{"type":"topic","title":"username(_:connection:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/username(_:connection:)","kind":"symbol","abstract":[{"text":"Change the username.","type":"text"}],"url":"\/documentation\/auth0\/userpatchattributes\/username(_:connection:)","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"username"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes"}],"deprecated":true},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/userMetadata(_:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/userMetadata(_:)","kind":"symbol","title":"userMetadata(_:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"userMetadata","kind":"identifier"},{"text":"([","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"]) -> ","kind":"text"},{"text":"UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC","kind":"typeIdentifier"}],"role":"symbol","url":"\/documentation\/auth0\/userpatchattributes\/usermetadata(_:)","abstract":[{"type":"text","text":"Update user metadata."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/blocked(_:)":{"type":"topic","title":"blocked(_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/blocked(_:)","kind":"symbol","abstract":[{"text":"Mark\/unmark a user as blocked.","type":"text"}],"url":"\/documentation\/auth0\/userpatchattributes\/blocked(_:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"blocked","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes","kind":"typeIdentifier"}],"deprecated":true},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/init(dictionary:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/init(dictionary:)","kind":"symbol","title":"init(dictionary:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"dictionary"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"])"}],"role":"symbol","url":"\/documentation\/auth0\/userpatchattributes\/init(dictionary:)","abstract":[{"type":"text","text":"Creates a new "},{"type":"codeVoice","code":"UserPatchAttributes"},{"type":"text","text":" instance."}],"type":"topic"},"https://auth0.com/docs/api/management/v2":{"title":"Management API v2","url":"https:\/\/auth0.com\/docs\/api\/management\/v2","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","titleInlineContent":[{"type":"text","text":"Management API v2"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/email(_:verified:verify:connection:clientId:)":{"kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"email"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"verified"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"verify"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"clientId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes"}],"deprecated":true,"title":"email(_:verified:verify:connection:clientId:)","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Change the email of the user."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/email(_:verified:verify:connection:clientId:)","url":"\/documentation\/auth0\/userpatchattributes\/email(_:verified:verify:connection:clientid:)"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/emailVerified(_:connection:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/emailVerified(_:connection:)","title":"emailVerified(_:connection:)","type":"topic","role":"symbol","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"emailVerified","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes"}],"abstract":[{"text":"Set the verified status of the email.","type":"text"}],"url":"\/documentation\/auth0\/userpatchattributes\/emailverified(_:connection:)","deprecated":true},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"url":"\/documentation\/auth0\/users","title":"Users","abstract":[{"type":"text","text":"Client for the Users endpoints of the Auth0 "},{"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","type":"reference","isActive":true},{"text":".","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"Users"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Users"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","role":"symbol","kind":"symbol","type":"topic"}}} \ 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 8896d8843..83bdedd89 100644 --- a/docs/data/documentation/auth0/userpatchattributes/appmetadata(_:).json +++ b/docs/data/documentation/auth0/userpatchattributes/appmetadata(_:).json @@ -1 +1 @@ -{"abstract":[{"type":"text","text":"Update app metadata."}],"deprecationSummary":[{"type":"paragraph","inlineContent":[{"text":"This attribute can no longer be updated from native apps for security reasons","type":"text"}]}],"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"]]},"kind":"symbol","primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"appMetadata"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"metadata"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]) -> "},{"kind":"typeIdentifier","text":"UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"},{"parameters":[{"content":[{"inlineContent":[{"type":"text","text":"New app metadata values."}],"type":"paragraph"}],"name":"metadata"}],"kind":"parameters"},{"content":[{"text":"Return Value","level":2,"anchor":"return-value","type":"heading"},{"inlineContent":[{"text":"The same ","type":"text"},{"type":"codeVoice","code":"UserPatchAttributes"},{"text":" instance to allow method chaining.","type":"text"}],"type":"paragraph"}],"kind":"content"}],"schemaVersion":{"minor":3,"major":0,"patch":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/appMetadata(_:)","interfaceLanguage":"swift"},"metadata":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"appMetadata","kind":"identifier"},{"text":"([","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"]) -> ","kind":"text"},{"text":"UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC","kind":"typeIdentifier"}],"title":"appMetadata(_:)","symbolKind":"method","roleHeading":"Instance Method","role":"symbol","externalID":"s:5Auth019UserPatchAttributesC11appMetadatayACSDySSypGF","platforms":[{"message":"This attribute can no longer be updated from native apps for security reasons","beta":false,"deprecated":true,"unavailable":false}],"modules":[{"name":"Auth0"}]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userpatchattributes\/appmetadata(_:)"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"required":true,"kind":"symbol","url":"\/documentation\/auth0\/users\/patch(_:attributes:)","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"patch"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"attributes"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","kind":"typeIdentifier","text":"UserPatchAttributes"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError"},{"kind":"text","text":">"}],"deprecated":true,"title":"patch(_:attributes:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","abstract":[{"type":"text","text":"Updates a user’s root values (those which are allowed to be updated)."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/appMetadata(_:)":{"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"appMetadata","kind":"identifier"},{"text":"([","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"]) -> ","kind":"text"},{"text":"UserPatchAttributes","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}],"url":"\/documentation\/auth0\/userpatchattributes\/appmetadata(_:)","type":"topic","kind":"symbol","deprecated":true,"abstract":[{"type":"text","text":"Update app metadata."}],"title":"appMetadata(_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/appMetadata(_:)"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes":{"url":"\/documentation\/auth0\/userpatchattributes","kind":"symbol","role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserPatchAttributes","kind":"identifier"}],"navigatorTitle":[{"text":"UserPatchAttributes","kind":"identifier"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","title":"UserPatchAttributes","abstract":[{"type":"text","text":"User attributes that can be updated using the "},{"type":"reference","isActive":true,"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"},{"type":"text","text":"."}]},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"type":"topic","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Users","kind":"identifier"}],"title":"Users","navigatorTitle":[{"text":"Users","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","url":"\/documentation\/auth0\/users","kind":"symbol","abstract":[{"type":"text","text":"Client for the Users endpoints of the Auth0 "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"type":"text","text":"."}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"metadata":{"platforms":[{"message":"This attribute can no longer be updated from native apps for security reasons","deprecated":true,"beta":false,"unavailable":false}],"symbolKind":"method","title":"appMetadata(_:)","externalID":"s:5Auth019UserPatchAttributesC11appMetadatayACSDySSypGF","roleHeading":"Instance Method","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"appMetadata","kind":"identifier"},{"kind":"text","text":"(["},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"kind":"text","text":"]) -> "},{"kind":"typeIdentifier","text":"UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}],"role":"symbol"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userpatchattributes\/appmetadata(_:)"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/appMetadata(_:)","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"type":"text","text":"Update app metadata."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"]]},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"appMetadata"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"metadata"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","text":"UserPatchAttributes"}]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"New app metadata values."}]}],"name":"metadata"}]},{"content":[{"level":2,"type":"heading","anchor":"return-value","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The same "},{"type":"codeVoice","code":"UserPatchAttributes"},{"type":"text","text":" instance to allow method chaining."}]}],"kind":"content"}],"deprecationSummary":[{"type":"paragraph","inlineContent":[{"type":"text","text":"This attribute can no longer be updated from native apps for security reasons"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"role":"symbol","title":"patch(_:attributes:)","deprecated":true,"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"patch","kind":"identifier"},{"text":"(","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"attributes","kind":"externalParam"},{"kind":"text","text":": "},{"text":"UserPatchAttributes","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError","kind":"typeIdentifier"},{"kind":"text","text":">"}],"abstract":[{"type":"text","text":"Updates a user’s root values (those which are allowed to be updated)."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","url":"\/documentation\/auth0\/users\/patch(_:attributes:)","required":true,"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/appMetadata(_:)":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/appMetadata(_:)","title":"appMetadata(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"appMetadata"},{"kind":"text","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"}],"role":"symbol","deprecated":true,"url":"\/documentation\/auth0\/userpatchattributes\/appmetadata(_:)","abstract":[{"type":"text","text":"Update app metadata."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes":{"title":"UserPatchAttributes","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"UserPatchAttributes"}],"abstract":[{"text":"User attributes that can be updated using the ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","isActive":true,"type":"reference"},{"text":" method of ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","isActive":true,"type":"reference"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/userpatchattributes","navigatorTitle":[{"kind":"identifier","text":"UserPatchAttributes"}]},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"url":"\/documentation\/auth0\/users","title":"Users","abstract":[{"type":"text","text":"Client for the Users endpoints of the Auth0 "},{"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","type":"reference","isActive":true},{"text":".","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"Users"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Users"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"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 46ebfe580..ab20ed1c1 100644 --- a/docs/data/documentation/auth0/userpatchattributes/blocked(_:).json +++ b/docs/data/documentation/auth0/userpatchattributes/blocked(_:).json @@ -1 +1 @@ -{"variants":[{"paths":["\/documentation\/auth0\/userpatchattributes\/blocked(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"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"]]},"sections":[],"schemaVersion":{"major":0,"patch":0,"minor":3},"abstract":[{"type":"text","text":"Mark\/unmark a user as blocked."}],"metadata":{"role":"symbol","platforms":[{"unavailable":false,"message":"This attribute can no longer be updated from native apps for security reasons","deprecated":true,"beta":false}],"roleHeading":"Instance Method","symbolKind":"method","modules":[{"name":"Auth0"}],"externalID":"s:5Auth019UserPatchAttributesC7blockedyACSbF","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"blocked","kind":"identifier"},{"text":"(","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"text":") -> ","kind":"text"},{"text":"UserPatchAttributes","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}],"title":"blocked(_:)"},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"blocked"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"blocked"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"UserPatchAttributes","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"},{"parameters":[{"content":[{"inlineContent":[{"type":"text","text":"If the user is blocked."}],"type":"paragraph"}],"name":"blocked"}],"kind":"parameters"},{"content":[{"anchor":"return-value","text":"Return Value","type":"heading","level":2},{"inlineContent":[{"text":"The same ","type":"text"},{"code":"UserPatchAttributes","type":"codeVoice"},{"text":" instance to allow method chaining.","type":"text"}],"type":"paragraph"}],"kind":"content"}],"deprecationSummary":[{"inlineContent":[{"type":"text","text":"This attribute can no longer be updated from native apps for security reasons"}],"type":"paragraph"}],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/Users":{"type":"topic","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Users","kind":"identifier"}],"title":"Users","navigatorTitle":[{"text":"Users","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","url":"\/documentation\/auth0\/users","kind":"symbol","abstract":[{"type":"text","text":"Client for the Users endpoints of the Auth0 "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"type":"text","text":"."}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"required":true,"kind":"symbol","url":"\/documentation\/auth0\/users\/patch(_:attributes:)","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"patch"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"attributes"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","kind":"typeIdentifier","text":"UserPatchAttributes"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError"},{"kind":"text","text":">"}],"deprecated":true,"title":"patch(_:attributes:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","abstract":[{"type":"text","text":"Updates a user’s root values (those which are allowed to be updated)."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes":{"url":"\/documentation\/auth0\/userpatchattributes","kind":"symbol","role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserPatchAttributes","kind":"identifier"}],"navigatorTitle":[{"text":"UserPatchAttributes","kind":"identifier"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","title":"UserPatchAttributes","abstract":[{"type":"text","text":"User attributes that can be updated using the "},{"type":"reference","isActive":true,"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"},{"type":"text","text":"."}]},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/blocked(_:)":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"blocked"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}],"role":"symbol","type":"topic","abstract":[{"type":"text","text":"Mark\/unmark a user as blocked."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/blocked(_:)","title":"blocked(_:)","url":"\/documentation\/auth0\/userpatchattributes\/blocked(_:)","deprecated":true,"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"metadata":{"platforms":[{"message":"This attribute can no longer be updated from native apps for security reasons","unavailable":false,"deprecated":true,"beta":false}],"symbolKind":"method","title":"blocked(_:)","externalID":"s:5Auth019UserPatchAttributesC7blockedyACSbF","roleHeading":"Instance Method","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"blocked"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}],"role":"symbol"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userpatchattributes\/blocked(_:)"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/blocked(_:)"},"kind":"symbol","abstract":[{"text":"Mark\/unmark a user as blocked.","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"blocked"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"blocked"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"UserPatchAttributes","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}],"languages":["swift"],"platforms":["iOS"]}]},{"parameters":[{"name":"blocked","content":[{"type":"paragraph","inlineContent":[{"text":"If the user is blocked.","type":"text"}]}]}],"kind":"parameters"},{"kind":"content","content":[{"anchor":"return-value","text":"Return Value","type":"heading","level":2},{"inlineContent":[{"text":"The same ","type":"text"},{"code":"UserPatchAttributes","type":"codeVoice"},{"text":" instance to allow method chaining.","type":"text"}],"type":"paragraph"}]}],"deprecationSummary":[{"type":"paragraph","inlineContent":[{"text":"This attribute can no longer be updated from native apps for security reasons","type":"text"}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"role":"symbol","title":"patch(_:attributes:)","deprecated":true,"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"patch","kind":"identifier"},{"text":"(","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"attributes","kind":"externalParam"},{"kind":"text","text":": "},{"text":"UserPatchAttributes","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError","kind":"typeIdentifier"},{"kind":"text","text":">"}],"abstract":[{"type":"text","text":"Updates a user’s root values (those which are allowed to be updated)."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","url":"\/documentation\/auth0\/users\/patch(_:attributes:)","required":true,"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes":{"title":"UserPatchAttributes","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"UserPatchAttributes"}],"abstract":[{"text":"User attributes that can be updated using the ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","isActive":true,"type":"reference"},{"text":" method of ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","isActive":true,"type":"reference"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/userpatchattributes","navigatorTitle":[{"kind":"identifier","text":"UserPatchAttributes"}]},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"url":"\/documentation\/auth0\/users","title":"Users","abstract":[{"type":"text","text":"Client for the Users endpoints of the Auth0 "},{"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","type":"reference","isActive":true},{"text":".","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"Users"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Users"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/blocked(_:)":{"type":"topic","title":"blocked(_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/blocked(_:)","kind":"symbol","abstract":[{"text":"Mark\/unmark a user as blocked.","type":"text"}],"url":"\/documentation\/auth0\/userpatchattributes\/blocked(_:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"blocked","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes","kind":"typeIdentifier"}],"deprecated":true}}} \ 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 790acc1b8..d55d78b29 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 @@ -{"abstract":[{"type":"text","text":"Change the email of the user."}],"deprecationSummary":[{"type":"paragraph","inlineContent":[{"type":"text","text":"This attribute can no longer be updated from native apps for security reasons"}]}],"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","primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"email"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"email"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"verified"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"},{"kind":"text","text":"? = nil, "},{"kind":"externalParam","text":"verify"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"},{"kind":"text","text":"? = nil, "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"clientId"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":") -> "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC","kind":"typeIdentifier","text":"UserPatchAttributes"}],"platforms":["iOS"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"email","content":[{"type":"paragraph","inlineContent":[{"text":"New email for the user.","type":"text"}]}]},{"name":"verified","content":[{"inlineContent":[{"text":"If the email is verified.","type":"text"}],"type":"paragraph"}]},{"name":"verify","content":[{"inlineContent":[{"type":"text","text":"If the user should verify the email."}],"type":"paragraph"}]},{"name":"connection","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Name of the connection."}]}]},{"name":"clientId","content":[{"inlineContent":[{"text":"Auth0 Client ID.","type":"text"}],"type":"paragraph"}]}]},{"kind":"content","content":[{"type":"heading","text":"Return Value","anchor":"return-value","level":2},{"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},"metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"email"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"verified"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"verify"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"clientId"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","kind":"typeIdentifier","text":"UserPatchAttributes"}],"roleHeading":"Instance Method","platforms":[{"unavailable":false,"message":"This attribute can no longer be updated from native apps for security reasons","deprecated":true,"beta":false}],"externalID":"s:5Auth019UserPatchAttributesC5email_8verified6verify10connection8clientIdACSS_SbSgAIS2StF","role":"symbol","symbolKind":"method","modules":[{"name":"Auth0"}],"title":"email(_:verified:verify:connection:clientId:)"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/email(_:verified:verify:connection:clientId:)"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"type":"topic","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Users","kind":"identifier"}],"title":"Users","navigatorTitle":[{"text":"Users","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","url":"\/documentation\/auth0\/users","kind":"symbol","abstract":[{"type":"text","text":"Client for the Users endpoints of the Auth0 "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"type":"text","text":"."}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/email(_:verified:verify:connection:clientId:)":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"email"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"verified"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"verify"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"text":"?, ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"clientId","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"UserPatchAttributes","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}],"kind":"symbol","url":"\/documentation\/auth0\/userpatchattributes\/email(_:verified:verify:connection:clientid:)","role":"symbol","deprecated":true,"title":"email(_:verified:verify:connection:clientId:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/email(_:verified:verify:connection:clientId:)","abstract":[{"type":"text","text":"Change the email of the user."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"required":true,"kind":"symbol","url":"\/documentation\/auth0\/users\/patch(_:attributes:)","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"patch"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"attributes"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","kind":"typeIdentifier","text":"UserPatchAttributes"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError"},{"kind":"text","text":">"}],"deprecated":true,"title":"patch(_:attributes:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","abstract":[{"type":"text","text":"Updates a user’s root values (those which are allowed to be updated)."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes":{"url":"\/documentation\/auth0\/userpatchattributes","kind":"symbol","role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserPatchAttributes","kind":"identifier"}],"navigatorTitle":[{"text":"UserPatchAttributes","kind":"identifier"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","title":"UserPatchAttributes","abstract":[{"type":"text","text":"User attributes that can be updated using the "},{"type":"reference","isActive":true,"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"},{"type":"text","text":"."}]}}} \ No newline at end of file +{"abstract":[{"type":"text","text":"Change the email of the user."}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"email"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"email"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"verified"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":"? = nil, "},{"kind":"externalParam","text":"verify"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":"? = nil, "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"clientId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","text":"UserPatchAttributes"}]}],"kind":"declarations"},{"parameters":[{"content":[{"inlineContent":[{"type":"text","text":"New email for the user."}],"type":"paragraph"}],"name":"email"},{"content":[{"inlineContent":[{"type":"text","text":"If the email is verified."}],"type":"paragraph"}],"name":"verified"},{"content":[{"inlineContent":[{"type":"text","text":"If the user should verify the email."}],"type":"paragraph"}],"name":"verify"},{"content":[{"inlineContent":[{"type":"text","text":"Name of the connection."}],"type":"paragraph"}],"name":"connection"},{"content":[{"inlineContent":[{"type":"text","text":"Auth0 Client ID."}],"type":"paragraph"}],"name":"clientId"}],"kind":"parameters"},{"content":[{"anchor":"return-value","type":"heading","level":2,"text":"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":[{"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\/email(_:verified:verify:connection:clientid:)"]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"]]},"metadata":{"modules":[{"name":"Auth0"}],"title":"email(_:verified:verify:connection:clientId:)","roleHeading":"Instance Method","symbolKind":"method","platforms":[{"unavailable":false,"beta":false,"message":"This attribute can no longer be updated from native apps for security reasons","deprecated":true}],"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"email"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"verified"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"verify"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"clientId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes"}],"externalID":"s:5Auth019UserPatchAttributesC5email_8verified6verify10connection8clientIdACSS_SbSgAIS2StF"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/email(_:verified:verify:connection:clientId:)","interfaceLanguage":"swift"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"role":"symbol","title":"patch(_:attributes:)","deprecated":true,"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"patch","kind":"identifier"},{"text":"(","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"attributes","kind":"externalParam"},{"kind":"text","text":": "},{"text":"UserPatchAttributes","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError","kind":"typeIdentifier"},{"kind":"text","text":">"}],"abstract":[{"type":"text","text":"Updates a user’s root values (those which are allowed to be updated)."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","url":"\/documentation\/auth0\/users\/patch(_:attributes:)","required":true,"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/email(_:verified:verify:connection:clientId:)":{"kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"email"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"verified"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"verify"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"clientId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes"}],"deprecated":true,"title":"email(_:verified:verify:connection:clientId:)","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Change the email of the user."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/email(_:verified:verify:connection:clientId:)","url":"\/documentation\/auth0\/userpatchattributes\/email(_:verified:verify:connection:clientid:)"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes":{"title":"UserPatchAttributes","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"UserPatchAttributes"}],"abstract":[{"text":"User attributes that can be updated using the ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","isActive":true,"type":"reference"},{"text":" method of ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","isActive":true,"type":"reference"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/userpatchattributes","navigatorTitle":[{"kind":"identifier","text":"UserPatchAttributes"}]},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"url":"\/documentation\/auth0\/users","title":"Users","abstract":[{"type":"text","text":"Client for the Users endpoints of the Auth0 "},{"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","type":"reference","isActive":true},{"text":".","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"Users"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Users"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","role":"symbol","kind":"symbol","type":"topic"}}} \ 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 942c2854f..e6a0c8010 100644 --- a/docs/data/documentation/auth0/userpatchattributes/emailverified(_:connection:).json +++ b/docs/data/documentation/auth0/userpatchattributes/emailverified(_:connection:).json @@ -1 +1 @@ -{"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/emailVerified(_:connection:)","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"emailVerified"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"verified"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":") -> "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC","kind":"typeIdentifier","text":"UserPatchAttributes"}],"platforms":["iOS"],"languages":["swift"]}]},{"parameters":[{"name":"verified","content":[{"type":"paragraph","inlineContent":[{"text":"If the email is verified.","type":"text"}]}]},{"name":"connection","content":[{"inlineContent":[{"type":"text","text":"Name of the connection."}],"type":"paragraph"}]}],"kind":"parameters"},{"content":[{"level":2,"text":"Return Value","type":"heading","anchor":"return-value"},{"inlineContent":[{"type":"text","text":"The same "},{"code":"UserPatchAttributes","type":"codeVoice"},{"type":"text","text":" instance to allow method chaining."}],"type":"paragraph"}],"kind":"content"}],"schemaVersion":{"minor":3,"major":0,"patch":0},"deprecationSummary":[{"inlineContent":[{"text":"This attribute can no longer be updated from native apps for security reasons","type":"text"}],"type":"paragraph"}],"metadata":{"externalID":"s:5Auth019UserPatchAttributesC13emailVerified_10connectionACSb_SStF","symbolKind":"method","platforms":[{"message":"This attribute can no longer be updated from native apps for security reasons","deprecated":true,"unavailable":false,"beta":false}],"modules":[{"name":"Auth0"}],"roleHeading":"Instance Method","title":"emailVerified(_:connection:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"emailVerified","kind":"identifier"},{"text":"(","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC","kind":"typeIdentifier"}],"role":"symbol"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"]]},"abstract":[{"text":"Set the verified status of the email.","type":"text"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userpatchattributes\/emailverified(_:connection:)"]}],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"required":true,"kind":"symbol","url":"\/documentation\/auth0\/users\/patch(_:attributes:)","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"patch"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"attributes"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","kind":"typeIdentifier","text":"UserPatchAttributes"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError"},{"kind":"text","text":">"}],"deprecated":true,"title":"patch(_:attributes:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","abstract":[{"type":"text","text":"Updates a user’s root values (those which are allowed to be updated)."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/emailVerified(_:connection:)":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"emailVerified","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes","kind":"typeIdentifier"}],"kind":"symbol","url":"\/documentation\/auth0\/userpatchattributes\/emailverified(_:connection:)","role":"symbol","deprecated":true,"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/emailVerified(_:connection:)","title":"emailVerified(_:connection:)","abstract":[{"type":"text","text":"Set the verified status of the email."}]},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes":{"url":"\/documentation\/auth0\/userpatchattributes","kind":"symbol","role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserPatchAttributes","kind":"identifier"}],"navigatorTitle":[{"text":"UserPatchAttributes","kind":"identifier"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","title":"UserPatchAttributes","abstract":[{"type":"text","text":"User attributes that can be updated using the "},{"type":"reference","isActive":true,"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"},{"type":"text","text":"."}]},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"type":"topic","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Users","kind":"identifier"}],"title":"Users","navigatorTitle":[{"text":"Users","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","url":"\/documentation\/auth0\/users","kind":"symbol","abstract":[{"type":"text","text":"Client for the Users endpoints of the Auth0 "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"type":"text","text":"."}],"role":"symbol"}}} \ No newline at end of file +{"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/emailVerified(_:connection:)"},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"emailVerified","kind":"identifier"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"verified","kind":"internalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"},{"parameters":[{"name":"verified","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"If the email is verified."}]}]},{"name":"connection","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Name of the connection."}]}]}],"kind":"parameters"},{"content":[{"anchor":"return-value","text":"Return Value","type":"heading","level":2},{"inlineContent":[{"type":"text","text":"The same "},{"type":"codeVoice","code":"UserPatchAttributes"},{"type":"text","text":" instance to allow method chaining."}],"type":"paragraph"}],"kind":"content"}],"deprecationSummary":[{"inlineContent":[{"text":"This attribute can no longer be updated from native apps for security reasons","type":"text"}],"type":"paragraph"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userpatchattributes\/emailverified(_:connection:)"]}],"kind":"symbol","metadata":{"modules":[{"name":"Auth0"}],"title":"emailVerified(_:connection:)","platforms":[{"unavailable":false,"beta":false,"message":"This attribute can no longer be updated from native apps for security reasons","deprecated":true}],"externalID":"s:5Auth019UserPatchAttributesC13emailVerified_10connectionACSb_SStF","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"emailVerified"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}],"roleHeading":"Instance Method","symbolKind":"method"},"schemaVersion":{"minor":3,"patch":0,"major":0},"abstract":[{"text":"Set the verified status of the email.","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Users":{"url":"\/documentation\/auth0\/users","title":"Users","abstract":[{"type":"text","text":"Client for the Users endpoints of the Auth0 "},{"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","type":"reference","isActive":true},{"text":".","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"Users"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Users"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"role":"symbol","title":"patch(_:attributes:)","deprecated":true,"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"patch","kind":"identifier"},{"text":"(","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"attributes","kind":"externalParam"},{"kind":"text","text":": "},{"text":"UserPatchAttributes","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError","kind":"typeIdentifier"},{"kind":"text","text":">"}],"abstract":[{"type":"text","text":"Updates a user’s root values (those which are allowed to be updated)."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","url":"\/documentation\/auth0\/users\/patch(_:attributes:)","required":true,"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/emailVerified(_:connection:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/emailVerified(_:connection:)","title":"emailVerified(_:connection:)","type":"topic","role":"symbol","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"emailVerified","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes"}],"abstract":[{"text":"Set the verified status of the email.","type":"text"}],"url":"\/documentation\/auth0\/userpatchattributes\/emailverified(_:connection:)","deprecated":true},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes":{"title":"UserPatchAttributes","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"UserPatchAttributes"}],"abstract":[{"text":"User attributes that can be updated using the ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","isActive":true,"type":"reference"},{"text":" method of ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","isActive":true,"type":"reference"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/userpatchattributes","navigatorTitle":[{"kind":"identifier","text":"UserPatchAttributes"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ 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 28f1b76d9..77b92b99c 100644 --- a/docs/data/documentation/auth0/userpatchattributes/init(dictionary:).json +++ b/docs/data/documentation/auth0/userpatchattributes/init(dictionary:).json @@ -1 +1 @@ -{"abstract":[{"text":"Creates a new ","type":"text"},{"type":"codeVoice","code":"UserPatchAttributes"},{"text":" instance.","type":"text"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userpatchattributes\/init(dictionary:)"]}],"primaryContentSections":[{"declarations":[{"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"},{"text":"] = [:])","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"type":"text","text":"Default attribute values."}],"type":"paragraph"}],"name":"dictionary"}]}],"kind":"symbol","metadata":{"fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"dictionary"},{"kind":"text","text":": ["},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"])","kind":"text"}],"roleHeading":"Initializer","modules":[{"name":"Auth0"}],"symbolKind":"init","role":"symbol","title":"init(dictionary:)","externalID":"s:5Auth019UserPatchAttributesC10dictionaryACSDySSypG_tcfc"},"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/init(dictionary:)"},"schemaVersion":{"minor":3,"patch":0,"major":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"type":"topic","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Users","kind":"identifier"}],"title":"Users","navigatorTitle":[{"text":"Users","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","url":"\/documentation\/auth0\/users","kind":"symbol","abstract":[{"type":"text","text":"Client for the Users endpoints of the Auth0 "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"type":"text","text":"."}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"required":true,"kind":"symbol","url":"\/documentation\/auth0\/users\/patch(_:attributes:)","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"patch"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"attributes"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","kind":"typeIdentifier","text":"UserPatchAttributes"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError"},{"kind":"text","text":">"}],"deprecated":true,"title":"patch(_:attributes:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","abstract":[{"type":"text","text":"Updates a user’s root values (those which are allowed to be updated)."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes":{"url":"\/documentation\/auth0\/userpatchattributes","kind":"symbol","role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserPatchAttributes","kind":"identifier"}],"navigatorTitle":[{"text":"UserPatchAttributes","kind":"identifier"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","title":"UserPatchAttributes","abstract":[{"type":"text","text":"User attributes that can be updated using the "},{"type":"reference","isActive":true,"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"},{"type":"text","text":"."}]},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/init(dictionary:)":{"fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"dictionary","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"])","kind":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/userpatchattributes\/init(dictionary:)","role":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/init(dictionary:)","title":"init(dictionary:)","abstract":[{"type":"text","text":"Creates a new "},{"code":"UserPatchAttributes","type":"codeVoice"},{"type":"text","text":" instance."}]}}} \ No newline at end of file +{"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/init(dictionary:)","interfaceLanguage":"swift"},"kind":"symbol","metadata":{"externalID":"s:5Auth019UserPatchAttributesC10dictionaryACSDySSypG_tcfc","modules":[{"name":"Auth0"}],"title":"init(dictionary:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"dictionary"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"])"}],"roleHeading":"Initializer","role":"symbol","symbolKind":"init"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userpatchattributes\/init(dictionary:)"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"]]},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"dictionary"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"] = [:])"}]}],"kind":"declarations"},{"parameters":[{"content":[{"inlineContent":[{"text":"Default attribute values.","type":"text"}],"type":"paragraph"}],"name":"dictionary"}],"kind":"parameters"}],"abstract":[{"type":"text","text":"Creates a new "},{"type":"codeVoice","code":"UserPatchAttributes"},{"type":"text","text":" instance."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"role":"symbol","title":"patch(_:attributes:)","deprecated":true,"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"patch","kind":"identifier"},{"text":"(","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"attributes","kind":"externalParam"},{"kind":"text","text":": "},{"text":"UserPatchAttributes","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError","kind":"typeIdentifier"},{"kind":"text","text":">"}],"abstract":[{"type":"text","text":"Updates a user’s root values (those which are allowed to be updated)."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","url":"\/documentation\/auth0\/users\/patch(_:attributes:)","required":true,"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes":{"title":"UserPatchAttributes","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"UserPatchAttributes"}],"abstract":[{"text":"User attributes that can be updated using the ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","isActive":true,"type":"reference"},{"text":" method of ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","isActive":true,"type":"reference"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/userpatchattributes","navigatorTitle":[{"kind":"identifier","text":"UserPatchAttributes"}]},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"url":"\/documentation\/auth0\/users","title":"Users","abstract":[{"type":"text","text":"Client for the Users endpoints of the Auth0 "},{"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","type":"reference","isActive":true},{"text":".","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"Users"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Users"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/init(dictionary:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/init(dictionary:)","kind":"symbol","title":"init(dictionary:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"dictionary"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"])"}],"role":"symbol","url":"\/documentation\/auth0\/userpatchattributes\/init(dictionary:)","abstract":[{"type":"text","text":"Creates a new "},{"type":"codeVoice","code":"UserPatchAttributes"},{"type":"text","text":" instance."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"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 243d9712a..819909a31 100644 --- a/docs/data/documentation/auth0/userpatchattributes/password(_:verify:connection:).json +++ b/docs/data/documentation/auth0/userpatchattributes/password(_:verify:connection:).json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/password(_:verify:connection:)","interfaceLanguage":"swift"},"deprecationSummary":[{"inlineContent":[{"text":"This attribute can no longer be updated from native apps for security reasons","type":"text"}],"type":"paragraph"}],"kind":"symbol","metadata":{"externalID":"s:5Auth019UserPatchAttributesC8password_6verify10connectionACSS_SbSgSStF","title":"password(_:verify:connection:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"password","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"verify","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes","kind":"typeIdentifier"}],"roleHeading":"Instance Method","platforms":[{"beta":false,"deprecated":true,"message":"This attribute can no longer be updated from native apps for security reasons","unavailable":false}],"modules":[{"name":"Auth0"}],"symbolKind":"method"},"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"password"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"password"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"verify"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":"? = nil, "},{"kind":"externalParam","text":"connection"},{"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"],"languages":["swift"]}]},{"kind":"parameters","parameters":[{"name":"password","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"New password for the user."}]}]},{"name":"verify","content":[{"inlineContent":[{"text":"If the password should be verified by the user.","type":"text"}],"type":"paragraph"}]},{"name":"connection","content":[{"inlineContent":[{"type":"text","text":"Name of the connection."}],"type":"paragraph"}]}]},{"kind":"content","content":[{"type":"heading","anchor":"return-value","level":2,"text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The same "},{"type":"codeVoice","code":"UserPatchAttributes"},{"type":"text","text":" instance to allow method chaining."}]}]}],"variants":[{"paths":["\/documentation\/auth0\/userpatchattributes\/password(_:verify:connection:)"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"text":"Change the user’s password.","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes":{"url":"\/documentation\/auth0\/userpatchattributes","kind":"symbol","role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserPatchAttributes","kind":"identifier"}],"navigatorTitle":[{"text":"UserPatchAttributes","kind":"identifier"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","title":"UserPatchAttributes","abstract":[{"type":"text","text":"User attributes that can be updated using the "},{"type":"reference","isActive":true,"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"},{"type":"text","text":"."}]},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"type":"topic","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Users","kind":"identifier"}],"title":"Users","navigatorTitle":[{"text":"Users","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","url":"\/documentation\/auth0\/users","kind":"symbol","abstract":[{"type":"text","text":"Client for the Users endpoints of the Auth0 "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"type":"text","text":"."}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/password(_:verify:connection:)":{"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"password","kind":"identifier"},{"text":"(","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"verify","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"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"}],"url":"\/documentation\/auth0\/userpatchattributes\/password(_:verify:connection:)","type":"topic","kind":"symbol","deprecated":true,"abstract":[{"type":"text","text":"Change the user’s password."}],"title":"password(_:verify:connection:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/password(_:verify:connection:)"},"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"required":true,"kind":"symbol","url":"\/documentation\/auth0\/users\/patch(_:attributes:)","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"patch"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"attributes"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","kind":"typeIdentifier","text":"UserPatchAttributes"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError"},{"kind":"text","text":">"}],"deprecated":true,"title":"patch(_:attributes:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","abstract":[{"type":"text","text":"Updates a user’s root values (those which are allowed to be updated)."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"abstract":[{"type":"text","text":"Change the user’s password."}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"password","kind":"identifier"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"password","kind":"internalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"verify","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"text":"? = nil, ","kind":"text"},{"kind":"externalParam","text":"connection"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes","kind":"typeIdentifier"}],"platforms":["iOS"]}],"kind":"declarations"},{"parameters":[{"content":[{"type":"paragraph","inlineContent":[{"text":"New password for the user.","type":"text"}]}],"name":"password"},{"content":[{"type":"paragraph","inlineContent":[{"text":"If the password should be verified by the user.","type":"text"}]}],"name":"verify"},{"content":[{"type":"paragraph","inlineContent":[{"text":"Name of the connection.","type":"text"}]}],"name":"connection"}],"kind":"parameters"},{"content":[{"text":"Return Value","level":2,"anchor":"return-value","type":"heading"},{"inlineContent":[{"type":"text","text":"The same "},{"type":"codeVoice","code":"UserPatchAttributes"},{"type":"text","text":" instance to allow method chaining."}],"type":"paragraph"}],"kind":"content"}],"deprecationSummary":[{"inlineContent":[{"text":"This attribute can no longer be updated from native apps for security reasons","type":"text"}],"type":"paragraph"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userpatchattributes\/password(_:verify:connection:)"]}],"schemaVersion":{"patch":0,"minor":3,"major":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"]]},"metadata":{"modules":[{"name":"Auth0"}],"title":"password(_:verify:connection:)","roleHeading":"Instance Method","symbolKind":"method","role":"symbol","platforms":[{"message":"This attribute can no longer be updated from native apps for security reasons","unavailable":false,"beta":false,"deprecated":true}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"password","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"verify","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"text":"?, ","kind":"text"},{"kind":"externalParam","text":"connection"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes","kind":"typeIdentifier"}],"externalID":"s:5Auth019UserPatchAttributesC8password_6verify10connectionACSS_SbSgSStF"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/password(_:verify:connection:)","interfaceLanguage":"swift"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/password(_:verify:connection:)":{"kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"password","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"verify","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes","kind":"typeIdentifier"}],"deprecated":true,"title":"password(_:verify:connection:)","type":"topic","role":"symbol","abstract":[{"text":"Change the user’s password.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/password(_:verify:connection:)","url":"\/documentation\/auth0\/userpatchattributes\/password(_:verify:connection:)"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes":{"title":"UserPatchAttributes","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"UserPatchAttributes"}],"abstract":[{"text":"User attributes that can be updated using the ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","isActive":true,"type":"reference"},{"text":" method of ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","isActive":true,"type":"reference"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/userpatchattributes","navigatorTitle":[{"kind":"identifier","text":"UserPatchAttributes"}]},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"url":"\/documentation\/auth0\/users","title":"Users","abstract":[{"type":"text","text":"Client for the Users endpoints of the Auth0 "},{"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","type":"reference","isActive":true},{"text":".","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"Users"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Users"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"role":"symbol","title":"patch(_:attributes:)","deprecated":true,"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"patch","kind":"identifier"},{"text":"(","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"attributes","kind":"externalParam"},{"kind":"text","text":": "},{"text":"UserPatchAttributes","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError","kind":"typeIdentifier"},{"kind":"text","text":">"}],"abstract":[{"type":"text","text":"Updates a user’s root values (those which are allowed to be updated)."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","url":"\/documentation\/auth0\/users\/patch(_:attributes:)","required":true,"type":"topic"}}} \ 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 19dbe4de6..7ef12862b 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 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/phoneNumber(_:verified:verify:connection:clientId:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Change the phone number of the user (SMS connection only)."}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"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"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"verified","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"text":"? = nil, ","kind":"text"},{"text":"verify","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"text":"? = nil, ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"clientId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","text":"UserPatchAttributes"}],"languages":["swift"]}],"kind":"declarations"},{"parameters":[{"name":"phoneNumber","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"New phone number for the user."}]}]},{"name":"verified","content":[{"type":"paragraph","inlineContent":[{"text":"If the phone number is verified.","type":"text"}]}]},{"name":"verify","content":[{"inlineContent":[{"text":"If the user should verify the phone number.","type":"text"}],"type":"paragraph"}]},{"name":"connection","content":[{"inlineContent":[{"type":"text","text":"Name of the connection."}],"type":"paragraph"}]},{"name":"clientId","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Auth0 Client ID."}]}]}],"kind":"parameters"},{"kind":"content","content":[{"type":"heading","anchor":"return-value","text":"Return Value","level":2},{"type":"paragraph","inlineContent":[{"text":"The same ","type":"text"},{"code":"UserPatchAttributes","type":"codeVoice"},{"text":" instance to allow method chaining.","type":"text"}]}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"metadata":{"externalID":"s:5Auth019UserPatchAttributesC11phoneNumber_8verified6verify10connection8clientIdACSS_SbSgAIS2StF","role":"symbol","modules":[{"name":"Auth0"}],"roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"phoneNumber"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"verified"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"verify"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"clientId"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","kind":"typeIdentifier","text":"UserPatchAttributes"}],"platforms":[{"unavailable":false,"beta":false,"message":"This attribute can no longer be updated from native apps for security reasons","deprecated":true}],"title":"phoneNumber(_:verified:verify:connection:clientId:)","symbolKind":"method"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userpatchattributes\/phonenumber(_:verified:verify:connection:clientid:)"]}],"deprecationSummary":[{"type":"paragraph","inlineContent":[{"text":"This attribute can no longer be updated from native apps for security reasons","type":"text"}]}],"kind":"symbol","sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/phoneNumber(_:verified:verify:connection:clientId:)":{"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"phoneNumber","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"verified","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"verify","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"clientId","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes","kind":"typeIdentifier"}],"type":"topic","deprecated":true,"title":"phoneNumber(_:verified:verify:connection:clientId:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/phoneNumber(_:verified:verify:connection:clientId:)","url":"\/documentation\/auth0\/userpatchattributes\/phonenumber(_:verified:verify:connection:clientid:)","abstract":[{"text":"Change the phone number of the user (SMS connection only).","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"type":"topic","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Users","kind":"identifier"}],"title":"Users","navigatorTitle":[{"text":"Users","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","url":"\/documentation\/auth0\/users","kind":"symbol","abstract":[{"type":"text","text":"Client for the Users endpoints of the Auth0 "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"type":"text","text":"."}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"required":true,"kind":"symbol","url":"\/documentation\/auth0\/users\/patch(_:attributes:)","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"patch"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"attributes"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","kind":"typeIdentifier","text":"UserPatchAttributes"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError"},{"kind":"text","text":">"}],"deprecated":true,"title":"patch(_:attributes:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","abstract":[{"type":"text","text":"Updates a user’s root values (those which are allowed to be updated)."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes":{"url":"\/documentation\/auth0\/userpatchattributes","kind":"symbol","role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserPatchAttributes","kind":"identifier"}],"navigatorTitle":[{"text":"UserPatchAttributes","kind":"identifier"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","title":"UserPatchAttributes","abstract":[{"type":"text","text":"User attributes that can be updated using the "},{"type":"reference","isActive":true,"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"},{"type":"text","text":"."}]}}} \ No newline at end of file +{"metadata":{"platforms":[{"deprecated":true,"unavailable":false,"message":"This attribute can no longer be updated from native apps for security reasons","beta":false}],"symbolKind":"method","roleHeading":"Instance Method","externalID":"s:5Auth019UserPatchAttributesC11phoneNumber_8verified6verify10connection8clientIdACSS_SbSgAIS2StF","title":"phoneNumber(_:verified:verify:connection:clientId:)","modules":[{"name":"Auth0"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"phoneNumber","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"verified","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"verify","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"clientId","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes","kind":"typeIdentifier"}],"role":"symbol"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userpatchattributes\/phonenumber(_:verified:verify:connection:clientid:)"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/phoneNumber(_:verified:verify:connection:clientId:)"},"kind":"symbol","abstract":[{"type":"text","text":"Change the phone number of the user (SMS connection only)."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"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"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"verified","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"text":"? = nil, ","kind":"text"},{"text":"verify","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"text":"? = nil, ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"clientId","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"}],"languages":["swift"],"platforms":["iOS"]}]},{"parameters":[{"name":"phoneNumber","content":[{"inlineContent":[{"text":"New phone number for the user.","type":"text"}],"type":"paragraph"}]},{"name":"verified","content":[{"inlineContent":[{"text":"If the phone number is verified.","type":"text"}],"type":"paragraph"}]},{"name":"verify","content":[{"inlineContent":[{"text":"If the user should verify the phone number.","type":"text"}],"type":"paragraph"}]},{"name":"connection","content":[{"inlineContent":[{"text":"Name of the connection.","type":"text"}],"type":"paragraph"}]},{"name":"clientId","content":[{"inlineContent":[{"text":"Auth0 Client ID.","type":"text"}],"type":"paragraph"}]}],"kind":"parameters"},{"kind":"content","content":[{"type":"heading","text":"Return Value","anchor":"return-value","level":2},{"type":"paragraph","inlineContent":[{"text":"The same ","type":"text"},{"code":"UserPatchAttributes","type":"codeVoice"},{"text":" instance to allow method chaining.","type":"text"}]}]}],"deprecationSummary":[{"type":"paragraph","inlineContent":[{"type":"text","text":"This attribute can no longer be updated from native apps for security reasons"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes":{"title":"UserPatchAttributes","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"UserPatchAttributes"}],"abstract":[{"text":"User attributes that can be updated using the ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","isActive":true,"type":"reference"},{"text":" method of ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","isActive":true,"type":"reference"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/userpatchattributes","navigatorTitle":[{"kind":"identifier","text":"UserPatchAttributes"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/phoneNumber(_:verified:verify:connection:clientId:)":{"type":"topic","title":"phoneNumber(_:verified:verify:connection:clientId:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/phoneNumber(_:verified:verify:connection:clientId:)","kind":"symbol","abstract":[{"type":"text","text":"Change the phone number of the user (SMS connection only)."}],"url":"\/documentation\/auth0\/userpatchattributes\/phonenumber(_:verified:verify:connection:clientid:)","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"phoneNumber"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"verified"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"verify"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"clientId"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","kind":"typeIdentifier","text":"UserPatchAttributes"}],"deprecated":true},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"url":"\/documentation\/auth0\/users","title":"Users","abstract":[{"type":"text","text":"Client for the Users endpoints of the Auth0 "},{"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","type":"reference","isActive":true},{"text":".","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"Users"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Users"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"role":"symbol","title":"patch(_:attributes:)","deprecated":true,"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"patch","kind":"identifier"},{"text":"(","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"attributes","kind":"externalParam"},{"kind":"text","text":": "},{"text":"UserPatchAttributes","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError","kind":"typeIdentifier"},{"kind":"text","text":">"}],"abstract":[{"type":"text","text":"Updates a user’s root values (those which are allowed to be updated)."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","url":"\/documentation\/auth0\/users\/patch(_:attributes:)","required":true,"type":"topic"}}} \ 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 dbddbd3fe..c46b13534 100644 --- a/docs/data/documentation/auth0/userpatchattributes/phoneverified(_:connection:).json +++ b/docs/data/documentation/auth0/userpatchattributes/phoneverified(_:connection:).json @@ -1 +1 @@ -{"sections":[],"metadata":{"modules":[{"name":"Auth0"}],"platforms":[{"beta":false,"message":"This attribute can no longer be updated from native apps for security reasons","unavailable":false,"deprecated":true}],"role":"symbol","title":"phoneVerified(_:connection:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"phoneVerified"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}],"symbolKind":"method","roleHeading":"Instance Method","externalID":"s:5Auth019UserPatchAttributesC13phoneVerified_10connectionACSb_SStF"},"variants":[{"paths":["\/documentation\/auth0\/userpatchattributes\/phoneverified(_:connection:)"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"text":"Set the verified status of the phone number.","type":"text"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/phoneVerified(_:connection:)"},"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"phoneVerified"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"verified"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"UserPatchAttributes","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}],"platforms":["iOS"]}],"kind":"declarations"},{"parameters":[{"content":[{"inlineContent":[{"text":"If the phone number is verified or not.","type":"text"}],"type":"paragraph"}],"name":"verified"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Name of the connection."}]}],"name":"connection"}],"kind":"parameters"},{"content":[{"anchor":"return-value","type":"heading","level":2,"text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The same "},{"code":"UserPatchAttributes","type":"codeVoice"},{"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","schemaVersion":{"major":0,"patch":0,"minor":3},"deprecationSummary":[{"inlineContent":[{"text":"This attribute can no longer be updated from native apps for security reasons","type":"text"}],"type":"paragraph"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"required":true,"kind":"symbol","url":"\/documentation\/auth0\/users\/patch(_:attributes:)","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"patch"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"attributes"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","kind":"typeIdentifier","text":"UserPatchAttributes"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError"},{"kind":"text","text":">"}],"deprecated":true,"title":"patch(_:attributes:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","abstract":[{"type":"text","text":"Updates a user’s root values (those which are allowed to be updated)."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/phoneVerified(_:connection:)":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"phoneVerified","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes","kind":"typeIdentifier"}],"kind":"symbol","url":"\/documentation\/auth0\/userpatchattributes\/phoneverified(_:connection:)","role":"symbol","deprecated":true,"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/phoneVerified(_:connection:)","title":"phoneVerified(_:connection:)","abstract":[{"type":"text","text":"Set the verified status of the phone number."}]},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"type":"topic","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Users","kind":"identifier"}],"title":"Users","navigatorTitle":[{"text":"Users","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","url":"\/documentation\/auth0\/users","kind":"symbol","abstract":[{"type":"text","text":"Client for the Users endpoints of the Auth0 "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"type":"text","text":"."}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes":{"url":"\/documentation\/auth0\/userpatchattributes","kind":"symbol","role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserPatchAttributes","kind":"identifier"}],"navigatorTitle":[{"text":"UserPatchAttributes","kind":"identifier"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","title":"UserPatchAttributes","abstract":[{"type":"text","text":"User attributes that can be updated using the "},{"type":"reference","isActive":true,"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"},{"type":"text","text":"."}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"]]},"metadata":{"platforms":[{"deprecated":true,"beta":false,"message":"This attribute can no longer be updated from native apps for security reasons","unavailable":false}],"symbolKind":"method","modules":[{"name":"Auth0"}],"title":"phoneVerified(_:connection:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"phoneVerified","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes","kind":"typeIdentifier"}],"externalID":"s:5Auth019UserPatchAttributesC13phoneVerified_10connectionACSb_SStF","role":"symbol","roleHeading":"Instance Method"},"sections":[],"abstract":[{"type":"text","text":"Set the verified status of the phone number."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userpatchattributes\/phoneverified(_:connection:)"]}],"deprecationSummary":[{"inlineContent":[{"type":"text","text":"This attribute can no longer be updated from native apps for security reasons"}],"type":"paragraph"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/phoneVerified(_:connection:)","interfaceLanguage":"swift"},"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"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":" "},{"kind":"internalParam","text":"verified"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"UserPatchAttributes","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}]}],"kind":"declarations"},{"parameters":[{"name":"verified","content":[{"inlineContent":[{"type":"text","text":"If the phone number is verified or not."}],"type":"paragraph"}]},{"name":"connection","content":[{"inlineContent":[{"type":"text","text":"Name of the connection."}],"type":"paragraph"}]}],"kind":"parameters"},{"content":[{"type":"heading","level":2,"anchor":"return-value","text":"Return Value"},{"type":"paragraph","inlineContent":[{"text":"The same ","type":"text"},{"code":"UserPatchAttributes","type":"codeVoice"},{"text":" instance to allow method chaining.","type":"text"}]}],"kind":"content"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Users":{"url":"\/documentation\/auth0\/users","title":"Users","abstract":[{"type":"text","text":"Client for the Users endpoints of the Auth0 "},{"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","type":"reference","isActive":true},{"text":".","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"Users"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Users"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"role":"symbol","title":"patch(_:attributes:)","deprecated":true,"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"patch","kind":"identifier"},{"text":"(","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"attributes","kind":"externalParam"},{"kind":"text","text":": "},{"text":"UserPatchAttributes","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError","kind":"typeIdentifier"},{"kind":"text","text":">"}],"abstract":[{"type":"text","text":"Updates a user’s root values (those which are allowed to be updated)."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","url":"\/documentation\/auth0\/users\/patch(_:attributes:)","required":true,"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/phoneVerified(_:connection:)":{"url":"\/documentation\/auth0\/userpatchattributes\/phoneverified(_:connection:)","abstract":[{"type":"text","text":"Set the verified status of the phone number."}],"title":"phoneVerified(_:connection:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"phoneVerified","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/phoneVerified(_:connection:)","role":"symbol","kind":"symbol","deprecated":true,"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes":{"title":"UserPatchAttributes","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"UserPatchAttributes"}],"abstract":[{"text":"User attributes that can be updated using the ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","isActive":true,"type":"reference"},{"text":" method of ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","isActive":true,"type":"reference"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/userpatchattributes","navigatorTitle":[{"kind":"identifier","text":"UserPatchAttributes"}]}}} \ 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 0117899d8..b15cb7da9 100644 --- a/docs/data/documentation/auth0/userpatchattributes/usermetadata(_:).json +++ b/docs/data/documentation/auth0/userpatchattributes/usermetadata(_:).json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"userMetadata"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"metadata"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"text":"]) -> ","kind":"text"},{"text":"UserPatchAttributes","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}]}]},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"text":"New user metadata values.","type":"text"}]}],"name":"metadata"}]},{"kind":"content","content":[{"text":"Return Value","type":"heading","anchor":"return-value","level":2},{"type":"paragraph","inlineContent":[{"type":"text","text":"The same "},{"code":"UserPatchAttributes","type":"codeVoice"},{"type":"text","text":" instance to allow method chaining."}]}]}],"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userpatchattributes\/usermetadata(_:)"]}],"abstract":[{"text":"Update user metadata.","type":"text"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/userMetadata(_:)"},"metadata":{"modules":[{"name":"Auth0"}],"symbolKind":"method","roleHeading":"Instance Method","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"userMetadata"},{"kind":"text","text":"(["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]) -> "},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","kind":"typeIdentifier","text":"UserPatchAttributes"}],"externalID":"s:5Auth019UserPatchAttributesC12userMetadatayACSDySSypGF","title":"userMetadata(_:)"},"schemaVersion":{"patch":0,"minor":3,"major":0},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"required":true,"kind":"symbol","url":"\/documentation\/auth0\/users\/patch(_:attributes:)","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"patch"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"attributes"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","kind":"typeIdentifier","text":"UserPatchAttributes"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError"},{"kind":"text","text":">"}],"deprecated":true,"title":"patch(_:attributes:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","abstract":[{"type":"text","text":"Updates a user’s root values (those which are allowed to be updated)."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"type":"topic","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Users","kind":"identifier"}],"title":"Users","navigatorTitle":[{"text":"Users","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","url":"\/documentation\/auth0\/users","kind":"symbol","abstract":[{"type":"text","text":"Client for the Users endpoints of the Auth0 "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"type":"text","text":"."}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes":{"url":"\/documentation\/auth0\/userpatchattributes","kind":"symbol","role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserPatchAttributes","kind":"identifier"}],"navigatorTitle":[{"text":"UserPatchAttributes","kind":"identifier"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","title":"UserPatchAttributes","abstract":[{"type":"text","text":"User attributes that can be updated using the "},{"type":"reference","isActive":true,"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"},{"type":"text","text":"."}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/userMetadata(_:)":{"url":"\/documentation\/auth0\/userpatchattributes\/usermetadata(_:)","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/userMetadata(_:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"userMetadata","kind":"identifier"},{"text":"([","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"]) -> ","kind":"text"},{"text":"UserPatchAttributes","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}],"title":"userMetadata(_:)","abstract":[{"type":"text","text":"Update user metadata."}],"kind":"symbol"}}} \ No newline at end of file +{"sections":[],"metadata":{"modules":[{"name":"Auth0"}],"externalID":"s:5Auth019UserPatchAttributesC12userMetadatayACSDySSypGF","title":"userMetadata(_:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"userMetadata"},{"text":"([","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"text":"]) -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes"}],"roleHeading":"Instance Method","role":"symbol","symbolKind":"method"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/userMetadata(_:)","interfaceLanguage":"swift"},"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/userpatchattributes\/usermetadata(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"]]},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"userMetadata","kind":"identifier"},{"kind":"text","text":"("},{"text":"_","kind":"externalParam"},{"kind":"text","text":" "},{"text":"metadata","kind":"internalParam"},{"kind":"text","text":": ["},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"metadata","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"New user metadata values."}]}]}]},{"kind":"content","content":[{"type":"heading","level":2,"text":"Return Value","anchor":"return-value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The same "},{"type":"codeVoice","code":"UserPatchAttributes"},{"type":"text","text":" instance to allow method chaining."}]}]}],"abstract":[{"type":"text","text":"Update user metadata."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"role":"symbol","title":"patch(_:attributes:)","deprecated":true,"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"patch","kind":"identifier"},{"text":"(","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"attributes","kind":"externalParam"},{"kind":"text","text":": "},{"text":"UserPatchAttributes","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError","kind":"typeIdentifier"},{"kind":"text","text":">"}],"abstract":[{"type":"text","text":"Updates a user’s root values (those which are allowed to be updated)."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","url":"\/documentation\/auth0\/users\/patch(_:attributes:)","required":true,"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes":{"title":"UserPatchAttributes","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"UserPatchAttributes"}],"abstract":[{"text":"User attributes that can be updated using the ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","isActive":true,"type":"reference"},{"text":" method of ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","isActive":true,"type":"reference"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/userpatchattributes","navigatorTitle":[{"kind":"identifier","text":"UserPatchAttributes"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/userMetadata(_:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/userMetadata(_:)","kind":"symbol","title":"userMetadata(_:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"userMetadata","kind":"identifier"},{"text":"([","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"]) -> ","kind":"text"},{"text":"UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC","kind":"typeIdentifier"}],"role":"symbol","url":"\/documentation\/auth0\/userpatchattributes\/usermetadata(_:)","abstract":[{"type":"text","text":"Update user metadata."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"url":"\/documentation\/auth0\/users","title":"Users","abstract":[{"type":"text","text":"Client for the Users endpoints of the Auth0 "},{"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","type":"reference","isActive":true},{"text":".","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"Users"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Users"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ 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 c5efb6583..5d3a9a4a7 100644 --- a/docs/data/documentation/auth0/userpatchattributes/username(_:connection:).json +++ b/docs/data/documentation/auth0/userpatchattributes/username(_:connection:).json @@ -1 +1 @@ -{"sections":[],"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/username(_:connection:)","interfaceLanguage":"swift"},"schemaVersion":{"patch":0,"minor":3,"major":0},"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":[{"paths":["\/documentation\/auth0\/userpatchattributes\/username(_:connection:)"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"username"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"username"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes"}],"languages":["swift"]}],"kind":"declarations"},{"parameters":[{"name":"username","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"New username for the user."}]}]},{"name":"connection","content":[{"inlineContent":[{"type":"text","text":"Name of the connection."}],"type":"paragraph"}]}],"kind":"parameters"},{"content":[{"type":"heading","level":2,"text":"Return Value","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"}],"abstract":[{"type":"text","text":"Change the username."}],"metadata":{"role":"symbol","symbolKind":"method","roleHeading":"Instance Method","externalID":"s:5Auth019UserPatchAttributesC8username_10connectionACSS_SStF","modules":[{"name":"Auth0"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"username","kind":"identifier"},{"text":"(","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC","kind":"typeIdentifier"}],"platforms":[{"unavailable":false,"beta":false,"deprecated":true,"message":"This attribute can no longer be updated from native apps for security reasons"}],"title":"username(_:connection:)"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/username(_:connection:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/username(_:connection:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"username"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}],"url":"\/documentation\/auth0\/userpatchattributes\/username(_:connection:)","role":"symbol","deprecated":true,"kind":"symbol","type":"topic","title":"username(_:connection:)","abstract":[{"type":"text","text":"Change the username."}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"required":true,"kind":"symbol","url":"\/documentation\/auth0\/users\/patch(_:attributes:)","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"patch"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"attributes"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","kind":"typeIdentifier","text":"UserPatchAttributes"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError"},{"kind":"text","text":">"}],"deprecated":true,"title":"patch(_:attributes:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","abstract":[{"type":"text","text":"Updates a user’s root values (those which are allowed to be updated)."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"type":"topic","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Users","kind":"identifier"}],"title":"Users","navigatorTitle":[{"text":"Users","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","url":"\/documentation\/auth0\/users","kind":"symbol","abstract":[{"type":"text","text":"Client for the Users endpoints of the Auth0 "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"type":"text","text":"."}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes":{"url":"\/documentation\/auth0\/userpatchattributes","kind":"symbol","role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserPatchAttributes","kind":"identifier"}],"navigatorTitle":[{"text":"UserPatchAttributes","kind":"identifier"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","title":"UserPatchAttributes","abstract":[{"type":"text","text":"User attributes that can be updated using the "},{"type":"reference","isActive":true,"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"},{"type":"text","text":"."}]}}} \ No newline at end of file +{"metadata":{"platforms":[{"beta":false,"message":"This attribute can no longer be updated from native apps for security reasons","unavailable":false,"deprecated":true}],"symbolKind":"method","roleHeading":"Instance Method","externalID":"s:5Auth019UserPatchAttributesC8username_10connectionACSS_SStF","title":"username(_:connection:)","modules":[{"name":"Auth0"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"username","kind":"identifier"},{"text":"(","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"connection","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC","kind":"typeIdentifier"}],"role":"symbol"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/userpatchattributes\/username(_:connection:)"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/username(_:connection:)","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"text":"Change the username.","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"username"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"username"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","kind":"typeIdentifier","text":"UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC"}],"platforms":["iOS"]}]},{"parameters":[{"name":"username","content":[{"inlineContent":[{"type":"text","text":"New username for the user."}],"type":"paragraph"}]},{"name":"connection","content":[{"inlineContent":[{"type":"text","text":"Name of the connection."}],"type":"paragraph"}]}],"kind":"parameters"},{"kind":"content","content":[{"level":2,"text":"Return Value","type":"heading","anchor":"return-value"},{"inlineContent":[{"type":"text","text":"The same "},{"code":"UserPatchAttributes","type":"codeVoice"},{"type":"text","text":" instance to allow method chaining."}],"type":"paragraph"}]}],"deprecationSummary":[{"type":"paragraph","inlineContent":[{"text":"This attribute can no longer be updated from native apps for security reasons","type":"text"}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes":{"title":"UserPatchAttributes","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"UserPatchAttributes"}],"abstract":[{"text":"User attributes that can be updated using the ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","isActive":true,"type":"reference"},{"text":" method of ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","isActive":true,"type":"reference"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/userpatchattributes","navigatorTitle":[{"kind":"identifier","text":"UserPatchAttributes"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes/username(_:connection:)":{"type":"topic","title":"username(_:connection:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes\/username(_:connection:)","kind":"symbol","abstract":[{"text":"Change the username.","type":"text"}],"url":"\/documentation\/auth0\/userpatchattributes\/username(_:connection:)","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"username"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC","text":"UserPatchAttributes"}],"deprecated":true},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"url":"\/documentation\/auth0\/users","title":"Users","abstract":[{"type":"text","text":"Client for the Users endpoints of the Auth0 "},{"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","type":"reference","isActive":true},{"text":".","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"Users"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Users"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"role":"symbol","title":"patch(_:attributes:)","deprecated":true,"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"patch","kind":"identifier"},{"text":"(","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"attributes","kind":"externalParam"},{"kind":"text","text":": "},{"text":"UserPatchAttributes","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError","kind":"typeIdentifier"},{"kind":"text","text":">"}],"abstract":[{"type":"text","text":"Updates a user’s root values (those which are allowed to be updated)."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","url":"\/documentation\/auth0\/users\/patch(_:attributes:)","required":true,"type":"topic"}}} \ 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 83508b708..c49ab47dd 100644 --- a/docs/data/documentation/auth0/users(token:domain:session:).json +++ b/docs/data/documentation/auth0/users(token:domain:session:).json @@ -1 +1 @@ -{"abstract":[{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","isActive":true},{"type":"text","text":" client for performing operations with the Users endpoints."}],"schemaVersion":{"patch":0,"major":0,"minor":3},"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/users(token:domain:session:)"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/users(token:domain:session:)"},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"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","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"domain"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"session"},{"kind":"text","text":": "},{"preciseIdentifier":"c:objc(cs)NSURLSession","kind":"typeIdentifier","text":"URLSession"},{"kind":"text","text":" = .shared) -> "},{"preciseIdentifier":"s:5Auth05UsersP","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","text":"Users"}]}]},{"kind":"parameters","parameters":[{"name":"token","content":[{"inlineContent":[{"type":"text","text":"Access token for the Management API with the correct allowed scopes to perform the desired action."}],"type":"paragraph"}]},{"name":"domain","content":[{"type":"paragraph","inlineContent":[{"text":"Domain of your Auth0 account, for example ","type":"text"},{"code":"samples.us.auth0.com","type":"codeVoice"},{"text":".","type":"text"}]}]},{"name":"session","content":[{"type":"paragraph","inlineContent":[{"text":"","type":"text"},{"type":"codeVoice","code":"URLSession"},{"text":" instance used for networking. Defaults to ","type":"text"},{"type":"codeVoice","code":"URLSession.shared"},{"text":".","type":"text"}]}]}]},{"kind":"content","content":[{"level":2,"type":"heading","text":"Return Value","anchor":"return-value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Management API v2 client."}]}]},{"kind":"content","content":[{"type":"heading","anchor":"Usage","text":"Usage","level":2},{"type":"codeListing","code":["Auth0.users(token: credentials.accessToken, domain: \"samples.us.auth0.com\")"],"syntax":"swift"},{"type":"paragraph","inlineContent":[{"type":"text","text":"You can only perform the following operations:"}]},{"type":"unorderedList","items":[{"content":[{"inlineContent":[{"text":"Get a user by ID","type":"text"}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"text":"Update the user’s ","type":"text"},{"code":"user_metadata","type":"codeVoice"}]}]},{"content":[{"type":"paragraph","inlineContent":[{"text":"Link users","type":"text"}]}]},{"content":[{"type":"paragraph","inlineContent":[{"text":"Unlink users","type":"text"}]}]}]}]}],"sections":[],"metadata":{"modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"users"},{"kind":"text","text":"("},{"kind":"externalParam","text":"token"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"domain"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"session"},{"kind":"text","text":": "},{"preciseIdentifier":"c:objc(cs)NSURLSession","kind":"typeIdentifier","text":"URLSession"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth05UsersP","kind":"typeIdentifier","text":"Users"}],"roleHeading":"Function","title":"users(token:domain:session:)","symbolKind":"func","role":"symbol","externalID":"s:5Auth05users5token6domain7sessionAA5Users_pSS_SSSo12NSURLSessionCtF"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"type":"topic","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Users","kind":"identifier"}],"title":"Users","navigatorTitle":[{"text":"Users","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","url":"\/documentation\/auth0\/users","kind":"symbol","abstract":[{"type":"text","text":"Client for the Users endpoints of the Auth0 "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"type":"text","text":"."}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/users(token:domain:session:)":{"kind":"symbol","title":"users(token:domain:session:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"users"},{"kind":"text","text":"("},{"kind":"externalParam","text":"token"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"domain"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"session"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSURLSession","text":"URLSession"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth05UsersP","text":"Users"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/users(token:domain:session:)","abstract":[{"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","type":"reference","isActive":true},{"type":"text","text":" client for performing operations with the Users endpoints."}],"url":"\/documentation\/auth0\/users(token:domain:session:)","type":"topic"},"https://auth0.com/docs/api/management/v2":{"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","title":"Management API v2","type":"link","titleInlineContent":[{"text":"Management API v2","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/management\/v2"}}} \ No newline at end of file +{"abstract":[{"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","isActive":true,"type":"reference"},{"text":" client for performing operations with the Users endpoints.","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"users"},{"kind":"text","text":"("},{"kind":"externalParam","text":"token"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"domain"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"session"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"URLSession","preciseIdentifier":"c:objc(cs)NSURLSession"},{"kind":"text","text":" = .shared) -> "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","kind":"typeIdentifier","text":"Users","preciseIdentifier":"s:5Auth05UsersP"}],"platforms":["iOS"]}]},{"parameters":[{"name":"token","content":[{"inlineContent":[{"type":"text","text":"Access token for the Management API with the correct allowed scopes to perform the desired action."}],"type":"paragraph"}]},{"name":"domain","content":[{"inlineContent":[{"type":"text","text":"Domain of your Auth0 account, for example "},{"code":"samples.us.auth0.com","type":"codeVoice"},{"type":"text","text":"."}],"type":"paragraph"}]},{"name":"session","content":[{"inlineContent":[{"type":"text","text":""},{"code":"URLSession","type":"codeVoice"},{"type":"text","text":" instance used for networking. Defaults to "},{"code":"URLSession.shared","type":"codeVoice"},{"type":"text","text":"."}],"type":"paragraph"}]}],"kind":"parameters"},{"kind":"content","content":[{"level":2,"text":"Return Value","type":"heading","anchor":"return-value"},{"inlineContent":[{"type":"text","text":"Management API v2 client."}],"type":"paragraph"}]},{"kind":"content","content":[{"level":2,"text":"Usage","type":"heading","anchor":"Usage"},{"code":["Auth0.users(token: credentials.accessToken, domain: \"samples.us.auth0.com\")"],"syntax":"swift","type":"codeListing"},{"inlineContent":[{"type":"text","text":"You can only perform the following operations:"}],"type":"paragraph"},{"type":"unorderedList","items":[{"content":[{"inlineContent":[{"type":"text","text":"Get a user by ID"}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"type":"text","text":"Update the user’s "},{"type":"codeVoice","code":"user_metadata"}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"type":"text","text":"Link users"}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"type":"text","text":"Unlink users"}],"type":"paragraph"}]}]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/users(token:domain:session:)"]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"metadata":{"modules":[{"name":"Auth0"}],"symbolKind":"func","roleHeading":"Function","title":"users(token:domain:session:)","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"users"},{"kind":"text","text":"("},{"kind":"externalParam","text":"token"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"domain"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"session"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"URLSession","preciseIdentifier":"c:objc(cs)NSURLSession"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Users","preciseIdentifier":"s:5Auth05UsersP"}],"externalID":"s:5Auth05users5token6domain7sessionAA5Users_pSS_SSSo12NSURLSessionCtF"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/users(token:domain:session:)","interfaceLanguage":"swift"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/users(token:domain:session:)":{"title":"users(token:domain:session:)","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/users(token:domain:session:)","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"users"},{"kind":"text","text":"("},{"kind":"externalParam","text":"token"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"domain"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"session"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSURLSession","text":"URLSession"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth05UsersP","text":"Users"}],"abstract":[{"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","isActive":true,"type":"reference"},{"text":" client for performing operations with the Users endpoints.","type":"text"}],"url":"\/documentation\/auth0\/users(token:domain:session:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"https://auth0.com/docs/api/management/v2":{"title":"Management API v2","type":"link","titleInlineContent":[{"text":"Management API v2","type":"text"}],"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","url":"https:\/\/auth0.com\/docs\/api\/management\/v2"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"url":"\/documentation\/auth0\/users","title":"Users","abstract":[{"type":"text","text":"Client for the Users endpoints of the Auth0 "},{"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","type":"reference","isActive":true},{"text":".","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"Users"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Users"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","role":"symbol","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 ddbcf8961..6d643bd78 100644 --- a/docs/data/documentation/auth0/users(token:session:bundle:).json +++ b/docs/data/documentation/auth0/users(token:session:bundle:).json @@ -1 +1 @@ -{"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"sections":[],"kind":"symbol","abstract":[{"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","type":"reference","isActive":true},{"type":"text","text":" client for performing operations with the Users endpoints."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/users(token:session:bundle:)"]}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"users","kind":"identifier"},{"text":"(","kind":"text"},{"text":"token","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"session","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:objc(cs)NSURLSession","text":"URLSession","kind":"typeIdentifier"},{"text":" = .shared, ","kind":"text"},{"text":"bundle","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:objc(cs)NSBundle","text":"Bundle","kind":"typeIdentifier"},{"text":" = .main) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth05UsersP","text":"Users","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"}]}],"kind":"declarations"},{"parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Access token for the Management API with the correct allowed scopes to perform the desired action."}]}],"name":"token"},{"content":[{"type":"paragraph","inlineContent":[{"text":"","type":"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":[{"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"},{"text":".","type":"text"}]}],"name":"bundle"}],"kind":"parameters"},{"content":[{"text":"Return Value","anchor":"return-value","level":2,"type":"heading"},{"inlineContent":[{"type":"text","text":"Management API v2 client."}],"type":"paragraph"}],"kind":"content"},{"content":[{"level":2,"anchor":"Usage","text":"Usage","type":"heading"},{"syntax":"swift","code":["Auth0.users(token: credentials.accessToken)"],"type":"codeListing"},{"inlineContent":[{"text":"You can only perform the following operations:","type":"text"}],"type":"paragraph"},{"items":[{"content":[{"inlineContent":[{"text":"Get a user by ID","type":"text"}],"type":"paragraph"}]},{"content":[{"type":"paragraph","inlineContent":[{"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"},{"inlineContent":[{"text":"The Auth0 Domain is loaded from the ","type":"text"},{"code":"Auth0.plist","type":"codeVoice"},{"text":" file in your main bundle. It should have the following content:","type":"text"}],"type":"paragraph"},{"syntax":"xml","code":["","","",""," ClientId<\/key>"," YOUR_AUTH0_CLIENT_ID<\/string>"," Domain<\/key>"," YOUR_AUTH0_DOMAIN<\/string>","<\/dict>","<\/plist>"],"type":"codeListing"},{"style":"warning","name":"Warning","content":[{"type":"paragraph","inlineContent":[{"text":"Calling this method without a valid ","type":"text"},{"type":"codeVoice","code":"Auth0.plist"},{"text":" file will crash your application.","type":"text"}]}],"type":"aside"}],"kind":"content"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/users(token:session:bundle:)","interfaceLanguage":"swift"},"metadata":{"roleHeading":"Function","modules":[{"name":"Auth0"}],"role":"symbol","title":"users(token:session:bundle:)","externalID":"s:5Auth05users5token7session6bundleAA5Users_pSS_So12NSURLSessionCSo8NSBundleCtF","symbolKind":"func","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"users","kind":"identifier"},{"text":"(","kind":"text"},{"text":"token","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"session","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"URLSession","kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSURLSession"},{"text":", ","kind":"text"},{"text":"bundle","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Bundle","kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSBundle"},{"text":") -> ","kind":"text"},{"text":"Users","kind":"typeIdentifier","preciseIdentifier":"s:5Auth05UsersP"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/users(token:session:bundle:)":{"type":"topic","url":"\/documentation\/auth0\/users(token:session:bundle:)","abstract":[{"type":"reference","isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"type":"text","text":" client for performing operations with the Users endpoints."}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"users","kind":"identifier"},{"text":"(","kind":"text"},{"text":"token","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","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":"externalParam","text":"bundle"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSBundle","text":"Bundle"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth05UsersP","text":"Users"}],"title":"users(token:session:bundle:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/users(token:session:bundle:)","kind":"symbol","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"https://auth0.com/docs/api/management/v2":{"titleInlineContent":[{"type":"text","text":"Management API v2"}],"title":"Management API v2","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","url":"https:\/\/auth0.com\/docs\/api\/management\/v2","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"type":"topic","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Users","kind":"identifier"}],"title":"Users","navigatorTitle":[{"text":"Users","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","url":"\/documentation\/auth0\/users","kind":"symbol","abstract":[{"type":"text","text":"Client for the Users endpoints of the Auth0 "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"type":"text","text":"."}],"role":"symbol"}}} \ No newline at end of file +{"metadata":{"symbolKind":"func","roleHeading":"Function","title":"users(token:session:bundle:)","externalID":"s:5Auth05users5token7session6bundleAA5Users_pSS_So12NSURLSessionCSo8NSBundleCtF","modules":[{"name":"Auth0"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"users","kind":"identifier"},{"text":"(","kind":"text"},{"text":"token","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"session","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"URLSession","preciseIdentifier":"c:objc(cs)NSURLSession","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"bundle","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Bundle","preciseIdentifier":"c:objc(cs)NSBundle","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Users","preciseIdentifier":"s:5Auth05UsersP","kind":"typeIdentifier"}],"role":"symbol"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/users(token:session:bundle:)"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/users(token:session:bundle:)"},"kind":"symbol","abstract":[{"type":"reference","isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"type":"text","text":" client for performing operations with the Users endpoints."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"users","kind":"identifier"},{"text":"(","kind":"text"},{"text":"token","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"session","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"URLSession","preciseIdentifier":"c:objc(cs)NSURLSession","kind":"typeIdentifier"},{"text":" = .shared, ","kind":"text"},{"text":"bundle","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Bundle","preciseIdentifier":"c:objc(cs)NSBundle","kind":"typeIdentifier"},{"text":" = .main) -> ","kind":"text"},{"text":"Users","preciseIdentifier":"s:5Auth05UsersP","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"}],"languages":["swift"],"platforms":["iOS"]}]},{"parameters":[{"name":"token","content":[{"inlineContent":[{"text":"Access token for the Management API with the correct allowed scopes to perform the desired action.","type":"text"}],"type":"paragraph"}]},{"name":"session","content":[{"inlineContent":[{"text":"","type":"text"},{"code":"URLSession","type":"codeVoice"},{"text":" instance used for networking. Defaults to ","type":"text"},{"code":"URLSession.shared","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"}]},{"name":"bundle","content":[{"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"},{"text":".","type":"text"}],"type":"paragraph"}]}],"kind":"parameters"},{"kind":"content","content":[{"type":"heading","text":"Return Value","anchor":"return-value","level":2},{"type":"paragraph","inlineContent":[{"text":"Management API v2 client.","type":"text"}]}]},{"kind":"content","content":[{"type":"heading","text":"Usage","anchor":"Usage","level":2},{"type":"codeListing","code":["Auth0.users(token: credentials.accessToken)"],"syntax":"swift"},{"type":"paragraph","inlineContent":[{"text":"You can only perform the following operations:","type":"text"}]},{"type":"unorderedList","items":[{"content":[{"inlineContent":[{"type":"text","text":"Get a user by ID"}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"type":"text","text":"Update the user’s "},{"type":"codeVoice","code":"user_metadata"}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"type":"text","text":"Link users"}],"type":"paragraph"}]},{"content":[{"inlineContent":[{"type":"text","text":"Unlink users"}],"type":"paragraph"}]}]},{"type":"paragraph","inlineContent":[{"text":"The Auth0 Domain is loaded from the ","type":"text"},{"code":"Auth0.plist","type":"codeVoice"},{"text":" file in your main bundle. It should have the following content:","type":"text"}]},{"type":"codeListing","code":["","","",""," ClientId<\/key>"," YOUR_AUTH0_CLIENT_ID<\/string>"," Domain<\/key>"," YOUR_AUTH0_DOMAIN<\/string>","<\/dict>","<\/plist>"],"syntax":"xml"},{"type":"aside","name":"Warning","style":"warning","content":[{"inlineContent":[{"text":"Calling this method without a valid ","type":"text"},{"code":"Auth0.plist","type":"codeVoice"},{"text":" file will crash your application.","type":"text"}],"type":"paragraph"}]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Users":{"url":"\/documentation\/auth0\/users","title":"Users","abstract":[{"type":"text","text":"Client for the Users endpoints of the Auth0 "},{"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","type":"reference","isActive":true},{"text":".","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"Users"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Users"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"https://auth0.com/docs/api/management/v2":{"title":"Management API 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"},"doc://com.auth0.Auth0/documentation/Auth0/users(token:session:bundle:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/users(token:session:bundle:)","type":"topic","title":"users(token:session:bundle:)","role":"symbol","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"users"},{"kind":"text","text":"("},{"kind":"externalParam","text":"token"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"session"},{"text":": ","kind":"text"},{"text":"URLSession","preciseIdentifier":"c:objc(cs)NSURLSession","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"bundle","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSBundle","text":"Bundle"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth05UsersP","text":"Users"}],"abstract":[{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"type":"text","text":" client for performing operations with the Users endpoints."}],"url":"\/documentation\/auth0\/users(token:session:bundle:)"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/users.json b/docs/data/documentation/auth0/users.json index 2c3c4b1ad..b1307a0b5 100644 --- a/docs/data/documentation/auth0/users.json +++ b/docs/data/documentation/auth0/users.json @@ -1 +1 @@ -{"metadata":{"fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Users","kind":"identifier"}],"navigatorTitle":[{"text":"Users","kind":"identifier"}],"symbolKind":"protocol","title":"Users","modules":[{"name":"Auth0"}],"roleHeading":"Protocol","role":"symbol","externalID":"s:5Auth05UsersP"},"topicSections":[{"title":"Instance Properties","anchor":"Instance-Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/token","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/url"],"generated":true},{"title":"Instance Methods","anchor":"Instance-Methods","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/get(_:fields:include:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/link(_:withOtherUserToken:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/link(_:withUser:provider:connectionId:)","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:)"],"generated":true}],"seeAlsoSections":[{"title":"Related Documentation","anchor":"Related-Documentation","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"]}],"variants":[{"paths":["\/documentation\/auth0\/users"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Users"},{"kind":"text","text":" : "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","kind":"typeIdentifier","preciseIdentifier":"s:5Auth08LoggableP","text":"Loggable"},{"kind":"text","text":", "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable","kind":"typeIdentifier","preciseIdentifier":"s:5Auth09TrackableP","text":"Trackable"}],"languages":["swift"]}]}],"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"},"schemaVersion":{"patch":0,"major":0,"minor":3},"relationshipsSections":[{"title":"Inherits From","kind":"relationships","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable"],"type":"inheritsFrom"}],"abstract":[{"type":"text","text":"Client for the Users endpoints of the Auth0 "},{"type":"reference","isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"type":"text","text":"."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:userMetadata:)":{"title":"patch(_:userMetadata:)","abstract":[{"type":"text","text":"Updates only the user’s "},{"type":"codeVoice","code":"user_metadata"},{"type":"text","text":" field."}],"type":"topic","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:userMetadata:)","url":"\/documentation\/auth0\/users\/patch(_:usermetadata:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"patch","kind":"identifier"},{"text":"(","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"userMetadata","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"]) -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"required":true,"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Users/link(_:withOtherUserToken:)":{"url":"\/documentation\/auth0\/users\/link(_:withotherusertoken:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"link"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"withOtherUserToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<["},{"kind":"typeIdentifier","text":"ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"kind":"text","text":"], "},{"kind":"typeIdentifier","text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"kind":"text","text":">"}],"abstract":[{"type":"text","text":"Links a user given its identifier with a secondary user given its ID token."},{"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":" "},{"type":"text","text":"the secondary user."}],"kind":"symbol","type":"topic","required":true,"role":"symbol","title":"link(_:withOtherUserToken:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/link(_:withOtherUserToken:)"},"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","url":"\/documentation\/auth0\/trackable","role":"symbol","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Trackable"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable","title":"Trackable","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Trackable"}]},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"type":"topic","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Users","kind":"identifier"}],"title":"Users","navigatorTitle":[{"text":"Users","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","url":"\/documentation\/auth0\/users","kind":"symbol","abstract":[{"type":"text","text":"Client for the Users endpoints of the Auth0 "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"type":"text","text":"."}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Users/unlink(identityId:provider:fromUserId:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/unlink(identityId:provider:fromUserId:)","url":"\/documentation\/auth0\/users\/unlink(identityid:provider:fromuserid:)","kind":"symbol","abstract":[{"type":"text","text":"Removes an identity from a user."}],"title":"unlink(identityId:provider:fromUserId:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"unlink","kind":"identifier"},{"text":"(","kind":"text"},{"text":"identityId","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"provider","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"fromUserId","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<[","kind":"text"},{"text":"ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta","kind":"typeIdentifier"},{"text":"], ","kind":"text"},{"text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"required":true,"role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Users/url":{"type":"topic","role":"symbol","kind":"symbol","title":"url","abstract":[{"type":"text","text":"The Auth0 Domain URL."}],"required":true,"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"url"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV","text":"URL"}],"url":"\/documentation\/auth0\/users\/url","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/url"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"type":"topic","url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","kind":"symbol","title":"ManagementError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}]},"doc://com.auth0.Auth0/documentation/Auth0/Users/link(_:withUser:provider:connectionId:)":{"url":"\/documentation\/auth0\/users\/link(_:withuser:provider:connectionid:)","kind":"symbol","abstract":[{"text":"Links a user given its identifier with a secondary user given its identifier, provider and connection identifier.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/link(_:withUser:provider:connectionId:)","title":"link(_:withUser:provider:connectionId:)","defaultImplementations":1,"type":"topic","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"link","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"withUser","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"provider","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"connectionId","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":"<["},{"kind":"typeIdentifier","text":"ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"kind":"text","text":"], "},{"kind":"typeIdentifier","text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"kind":"text","text":">"}],"required":true,"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Users/get(_:fields:include:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/get(_:fields:include:)","url":"\/documentation\/auth0\/users\/get(_:fields:include:)","kind":"symbol","abstract":[{"type":"text","text":"Fetches a user using its identifier."}],"title":"get(_:fields:include:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"get","kind":"identifier"},{"text":"(","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"fields","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"], ","kind":"text"},{"text":"include","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"text":") -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"ManagementObject","kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"text":", ","kind":"text"},{"text":"ManagementError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"text":">","kind":"text"}],"required":true,"role":"symbol","defaultImplementations":1,"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"required":true,"kind":"symbol","url":"\/documentation\/auth0\/users\/patch(_:attributes:)","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"patch"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"attributes"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","kind":"typeIdentifier","text":"UserPatchAttributes"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError"},{"kind":"text","text":">"}],"deprecated":true,"title":"patch(_:attributes:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","abstract":[{"type":"text","text":"Updates a user’s root values (those which are allowed to be updated)."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Users/token":{"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"token","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"kind":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/token","url":"\/documentation\/auth0\/users\/token","abstract":[{"type":"text","text":"The Management API token."}],"required":true,"role":"symbol","title":"token"},"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"},"doc://com.auth0.Auth0/documentation/Auth0/Loggable":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","abstract":[{"type":"text","text":"A type that can log statements for debugging purposes."}],"fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Loggable","kind":"identifier"}],"kind":"symbol","title":"Loggable","type":"topic","role":"symbol","navigatorTitle":[{"text":"Loggable","kind":"identifier"}],"url":"\/documentation\/auth0\/loggable"}}} \ No newline at end of file +{"topicSections":[{"anchor":"Instance-Properties","title":"Instance Properties","generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/token","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/url"]},{"anchor":"Instance-Methods","title":"Instance Methods","generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/get(_:fields:include:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/link(_:withOtherUserToken:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/link(_:withUser:provider:connectionId:)","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:)"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"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":[{"languages":["swift"],"tokens":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Users"},{"kind":"text","text":" : "},{"preciseIdentifier":"s:5Auth08LoggableP","text":"Loggable","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"Trackable","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable","preciseIdentifier":"s:5Auth09TrackableP"}],"platforms":["iOS"]}],"kind":"declarations"}],"sections":[],"abstract":[{"text":"Client for the Users endpoints of the Auth0 ","type":"text"},{"isActive":true,"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","type":"reference"},{"text":".","type":"text"}],"kind":"symbol","seeAlsoSections":[{"title":"Related Documentation","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"],"anchor":"Related-Documentation"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/users"]}],"metadata":{"roleHeading":"Protocol","navigatorTitle":[{"text":"Users","kind":"identifier"}],"title":"Users","role":"symbol","modules":[{"name":"Auth0"}],"externalID":"s:5Auth05UsersP","symbolKind":"protocol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Users","kind":"identifier"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"references":{"https://auth0.com/docs/api/management/v2":{"title":"Management API v2","url":"https:\/\/auth0.com\/docs\/api\/management\/v2","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","titleInlineContent":[{"type":"text","text":"Management API v2"}]},"doc://com.auth0.Auth0/documentation/Auth0/Loggable":{"role":"symbol","title":"Loggable","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Loggable"}],"navigatorTitle":[{"text":"Loggable","kind":"identifier"}],"abstract":[{"text":"A type that can log statements for debugging purposes.","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/loggable","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Users/link(_:withOtherUserToken:)":{"url":"\/documentation\/auth0\/users\/link(_:withotherusertoken:)","title":"link(_:withOtherUserToken:)","abstract":[{"type":"text","text":"Links a user given its identifier with a secondary user given its ID token."},{"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":" "},{"type":"text","text":"the secondary user."}],"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"link","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"withOtherUserToken","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<["},{"kind":"typeIdentifier","text":"ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"kind":"text","text":"], "},{"kind":"typeIdentifier","text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"text":">","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/link(_:withOtherUserToken:)","required":true,"kind":"symbol","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"title":"ManagementError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}]},"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"role":"symbol","title":"patch(_:attributes:)","deprecated":true,"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"patch","kind":"identifier"},{"text":"(","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"attributes","kind":"externalParam"},{"kind":"text","text":": "},{"text":"UserPatchAttributes","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError","kind":"typeIdentifier"},{"kind":"text","text":">"}],"abstract":[{"type":"text","text":"Updates a user’s root values (those which are allowed to be updated)."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","url":"\/documentation\/auth0\/users\/patch(_:attributes:)","required":true,"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:userMetadata:)":{"role":"symbol","title":"patch(_:userMetadata:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"patch"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"userMetadata"},{"kind":"text","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"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:5Auth016ManagementObjecta","kind":"typeIdentifier","text":"ManagementObject"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth015ManagementErrorV","kind":"typeIdentifier","text":"ManagementError"},{"kind":"text","text":">"}],"abstract":[{"type":"text","text":"Updates only the user’s "},{"type":"codeVoice","code":"user_metadata"},{"type":"text","text":" field."}],"kind":"symbol","url":"\/documentation\/auth0\/users\/patch(_:usermetadata:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:userMetadata:)","required":true,"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Trackable":{"title":"Trackable","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Trackable"}],"abstract":[{"text":"A type that can send the ","type":"text"},{"code":"Auth0-Client","type":"codeVoice"},{"text":" header on every request to Auth0.","type":"text"}],"url":"\/documentation\/auth0\/trackable","navigatorTitle":[{"kind":"identifier","text":"Trackable"}]},"doc://com.auth0.Auth0/documentation/Auth0/Users/unlink(identityId:provider:fromUserId:)":{"url":"\/documentation\/auth0\/users\/unlink(identityid:provider:fromuserid:)","required":true,"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"unlink","kind":"identifier"},{"text":"(","kind":"text"},{"text":"identityId","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"provider","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"fromUserId","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<[","kind":"text"},{"preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject","kind":"typeIdentifier"},{"text":"], ","kind":"text"},{"preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"title":"unlink(identityId:provider:fromUserId:)","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Removes an identity from a user."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/unlink(identityId:provider:fromUserId:)","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Users/url":{"kind":"symbol","abstract":[{"type":"text","text":"The Auth0 Domain URL."}],"type":"topic","title":"url","url":"\/documentation\/auth0\/users\/url","required":true,"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/url","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"url"},{"kind":"text","text":": "},{"preciseIdentifier":"s:10Foundation3URLV","kind":"typeIdentifier","text":"URL"}]},"doc://com.auth0.Auth0/documentation/Auth0/Users/token":{"role":"symbol","title":"token","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"token"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"abstract":[{"type":"text","text":"The Management API token."}],"kind":"symbol","url":"\/documentation\/auth0\/users\/token","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/token","required":true,"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Users/get(_:fields:include:)":{"url":"\/documentation\/auth0\/users\/get(_:fields:include:)","title":"get(_:fields:include:)","abstract":[{"type":"text","text":"Fetches a user using its identifier."}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"get"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"fields"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"include"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:5Auth016ManagementObjecta","kind":"typeIdentifier","text":"ManagementObject"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth015ManagementErrorV","kind":"typeIdentifier","text":"ManagementError"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/get(_:fields:include:)","required":true,"kind":"symbol","role":"symbol","defaultImplementations":1,"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"url":"\/documentation\/auth0\/users","title":"Users","abstract":[{"type":"text","text":"Client for the Users endpoints of the Auth0 "},{"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","type":"reference","isActive":true},{"text":".","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"Users"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Users"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Users/link(_:withUser:provider:connectionId:)":{"defaultImplementations":1,"type":"topic","title":"link(_:withUser:provider:connectionId:)","url":"\/documentation\/auth0\/users\/link(_:withuser:provider:connectionid:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/link(_:withUser:provider:connectionId:)","abstract":[{"type":"text","text":"Links a user given its identifier with a secondary user given its identifier, provider and connection identifier."}],"required":true,"role":"symbol","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":"withUser"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"provider"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connectionId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<["},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject"},{"kind":"text","text":"], "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError"},{"kind":"text","text":">"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/users/get(_:fields:include:)-7aaln.json b/docs/data/documentation/auth0/users/get(_:fields:include:)-7aaln.json index 2deea65d6..1b3c38cfc 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 @@ -{"metadata":{"symbolKind":"method","role":"symbol","extendedModule":"Auth0","title":"get(_:fields:include:)","roleHeading":"Instance Method","externalID":"s:5Auth05UsersPAAE3get_6fields7includeAA7RequestVySDySSypGAA15ManagementErrorVGSS_SaySSGSbtF","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"get","kind":"identifier"},{"text":"(","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"fields","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"], ","kind":"text"},{"text":"include","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"text":") -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"ManagementObject","kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"text":", ","kind":"text"},{"text":"ManagementError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"text":">","kind":"text"}],"modules":[{"name":"Auth0"}]},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"]]},"schemaVersion":{"patch":0,"major":0,"minor":3},"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/get_users_by_id"],"anchor":"Related-Documentation","title":"Related Documentation"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/get(_:fields:include:)-7aaln","interfaceLanguage":"swift"},"abstract":[{"text":"Fetches a user using its identifier.","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"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"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"fields","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"] = [], ","kind":"text"},{"text":"include","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"text":" = true) -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"ManagementObject","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"text":", ","kind":"text"},{"text":"ManagementError","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"text":">","kind":"text"}],"languages":["swift"]}]},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"text":"ID of the user. You can get this value from the ","type":"text"},{"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"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","isActive":true,"type":"reference"},{"text":" instance.","type":"text"}],"type":"paragraph"}],"name":"identifier"},{"content":[{"type":"paragraph","inlineContent":[{"text":"List of the user’s field names that will be included\/excluded in the response. By default all will be retrieved.","type":"text"}]}],"name":"fields"},{"content":[{"inlineContent":[{"type":"text","text":"Flag that indicates that only the names in ‘fields’ should be included\/excluded in the response. By default it will include them."}],"type":"paragraph"}],"name":"include"}]},{"kind":"content","content":[{"level":2,"text":"Return Value","type":"heading","anchor":"return-value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A request that will yield a user."}]}]},{"kind":"content","content":[{"level":2,"text":"Usage","anchor":"Usage","type":"heading"},{"inlineContent":[{"type":"text","text":"By default it gets all the user’s attributes:"}],"type":"paragraph"},{"code":["Auth0"," .users(token: credentials.accessToken, domain: domain)"," .get(\"user-id\")"," .start { result in"," switch result {"," case .success(let user):"," print(\"Obtained user: \\(user)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"],"syntax":"swift","type":"codeListing"},{"inlineContent":[{"type":"text","text":"You can select which attributes you want:"}],"type":"paragraph"},{"code":["Auth0"," .users(token: credentials.accessToken, domain: domain)"," .get(\"user-id\", fields: [\"email\", \"user_id\"])"," .start { print($0) }"],"syntax":"swift","type":"codeListing"},{"inlineContent":[{"type":"text","text":"You can even exclude some attributes:"}],"type":"paragraph"},{"code":["Auth0"," .users(token: credentials.accessToken, domain: domain)"," .get(\"user-id\", fields: [\"identities\", \"app_metadata\"], include: false)"," .start { print($0) }"],"syntax":"swift","type":"codeListing"},{"style":"note","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The token must have the scope "},{"type":"codeVoice","code":"read:users"},{"type":"text","text":" scope."}]}],"name":"Requires","type":"aside"}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/users\/get(_:fields:include:)-7aaln"]}],"sections":[],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"type":"topic","url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","kind":"symbol","title":"ManagementError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}]},"https://auth0.com/docs/api/management/v2":{"title":"Management API v2","url":"https:\/\/auth0.com\/docs\/api\/management\/v2","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","type":"link","titleInlineContent":[{"text":"Management API v2","type":"text"}]},"https://auth0.com/docs/api/management/v2#!/Users/get_users_by_id":{"titleInlineContent":[{"text":"Management API Endpoint","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/get_users_by_id","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/get_users_by_id","type":"link","title":"Management API Endpoint"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/request","kind":"symbol","abstract":[{"type":"text","text":"Auth0 API request."}]},"doc://com.auth0.Auth0/documentation/Auth0/Users/get(_:fields:include:)-7aaln":{"url":"\/documentation\/auth0\/users\/get(_:fields:include:)-7aaln","abstract":[{"text":"Fetches a user using its identifier.","type":"text"}],"kind":"symbol","role":"symbol","title":"get(_:fields:include:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/get(_:fields:include:)-7aaln","type":"topic","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"get"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"fields"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"include"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"kind":"text","text":">"}]},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"type":"topic","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Users","kind":"identifier"}],"title":"Users","navigatorTitle":[{"text":"Users","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","url":"\/documentation\/auth0\/users","kind":"symbol","abstract":[{"type":"text","text":"Client for the Users endpoints of the Auth0 "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"type":"text","text":"."}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementObject":{"type":"topic","title":"ManagementObject","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","role":"symbol","kind":"symbol","navigatorTitle":[{"text":"ManagementObject","kind":"identifier"}],"fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ManagementObject","kind":"identifier"}],"url":"\/documentation\/auth0\/managementobject","abstract":[{"text":"A dictionary containing a user profile.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"text":"UserInfo","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/userinfo","type":"topic","title":"UserInfo","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"}}} \ No newline at end of file +{"metadata":{"symbolKind":"method","title":"get(_:fields:include:)","roleHeading":"Instance Method","extendedModule":"Auth0","externalID":"s:5Auth05UsersPAAE3get_6fields7includeAA7RequestVySDySSypGAA15ManagementErrorVGSS_SaySSGSbtF","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"get"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"fields"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"include"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"kind":"text","text":">"}],"role":"symbol"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/users\/get(_:fields:include:)-7aaln"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/get(_:fields:include:)-7aaln","interfaceLanguage":"swift"},"kind":"symbol","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"]]},"seeAlsoSections":[{"title":"Related Documentation","anchor":"Related-Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/get_users_by_id"]}],"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"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"fields","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"] = [], ","kind":"text"},{"text":"include","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"text":" = true) -> ","kind":"text"},{"text":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"ManagementObject","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"text":", ","kind":"text"},{"text":"ManagementError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"text":">","kind":"text"}]}]},{"parameters":[{"name":"identifier","content":[{"inlineContent":[{"type":"text","text":"ID of the user. You can get this value from the "},{"type":"codeVoice","code":"sub"},{"type":"text","text":" claim of the user’s ID token, or from the "},{"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."}],"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"}]},{"name":"include","content":[{"inlineContent":[{"type":"text","text":"Flag that indicates that only the names in ‘fields’ should be included\/excluded in the response. By default it will include them."}],"type":"paragraph"}]}],"kind":"parameters"},{"kind":"content","content":[{"level":2,"anchor":"return-value","type":"heading","text":"Return Value"},{"inlineContent":[{"text":"A request that will yield a user.","type":"text"}],"type":"paragraph"}]},{"kind":"content","content":[{"level":2,"anchor":"Usage","type":"heading","text":"Usage"},{"inlineContent":[{"text":"By default it gets all the user’s attributes:","type":"text"}],"type":"paragraph"},{"code":["Auth0"," .users(token: credentials.accessToken, domain: domain)"," .get(\"user-id\")"," .start { result in"," switch result {"," case .success(let user):"," print(\"Obtained user: \\(user)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"],"type":"codeListing","syntax":"swift"},{"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"},{"inlineContent":[{"text":"You can even exclude some attributes:","type":"text"}],"type":"paragraph"},{"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 "},{"type":"codeVoice","code":"read:users"},{"type":"text","text":" scope."}],"type":"paragraph"}],"type":"aside","style":"note"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Request":{"title":"Request","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"abstract":[{"text":"Auth0 API request.","type":"text"}],"url":"\/documentation\/auth0\/request","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementObject":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"ManagementObject"}],"title":"ManagementObject","role":"symbol","fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementObject"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","abstract":[{"text":"A dictionary containing a user profile.","type":"text"}],"url":"\/documentation\/auth0\/managementobject"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"https://auth0.com/docs/api/management/v2":{"title":"Management API v2","type":"link","titleInlineContent":[{"type":"text","text":"Management API v2"}],"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","url":"https:\/\/auth0.com\/docs\/api\/management\/v2"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"title":"UserInfo","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"UserInfo"}],"abstract":[{"text":"OIDC Standard Claims user information.","type":"text"}],"url":"\/documentation\/auth0\/userinfo","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"title":"ManagementError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}]},"doc://com.auth0.Auth0/documentation/Auth0/Users/get(_:fields:include:)-7aaln":{"url":"\/documentation\/auth0\/users\/get(_:fields:include:)-7aaln","title":"get(_:fields:include:)","abstract":[{"type":"text","text":"Fetches a user using its identifier."}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"get"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"fields"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"include"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth015ManagementErrorV","kind":"typeIdentifier","text":"ManagementError"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/get(_:fields:include:)-7aaln","role":"symbol","kind":"symbol","type":"topic"},"https://auth0.com/docs/api/management/v2#!/Users/get_users_by_id":{"title":"Management API Endpoint","type":"link","titleInlineContent":[{"type":"text","text":"Management API Endpoint"}],"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/get_users_by_id","url":"https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/get_users_by_id"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"url":"\/documentation\/auth0\/users","title":"Users","abstract":[{"type":"text","text":"Client for the Users endpoints of the Auth0 "},{"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","type":"reference","isActive":true},{"text":".","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"Users"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Users"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","role":"symbol","kind":"symbol","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/users/get(_:fields:include:).json b/docs/data/documentation/auth0/users/get(_:fields:include:).json index 9f6c00bb1..fd69e1dff 100644 --- a/docs/data/documentation/auth0/users/get(_:fields:include:).json +++ b/docs/data/documentation/auth0/users/get(_:fields:include:).json @@ -1 +1 @@ -{"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"get"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"fields"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"include"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","text":"ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"kind":"text","text":", "},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"kind":"text","text":">"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"},{"parameters":[{"name":"identifier","content":[{"inlineContent":[{"text":"ID of the user. You can get this value from the ","type":"text"},{"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,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","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"}]},{"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":[{"level":2,"type":"heading","anchor":"Usage","text":"Usage"},{"type":"paragraph","inlineContent":[{"text":"By default it gets all the user’s attributes:","type":"text"}]},{"code":["Auth0"," .users(token: credentials.accessToken, domain: domain)"," .get(\"user-id\")"," .start { result in"," switch result {"," case .success(let user):"," print(\"Obtained user: \\(user)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"],"type":"codeListing","syntax":"swift"},{"type":"paragraph","inlineContent":[{"type":"text","text":"You can select which attributes you want:"}]},{"code":["Auth0"," .users(token: credentials.accessToken, domain: domain)"," .get(\"user-id\", fields: [\"email\", \"user_id\"])"," .start { print($0) }"],"type":"codeListing","syntax":"swift"},{"type":"paragraph","inlineContent":[{"text":"You can even exclude some attributes:","type":"text"}]},{"code":["Auth0"," .users(token: credentials.accessToken, domain: domain)"," .get(\"user-id\", fields: [\"identities\", \"app_metadata\"], include: false)"," .start { print($0) }"],"type":"codeListing","syntax":"swift"},{"style":"note","content":[{"inlineContent":[{"type":"text","text":"The token must have the scope "},{"code":"read:users","type":"codeVoice"},{"type":"text","text":" scope."}],"type":"paragraph"}],"type":"aside","name":"Requires"}],"kind":"content"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/users\/get(_:fields:include:)"]}],"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/get_users_by_id"],"anchor":"Related-Documentation","title":"Related Documentation"}],"schemaVersion":{"minor":3,"patch":0,"major":0},"abstract":[{"type":"text","text":"Fetches a user using its identifier."}],"defaultImplementationsSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/get(_:fields:include:)-7aaln"],"anchor":"Users-Implementations","title":"Users Implementations"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/get(_:fields:include:)"},"kind":"symbol","sections":[],"metadata":{"roleHeading":"Instance Method","symbolKind":"method","externalID":"s:5Auth05UsersP3get_6fields7includeAA7RequestVySDySSypGAA15ManagementErrorVGSS_SaySSGSbtF","title":"get(_:fields:include:)","required":true,"modules":[{"name":"Auth0"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"get","kind":"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"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"role":"symbol"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Users/get(_:fields:include:)-7aaln":{"url":"\/documentation\/auth0\/users\/get(_:fields:include:)-7aaln","abstract":[{"text":"Fetches a user using its identifier.","type":"text"}],"kind":"symbol","role":"symbol","title":"get(_:fields:include:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/get(_:fields:include:)-7aaln","type":"topic","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"get"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"fields"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"include"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"kind":"text","text":">"}]},"doc://com.auth0.Auth0/documentation/Auth0/Users/get(_:fields:include:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/get(_:fields:include:)","url":"\/documentation\/auth0\/users\/get(_:fields:include:)","kind":"symbol","abstract":[{"type":"text","text":"Fetches a user using its identifier."}],"title":"get(_:fields:include:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"get","kind":"identifier"},{"text":"(","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"fields","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"], ","kind":"text"},{"text":"include","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"text":") -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"ManagementObject","kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"text":", ","kind":"text"},{"text":"ManagementError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"text":">","kind":"text"}],"required":true,"role":"symbol","defaultImplementations":1,"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/request","kind":"symbol","abstract":[{"type":"text","text":"Auth0 API request."}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"type":"topic","url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","kind":"symbol","title":"ManagementError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}]},"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","titleInlineContent":[{"type":"text","text":"Management API Endpoint"}],"url":"https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/get_users_by_id","title":"Management API Endpoint","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"type":"topic","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Users","kind":"identifier"}],"title":"Users","navigatorTitle":[{"text":"Users","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","url":"\/documentation\/auth0\/users","kind":"symbol","abstract":[{"type":"text","text":"Client for the Users endpoints of the Auth0 "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"type":"text","text":"."}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementObject":{"type":"topic","title":"ManagementObject","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","role":"symbol","kind":"symbol","navigatorTitle":[{"text":"ManagementObject","kind":"identifier"}],"fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ManagementObject","kind":"identifier"}],"url":"\/documentation\/auth0\/managementobject","abstract":[{"text":"A dictionary containing a user profile.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"text":"UserInfo","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/userinfo","type":"topic","title":"UserInfo","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"},"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"}],"url":"https:\/\/auth0.com\/docs\/api\/management\/v2"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"]]},"metadata":{"modules":[{"name":"Auth0"}],"title":"get(_:fields:include:)","externalID":"s:5Auth05UsersP3get_6fields7includeAA7RequestVySDySSypGAA15ManagementErrorVGSS_SaySSGSbtF","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"get"},{"kind":"text","text":"("},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"fields","kind":"externalParam"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"include"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"text":"ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"text":">","kind":"text"}],"roleHeading":"Instance Method","symbolKind":"method","required":true},"sections":[],"abstract":[{"type":"text","text":"Fetches a user using its identifier."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/users\/get(_:fields:include:)"]}],"defaultImplementationsSections":[{"title":"Users Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/get(_:fields:include:)-7aaln"],"anchor":"Users-Implementations"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/get(_:fields:include:)","interfaceLanguage":"swift"},"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/get_users_by_id"],"anchor":"Related-Documentation"}],"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"get"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"fields"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":"], ","kind":"text"},{"kind":"externalParam","text":"include"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":") -> "},{"text":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"ManagementObject","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"kind":"text","text":", "},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"kind":"text","text":">"}]}],"kind":"declarations"},{"parameters":[{"name":"identifier","content":[{"inlineContent":[{"type":"text","text":"ID of the user. 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"},{"type":"text","text":" property of a "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","isActive":true},{"type":"text","text":" instance."}],"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":[{"type":"text","text":"Flag that indicates that only the names in ‘fields’ should be included\/excluded in the response. By default it will include them."}],"type":"paragraph"}],"name":"include"}],"kind":"parameters"},{"kind":"content","content":[{"type":"heading","level":2,"text":"Return Value","anchor":"return-value"},{"inlineContent":[{"type":"text","text":"A request that will yield a user."}],"type":"paragraph"}]},{"content":[{"level":2,"text":"Usage","type":"heading","anchor":"Usage"},{"inlineContent":[{"text":"By default it gets all the user’s attributes:","type":"text"}],"type":"paragraph"},{"code":["Auth0"," .users(token: credentials.accessToken, domain: domain)"," .get(\"user-id\")"," .start { result in"," switch result {"," case .success(let user):"," print(\"Obtained user: \\(user)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }"],"type":"codeListing","syntax":"swift"},{"inlineContent":[{"text":"You can select which attributes you want:","type":"text"}],"type":"paragraph"},{"syntax":"swift","code":["Auth0"," .users(token: credentials.accessToken, domain: domain)"," .get(\"user-id\", fields: [\"email\", \"user_id\"])"," .start { print($0) }"],"type":"codeListing"},{"inlineContent":[{"type":"text","text":"You can even exclude some attributes:"}],"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":[{"inlineContent":[{"type":"text","text":"The token must have the scope "},{"type":"codeVoice","code":"read:users"},{"type":"text","text":" scope."}],"type":"paragraph"}],"style":"note","name":"Requires","type":"aside"}],"kind":"content"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Users/get(_:fields:include:)-7aaln":{"url":"\/documentation\/auth0\/users\/get(_:fields:include:)-7aaln","title":"get(_:fields:include:)","abstract":[{"type":"text","text":"Fetches a user using its identifier."}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"get"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"fields"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"include"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth015ManagementErrorV","kind":"typeIdentifier","text":"ManagementError"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/get(_:fields:include:)-7aaln","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"url":"\/documentation\/auth0\/users","title":"Users","abstract":[{"type":"text","text":"Client for the Users endpoints of the Auth0 "},{"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","type":"reference","isActive":true},{"text":".","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"Users"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Users"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","role":"symbol","kind":"symbol","type":"topic"},"https://auth0.com/docs/api/management/v2#!/Users/get_users_by_id":{"title":"Management API Endpoint","url":"https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/get_users_by_id","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/get_users_by_id","titleInlineContent":[{"type":"text","text":"Management API Endpoint"}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementObject":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"ManagementObject"}],"title":"ManagementObject","role":"symbol","fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementObject"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","abstract":[{"text":"A dictionary containing a user profile.","type":"text"}],"url":"\/documentation\/auth0\/managementobject"},"https://auth0.com/docs/api/management/v2":{"title":"Management API v2","url":"https:\/\/auth0.com\/docs\/api\/management\/v2","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","titleInlineContent":[{"type":"text","text":"Management API v2"}]},"doc://com.auth0.Auth0/documentation/Auth0/Users/get(_:fields:include:)":{"url":"\/documentation\/auth0\/users\/get(_:fields:include:)","title":"get(_:fields:include:)","abstract":[{"type":"text","text":"Fetches a user using its identifier."}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"get"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"fields"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"], "},{"kind":"externalParam","text":"include"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:5Auth016ManagementObjecta","kind":"typeIdentifier","text":"ManagementObject"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth015ManagementErrorV","kind":"typeIdentifier","text":"ManagementError"},{"kind":"text","text":">"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/get(_:fields:include:)","required":true,"kind":"symbol","role":"symbol","defaultImplementations":1,"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"title":"Request","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"abstract":[{"text":"Auth0 API request.","type":"text"}],"url":"\/documentation\/auth0\/request","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"title":"UserInfo","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"UserInfo"}],"abstract":[{"text":"OIDC Standard Claims user information.","type":"text"}],"url":"\/documentation\/auth0\/userinfo","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"title":"ManagementError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}]}}} \ 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 793e45bfb..3ea8dfe83 100644 --- a/docs/data/documentation/auth0/users/link(_:withotherusertoken:).json +++ b/docs/data/documentation/auth0/users/link(_:withotherusertoken:).json @@ -1 +1 @@ -{"seeAlsoSections":[{"anchor":"Related-Documentation","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":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/link(_:withOtherUserToken:)","interfaceLanguage":"swift"},"abstract":[{"text":"Links a user given its identifier with a secondary user given its ID token.","type":"text"},{"text":" ","type":"text"},{"text":"After this request the primary user will hold another identity in its ","type":"text"},{"code":"identities","type":"codeVoice"},{"text":" attribute, which will represent","type":"text"},{"text":" ","type":"text"},{"text":"the secondary user.","type":"text"}],"metadata":{"title":"link(_:withOtherUserToken:)","modules":[{"name":"Auth0"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"link","kind":"identifier"},{"text":"(","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"withOtherUserToken","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<[","kind":"text"},{"text":"ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta","kind":"typeIdentifier"},{"text":"], ","kind":"text"},{"text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"symbolKind":"method","roleHeading":"Instance Method","required":true,"role":"symbol","externalID":"s:5Auth05UsersP4link_18withOtherUserTokenAA7RequestVySaySDySSypGGAA15ManagementErrorVGSS_SStF"},"schemaVersion":{"minor":3,"major":0,"patch":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"]]},"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/users\/link(_:withotherusertoken:)"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"link"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"withOtherUserToken"},{"text":" ","kind":"text"},{"text":"token","kind":"internalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","text":"Request","kind":"typeIdentifier"},{"text":"<[","kind":"text"},{"preciseIdentifier":"s:5Auth016ManagementObjecta","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","text":"ManagementObject","kind":"typeIdentifier"},{"text":"], ","kind":"text"},{"preciseIdentifier":"s:5Auth015ManagementErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","text":"ManagementError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"languages":["swift"]}],"kind":"declarations"},{"kind":"parameters","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"},{"text":" claim of the primary user’s ID token, or from the ","type":"text"},{"code":"sub","type":"codeVoice"},{"text":" property of a ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","isActive":true,"type":"reference"},{"text":" instance.","type":"text"}]}],"name":"identifier"},{"content":[{"type":"paragraph","inlineContent":[{"text":"ID token of the secondary user.","type":"text"}]}],"name":"token"}]},{"kind":"content","content":[{"anchor":"return-value","type":"heading","text":"Return Value","level":2},{"type":"paragraph","inlineContent":[{"text":"A request to link two users.","type":"text"}]}]},{"kind":"content","content":[{"anchor":"Usage","level":2,"text":"Usage","type":"heading"},{"code":["Auth0"," .users(token: credentials.accessToken, domain: domain)"," .link(\"primary-user-id\", withOtherUserToken: \"secondary-id-token\")"," .start { print($0) }"],"syntax":"swift","type":"codeListing"},{"name":"Requires","style":"note","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"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Users/link(_:withOtherUserToken:)":{"url":"\/documentation\/auth0\/users\/link(_:withotherusertoken:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"link"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"withOtherUserToken"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<["},{"kind":"typeIdentifier","text":"ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"kind":"text","text":"], "},{"kind":"typeIdentifier","text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"kind":"text","text":">"}],"abstract":[{"type":"text","text":"Links a user given its identifier with a secondary user given its ID token."},{"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":" "},{"type":"text","text":"the secondary user."}],"kind":"symbol","type":"topic","required":true,"role":"symbol","title":"link(_:withOtherUserToken:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/link(_:withOtherUserToken:)"},"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":[{"type":"text","text":"Management API Endpoint"}],"url":"https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/post_identities","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"text":"UserInfo","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/userinfo","type":"topic","title":"UserInfo","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"},"https://auth0.com/docs/api/management/v2":{"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","title":"Management API v2","titleInlineContent":[{"type":"text","text":"Management API v2"}],"url":"https:\/\/auth0.com\/docs\/api\/management\/v2","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/request","kind":"symbol","abstract":[{"type":"text","text":"Auth0 API request."}]},"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","titleInlineContent":[{"type":"text","text":"User Account Linking"}],"url":"https:\/\/auth0.com\/docs\/manage-users\/user-accounts\/user-account-linking","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"type":"topic","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Users","kind":"identifier"}],"title":"Users","navigatorTitle":[{"text":"Users","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","url":"\/documentation\/auth0\/users","kind":"symbol","abstract":[{"type":"text","text":"Client for the Users endpoints of the Auth0 "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"type":"text","text":"."}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementObject":{"type":"topic","title":"ManagementObject","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","role":"symbol","kind":"symbol","navigatorTitle":[{"text":"ManagementObject","kind":"identifier"}],"fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ManagementObject","kind":"identifier"}],"url":"\/documentation\/auth0\/managementobject","abstract":[{"text":"A dictionary containing a user profile.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"type":"topic","url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","kind":"symbol","title":"ManagementError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}]}}} \ No newline at end of file +{"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/link(_:withOtherUserToken:)"},"metadata":{"externalID":"s:5Auth05UsersP4link_18withOtherUserTokenAA7RequestVySaySDySSypGGAA15ManagementErrorVGSS_SStF","modules":[{"name":"Auth0"}],"title":"link(_:withOtherUserToken:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"link","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"withOtherUserToken","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<[","kind":"text"},{"preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject","kind":"typeIdentifier"},{"text":"], ","kind":"text"},{"preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"roleHeading":"Instance Method","role":"symbol","required":true,"symbolKind":"method"},"kind":"symbol","seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/post_identities","https:\/\/auth0.com\/docs\/manage-users\/user-accounts\/user-account-linking"],"anchor":"Related-Documentation"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/users\/link(_:withotherusertoken:)"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"link","kind":"identifier"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"identifier","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"withOtherUserToken","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"token","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"},{"text":"<[","kind":"text"},{"text":"ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject"},{"text":"], ","kind":"text"},{"text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"},{"text":">","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]},{"parameters":[{"name":"identifier","content":[{"inlineContent":[{"text":"ID of the primary user who will be linked against a secondary one. You can get this value from the ","type":"text"},{"code":"sub","type":"codeVoice"},{"text":" claim of the primary 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"}]},{"name":"token","content":[{"inlineContent":[{"text":"ID token of the secondary user.","type":"text"}],"type":"paragraph"}]}],"kind":"parameters"},{"kind":"content","content":[{"type":"heading","text":"Return Value","anchor":"return-value","level":2},{"type":"paragraph","inlineContent":[{"text":"A request to link two users.","type":"text"}]}]},{"kind":"content","content":[{"type":"heading","text":"Usage","anchor":"Usage","level":2},{"type":"codeListing","code":["Auth0"," .users(token: credentials.accessToken, domain: domain)"," .link(\"primary-user-id\", withOtherUserToken: \"secondary-id-token\")"," .start { print($0) }"],"syntax":"swift"},{"type":"aside","name":"Requires","style":"note","content":[{"inlineContent":[{"text":"The token must have the scope ","type":"text"},{"code":"update:current_user_identities","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"}]}]}],"abstract":[{"type":"text","text":"Links a user given its identifier with a secondary user given its ID token."},{"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":" "},{"type":"text","text":"the secondary user."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Request":{"title":"Request","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"abstract":[{"text":"Auth0 API request.","type":"text"}],"url":"\/documentation\/auth0\/request","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementObject":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"ManagementObject"}],"title":"ManagementObject","role":"symbol","fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementObject"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","abstract":[{"text":"A dictionary containing a user profile.","type":"text"}],"url":"\/documentation\/auth0\/managementobject"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"https://auth0.com/docs/api/management/v2":{"title":"Management API 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"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"url":"\/documentation\/auth0\/users","title":"Users","abstract":[{"type":"text","text":"Client for the Users endpoints of the Auth0 "},{"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","type":"reference","isActive":true},{"text":".","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"Users"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Users"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"title":"ManagementError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}]},"doc://com.auth0.Auth0/documentation/Auth0/Users/link(_:withOtherUserToken:)":{"url":"\/documentation\/auth0\/users\/link(_:withotherusertoken:)","title":"link(_:withOtherUserToken:)","abstract":[{"type":"text","text":"Links a user given its identifier with a secondary user given its ID token."},{"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":" "},{"type":"text","text":"the secondary user."}],"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"link","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"withOtherUserToken","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<["},{"kind":"typeIdentifier","text":"ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"kind":"text","text":"], "},{"kind":"typeIdentifier","text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"text":">","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/link(_:withOtherUserToken:)","required":true,"kind":"symbol","role":"symbol","type":"topic"},"https://auth0.com/docs/manage-users/user-accounts/user-account-linking":{"title":"User Account Linking","titleInlineContent":[{"type":"text","text":"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","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"title":"UserInfo","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"UserInfo"}],"abstract":[{"text":"OIDC Standard Claims user information.","type":"text"}],"url":"\/documentation\/auth0\/userinfo","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]},"https://auth0.com/docs/api/management/v2#!/Users/post_identities":{"title":"Management API Endpoint","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/post_identities","titleInlineContent":[{"type":"text","text":"Management API Endpoint"}],"url":"https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/post_identities"}}} \ 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 00908951a..012fe01c2 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 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/link(_:withUser:provider:connectionId:)-6nwr7","interfaceLanguage":"swift"},"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/post_identities","https:\/\/auth0.com\/docs\/manage-users\/user-accounts\/user-account-linking"],"anchor":"Related-Documentation","title":"Related Documentation"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/users\/link(_:withuser:provider:connectionid:)-6nwr7"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"]]},"sections":[],"abstract":[{"text":"Links a user given its identifier with a secondary user given its identifier, provider and connection identifier.","type":"text"}],"metadata":{"externalID":"s:5Auth05UsersPAAE4link_8withUser8provider12connectionIdAA7RequestVySaySDySSypGGAA15ManagementErrorVGSS_S3SSgtF","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"link"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"withUser"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"provider"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connectionId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?) -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<["},{"kind":"typeIdentifier","text":"ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"kind":"text","text":"], "},{"kind":"typeIdentifier","text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"kind":"text","text":">"}],"title":"link(_:withUser:provider:connectionId:)","roleHeading":"Instance Method","modules":[{"name":"Auth0"}],"symbolKind":"method","role":"symbol","extendedModule":"Auth0"},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"link","kind":"identifier"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"identifier","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"withUser","kind":"externalParam"},{"kind":"text","text":" "},{"kind":"internalParam","text":"userId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"provider"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":", ","kind":"text"},{"text":"connectionId","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"? = nil) -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier"},{"text":"<[","kind":"text"},{"text":"ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","kind":"typeIdentifier"},{"text":"], ","kind":"text"},{"text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}]},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"text":"ID of the primary user who will be linked against a secondary one. You can get this value from the ","type":"text"},{"code":"sub","type":"codeVoice"},{"text":" claim of the primary user’s ID token, or from the ","type":"text"},{"code":"sub","type":"codeVoice"},{"text":" property of a ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","type":"reference","isActive":true},{"text":" instance.","type":"text"}],"type":"paragraph"}],"name":"identifier"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"ID of the secondary user. You can get this value from the "},{"type":"codeVoice","code":"sub"},{"type":"text","text":" claim of the secondary user’s ID token, or from the "},{"type":"codeVoice","code":"sub"},{"type":"text","text":" property of a "},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"},{"type":"text","text":" instance."}]}],"name":"userId"},{"content":[{"type":"paragraph","inlineContent":[{"text":"Name of the provider for the secondary user, for example ‘auth0’ for database connections.","type":"text"}]}],"name":"provider"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"ID of the connection for the secondary user."}]}],"name":"connectionId"}]},{"content":[{"anchor":"return-value","type":"heading","text":"Return Value","level":2},{"type":"paragraph","inlineContent":[{"text":"A request to link two users.","type":"text"}]}],"kind":"content"},{"content":[{"type":"heading","anchor":"Usage","text":"Usage","level":2},{"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","type":"aside","name":"Requires","content":[{"inlineContent":[{"type":"text","text":"The token must have the scope "},{"type":"codeVoice","code":"update:users"},{"type":"text","text":"."}],"type":"paragraph"}]}],"kind":"content"}],"schemaVersion":{"minor":3,"major":0,"patch":0},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/Users":{"type":"topic","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Users","kind":"identifier"}],"title":"Users","navigatorTitle":[{"text":"Users","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","url":"\/documentation\/auth0\/users","kind":"symbol","abstract":[{"type":"text","text":"Client for the Users endpoints of the Auth0 "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"type":"text","text":"."}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"type":"topic","url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","kind":"symbol","title":"ManagementError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementObject":{"type":"topic","title":"ManagementObject","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","role":"symbol","kind":"symbol","navigatorTitle":[{"text":"ManagementObject","kind":"identifier"}],"fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ManagementObject","kind":"identifier"}],"url":"\/documentation\/auth0\/managementobject","abstract":[{"text":"A dictionary containing a user profile.","type":"text"}]},"https://auth0.com/docs/api/management/v2#!/Users/post_identities":{"titleInlineContent":[{"type":"text","text":"Management API Endpoint"}],"type":"link","url":"https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/post_identities","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/post_identities","title":"Management API Endpoint"},"https://auth0.com/docs/manage-users/user-accounts/user-account-linking":{"titleInlineContent":[{"text":"User Account Linking","type":"text"}],"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","title":"User Account Linking"},"doc://com.auth0.Auth0/documentation/Auth0/Users/link(_:withUser:provider:connectionId:)-6nwr7":{"kind":"symbol","role":"symbol","type":"topic","title":"link(_:withUser:provider:connectionId:)","url":"\/documentation\/auth0\/users\/link(_:withuser:provider:connectionid:)-6nwr7","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"link","kind":"identifier"},{"text":"(","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"withUser","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"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"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?) -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<[","kind":"text"},{"text":"ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta","kind":"typeIdentifier"},{"text":"], ","kind":"text"},{"text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"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:)-6nwr7"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/request","kind":"symbol","abstract":[{"type":"text","text":"Auth0 API request."}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"text":"UserInfo","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/userinfo","type":"topic","title":"UserInfo","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"https://auth0.com/docs/api/management/v2":{"titleInlineContent":[{"text":"Management API v2","type":"text"}],"type":"link","url":"https:\/\/auth0.com\/docs\/api\/management\/v2","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\/link(_:withuser:provider:connectionid:)-6nwr7"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"]]},"abstract":[{"type":"text","text":"Links a user given its identifier with a secondary user given its identifier, provider and connection identifier."}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"link"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"withUser"},{"kind":"text","text":" "},{"kind":"internalParam","text":"userId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"provider"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connectionId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"? = nil) -> "},{"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","kind":"typeIdentifier","text":"ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"kind":"text","text":"], "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","kind":"typeIdentifier","text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"kind":"text","text":">"}]}],"kind":"declarations"},{"parameters":[{"content":[{"inlineContent":[{"text":"ID of the primary user who will be linked against a secondary one. You can get this value from the ","type":"text"},{"code":"sub","type":"codeVoice"},{"text":" claim of the primary user’s ID token, or from the ","type":"text"},{"code":"sub","type":"codeVoice"},{"text":" property of a ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","isActive":true,"type":"reference"},{"text":" instance.","type":"text"}],"type":"paragraph"}],"name":"identifier"},{"content":[{"inlineContent":[{"text":"ID of the secondary user. You can get this value from the ","type":"text"},{"code":"sub","type":"codeVoice"},{"text":" claim of the secondary user’s ID token, or from the ","type":"text"},{"code":"sub","type":"codeVoice"},{"text":" property of a ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","isActive":true,"type":"reference"},{"text":" instance.","type":"text"}],"type":"paragraph"}],"name":"userId"},{"content":[{"inlineContent":[{"text":"Name of the provider for the secondary user, for example ‘auth0’ for database connections.","type":"text"}],"type":"paragraph"}],"name":"provider"},{"content":[{"inlineContent":[{"text":"ID of the connection for the secondary user.","type":"text"}],"type":"paragraph"}],"name":"connectionId"}],"kind":"parameters"},{"content":[{"level":2,"type":"heading","anchor":"return-value","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A request to link two users."}]}],"kind":"content"},{"content":[{"level":2,"type":"heading","anchor":"Usage","text":"Usage"},{"type":"codeListing","syntax":"swift","code":["Auth0"," .users(token: credentials.accessToken, domain: domain)"," .link(\"primary-user-id\", userId: \"secondary-user-id\", provider: \"auth0\", connectionId: \"connection-id\")"," .start { print($0) }"]},{"type":"aside","content":[{"inlineContent":[{"text":"The token must have the scope ","type":"text"},{"code":"update:users","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"}],"name":"Requires","style":"note"}],"kind":"content"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","sections":[],"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"],"anchor":"Related-Documentation"}],"metadata":{"externalID":"s:5Auth05UsersPAAE4link_8withUser8provider12connectionIdAA7RequestVySaySDySSypGGAA15ManagementErrorVGSS_S3SSgtF","extendedModule":"Auth0","symbolKind":"method","title":"link(_:withUser:provider:connectionId:)","roleHeading":"Instance Method","role":"symbol","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":"withUser"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"provider"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connectionId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<["},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject"},{"kind":"text","text":"], "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError"},{"kind":"text","text":">"}],"modules":[{"name":"Auth0"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/link(_:withUser:provider:connectionId:)-6nwr7","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Request":{"title":"Request","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"abstract":[{"text":"Auth0 API request.","type":"text"}],"url":"\/documentation\/auth0\/request","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementObject":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"ManagementObject"}],"title":"ManagementObject","role":"symbol","fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementObject"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","abstract":[{"text":"A dictionary containing a user profile.","type":"text"}],"url":"\/documentation\/auth0\/managementobject"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Users/link(_:withUser:provider:connectionId:)-6nwr7":{"type":"topic","title":"link(_:withUser:provider:connectionId:)","url":"\/documentation\/auth0\/users\/link(_:withuser:provider:connectionid:)-6nwr7","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/link(_:withUser:provider:connectionId:)-6nwr7","abstract":[{"type":"text","text":"Links a user given its identifier with a secondary user given its identifier, provider and connection identifier."}],"role":"symbol","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":"withUser"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"provider"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connectionId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<["},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject"},{"kind":"text","text":"], "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError"},{"kind":"text","text":">"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"title":"UserInfo","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"UserInfo"}],"abstract":[{"text":"OIDC Standard Claims user information.","type":"text"}],"url":"\/documentation\/auth0\/userinfo","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"title":"ManagementError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}]},"https://auth0.com/docs/api/management/v2":{"title":"Management API v2","url":"https:\/\/auth0.com\/docs\/api\/management\/v2","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","titleInlineContent":[{"type":"text","text":"Management API v2"}]},"https://auth0.com/docs/manage-users/user-accounts/user-account-linking":{"title":"User Account Linking","url":"https:\/\/auth0.com\/docs\/manage-users\/user-accounts\/user-account-linking","type":"link","identifier":"https:\/\/auth0.com\/docs\/manage-users\/user-accounts\/user-account-linking","titleInlineContent":[{"type":"text","text":"User Account Linking"}]},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"url":"\/documentation\/auth0\/users","title":"Users","abstract":[{"type":"text","text":"Client for the Users endpoints of the Auth0 "},{"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","type":"reference","isActive":true},{"text":".","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"Users"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Users"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","role":"symbol","kind":"symbol","type":"topic"},"https://auth0.com/docs/api/management/v2#!/Users/post_identities":{"title":"Management API Endpoint","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":[{"type":"text","text":"Management API Endpoint"}]}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/users/link(_:withuser:provider:connectionid:).json b/docs/data/documentation/auth0/users/link(_:withuser:provider:connectionid:).json index e0e14a9af..6f20a417d 100644 --- a/docs/data/documentation/auth0/users/link(_:withuser:provider:connectionid:).json +++ b/docs/data/documentation/auth0/users/link(_:withuser:provider:connectionid:).json @@ -1 +1 @@ -{"schemaVersion":{"minor":3,"major":0,"patch":0},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"link"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"withUser"},{"kind":"text","text":" "},{"kind":"internalParam","text":"userId"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"provider"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connectionId"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?) -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","text":"Request"},{"kind":"text","text":"<["},{"preciseIdentifier":"s:5Auth016ManagementObjecta","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","text":"ManagementObject"},{"kind":"text","text":"], "},{"preciseIdentifier":"s:5Auth015ManagementErrorV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","text":"ManagementError"},{"kind":"text","text":">"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"},{"parameters":[{"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 "},{"type":"codeVoice","code":"sub"},{"type":"text","text":" claim of the primary 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."}],"type":"paragraph"}],"name":"identifier"},{"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"},{"type":"text","text":" property of a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"},{"type":"text","text":" instance."}],"type":"paragraph"}],"name":"userId"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Name of the provider for the secondary user, for example ‘auth0’ for database connections."}]}],"name":"provider"},{"content":[{"inlineContent":[{"type":"text","text":"ID of the connection for the secondary user."}],"type":"paragraph"}],"name":"connectionId"}],"kind":"parameters"},{"content":[{"anchor":"return-value","level":2,"type":"heading","text":"Return Value"},{"inlineContent":[{"type":"text","text":"A request to link two users."}],"type":"paragraph"}],"kind":"content"},{"content":[{"anchor":"Usage","type":"heading","text":"Usage","level":2},{"syntax":"swift","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) }"]},{"content":[{"type":"paragraph","inlineContent":[{"text":"The token must have the scope ","type":"text"},{"code":"update:users","type":"codeVoice"},{"text":".","type":"text"}]}],"style":"note","name":"Requires","type":"aside"}],"kind":"content"}],"sections":[],"metadata":{"modules":[{"name":"Auth0"}],"required":true,"symbolKind":"method","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"link"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"withUser"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"provider"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connectionId"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?) -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"kind":"text","text":"<["},{"preciseIdentifier":"s:5Auth016ManagementObjecta","kind":"typeIdentifier","text":"ManagementObject"},{"kind":"text","text":"], "},{"preciseIdentifier":"s:5Auth015ManagementErrorV","kind":"typeIdentifier","text":"ManagementError"},{"kind":"text","text":">"}],"title":"link(_:withUser:provider:connectionId:)","role":"symbol","externalID":"s:5Auth05UsersP4link_8withUser8provider12connectionIdAA7RequestVySaySDySSypGGAA15ManagementErrorVGSS_S3SSgtF"},"seeAlsoSections":[{"title":"Related Documentation","anchor":"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."}],"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/link(_:withUser:provider:connectionId:)"},"defaultImplementationsSections":[{"title":"Users Implementations","anchor":"Users-Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/link(_:withUser:provider:connectionId:)-6nwr7"]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/users\/link(_:withuser:provider:connectionid:)"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Users/link(_:withUser:provider:connectionId:)":{"url":"\/documentation\/auth0\/users\/link(_:withuser:provider:connectionid:)","kind":"symbol","abstract":[{"text":"Links a user given its identifier with a secondary user given its identifier, provider and connection identifier.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/link(_:withUser:provider:connectionId:)","title":"link(_:withUser:provider:connectionId:)","defaultImplementations":1,"type":"topic","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"link","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"withUser","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"provider","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"connectionId","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":"<["},{"kind":"typeIdentifier","text":"ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"kind":"text","text":"], "},{"kind":"typeIdentifier","text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"kind":"text","text":">"}],"required":true,"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"type":"topic","url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","kind":"symbol","title":"ManagementError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"text":"UserInfo","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/userinfo","type":"topic","title":"UserInfo","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Users/link(_:withUser:provider:connectionId:)-6nwr7":{"kind":"symbol","role":"symbol","type":"topic","title":"link(_:withUser:provider:connectionId:)","url":"\/documentation\/auth0\/users\/link(_:withuser:provider:connectionid:)-6nwr7","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"link","kind":"identifier"},{"text":"(","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"withUser","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"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"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?) -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<[","kind":"text"},{"text":"ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta","kind":"typeIdentifier"},{"text":"], ","kind":"text"},{"text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"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:)-6nwr7"},"https://auth0.com/docs/api/management/v2#!/Users/post_identities":{"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","titleInlineContent":[{"text":"Management API Endpoint","type":"text"}]},"https://auth0.com/docs/api/management/v2":{"type":"link","url":"https:\/\/auth0.com\/docs\/api\/management\/v2","titleInlineContent":[{"text":"Management API v2","type":"text"}],"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","title":"Management API v2"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"type":"topic","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Users","kind":"identifier"}],"title":"Users","navigatorTitle":[{"text":"Users","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","url":"\/documentation\/auth0\/users","kind":"symbol","abstract":[{"type":"text","text":"Client for the Users endpoints of the Auth0 "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"type":"text","text":"."}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementObject":{"type":"topic","title":"ManagementObject","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","role":"symbol","kind":"symbol","navigatorTitle":[{"text":"ManagementObject","kind":"identifier"}],"fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ManagementObject","kind":"identifier"}],"url":"\/documentation\/auth0\/managementobject","abstract":[{"text":"A dictionary containing a user profile.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/request","kind":"symbol","abstract":[{"type":"text","text":"Auth0 API request."}]},"https://auth0.com/docs/manage-users/user-accounts/user-account-linking":{"identifier":"https:\/\/auth0.com\/docs\/manage-users\/user-accounts\/user-account-linking","url":"https:\/\/auth0.com\/docs\/manage-users\/user-accounts\/user-account-linking","title":"User Account Linking","type":"link","titleInlineContent":[{"text":"User Account Linking","type":"text"}]}}} \ No newline at end of file +{"metadata":{"symbolKind":"method","modules":[{"name":"Auth0"}],"title":"link(_:withUser:provider:connectionId:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"link","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":", "},{"kind":"externalParam","text":"withUser"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"provider"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connectionId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<["},{"kind":"typeIdentifier","text":"ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"kind":"text","text":"], "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError"},{"kind":"text","text":">"}],"externalID":"s:5Auth05UsersP4link_8withUser8provider12connectionIdAA7RequestVySaySDySSypGGAA15ManagementErrorVGSS_S3SSgtF","required":true,"role":"symbol","roleHeading":"Instance Method"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/users\/link(_:withuser:provider:connectionid:)"]}],"defaultImplementationsSections":[{"title":"Users Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/link(_:withUser:provider:connectionId:)-6nwr7"],"anchor":"Users-Implementations"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/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."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"]]},"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"],"anchor":"Related-Documentation"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"link"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"withUser"},{"kind":"text","text":" "},{"kind":"internalParam","text":"userId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"provider"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connectionId"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?) -> "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<["},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","kind":"typeIdentifier","text":"ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"kind":"text","text":"], "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","kind":"typeIdentifier","text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"kind":"text","text":">"}]}]},{"kind":"parameters","parameters":[{"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"},{"type":"text","text":" claim of the primary user’s ID token, or from the "},{"code":"sub","type":"codeVoice"},{"type":"text","text":" property of a "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","isActive":true},{"type":"text","text":" instance."}],"type":"paragraph"}],"name":"identifier"},{"content":[{"type":"paragraph","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"},{"type":"text","text":" property of a "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","type":"reference","isActive":true},{"type":"text","text":" instance."}]}],"name":"userId"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Name of the provider for the secondary user, for example ‘auth0’ for database connections."}]}],"name":"provider"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"ID of the connection for the secondary user."}]}],"name":"connectionId"}]},{"content":[{"type":"heading","text":"Return Value","anchor":"return-value","level":2},{"type":"paragraph","inlineContent":[{"type":"text","text":"A request to link two users."}]}],"kind":"content"},{"content":[{"type":"heading","text":"Usage","anchor":"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","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The token must have the scope "},{"code":"update:users","type":"codeVoice"},{"type":"text","text":"."}]}],"type":"aside","style":"note"}],"kind":"content"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Request":{"title":"Request","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"abstract":[{"text":"Auth0 API request.","type":"text"}],"url":"\/documentation\/auth0\/request","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementObject":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"ManagementObject"}],"title":"ManagementObject","role":"symbol","fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementObject"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","abstract":[{"text":"A dictionary containing a user profile.","type":"text"}],"url":"\/documentation\/auth0\/managementobject"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Users/link(_:withUser:provider:connectionId:)-6nwr7":{"type":"topic","title":"link(_:withUser:provider:connectionId:)","url":"\/documentation\/auth0\/users\/link(_:withuser:provider:connectionid:)-6nwr7","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/link(_:withUser:provider:connectionId:)-6nwr7","abstract":[{"type":"text","text":"Links a user given its identifier with a secondary user given its identifier, provider and connection identifier."}],"role":"symbol","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":"withUser"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"provider"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connectionId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<["},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject"},{"kind":"text","text":"], "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError"},{"kind":"text","text":">"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"title":"UserInfo","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"UserInfo"}],"abstract":[{"text":"OIDC Standard Claims user information.","type":"text"}],"url":"\/documentation\/auth0\/userinfo","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"title":"ManagementError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}]},"https://auth0.com/docs/api/management/v2":{"type":"link","titleInlineContent":[{"type":"text","text":"Management API v2"}],"url":"https:\/\/auth0.com\/docs\/api\/management\/v2","title":"Management API v2","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},"doc://com.auth0.Auth0/documentation/Auth0/Users/link(_:withUser:provider:connectionId:)":{"defaultImplementations":1,"type":"topic","title":"link(_:withUser:provider:connectionId:)","url":"\/documentation\/auth0\/users\/link(_:withuser:provider:connectionid:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/link(_:withUser:provider:connectionId:)","abstract":[{"type":"text","text":"Links a user given its identifier with a secondary user given its identifier, provider and connection identifier."}],"required":true,"role":"symbol","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":"withUser"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"provider"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"connectionId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<["},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject"},{"kind":"text","text":"], "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError"},{"kind":"text","text":">"}]},"https://auth0.com/docs/manage-users/user-accounts/user-account-linking":{"type":"link","titleInlineContent":[{"type":"text","text":"User Account Linking"}],"url":"https:\/\/auth0.com\/docs\/manage-users\/user-accounts\/user-account-linking","title":"User Account Linking","identifier":"https:\/\/auth0.com\/docs\/manage-users\/user-accounts\/user-account-linking"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"url":"\/documentation\/auth0\/users","title":"Users","abstract":[{"type":"text","text":"Client for the Users endpoints of the Auth0 "},{"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","type":"reference","isActive":true},{"text":".","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"Users"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Users"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","role":"symbol","kind":"symbol","type":"topic"},"https://auth0.com/docs/api/management/v2#!/Users/post_identities":{"type":"link","titleInlineContent":[{"type":"text","text":"Management API Endpoint"}],"url":"https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/post_identities","title":"Management API Endpoint","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/post_identities"}}} \ 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 29617f1c8..64c7e1aff 100644 --- a/docs/data/documentation/auth0/users/patch(_:attributes:).json +++ b/docs/data/documentation/auth0/users/patch(_:attributes:).json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"patch"},{"kind":"text","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":"attributes","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"UserPatchAttributes","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC"},{"text":") -> ","kind":"text"},{"text":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<","kind":"text"},{"text":"ManagementObject","kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject"},{"text":", ","kind":"text"},{"text":"ManagementError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"},{"text":">","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]},{"parameters":[{"name":"identifier","content":[{"inlineContent":[{"type":"text","text":"ID of the user to update. You can get this value from the "},{"type":"codeVoice","code":"sub"},{"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","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"},{"type":"text","text":" instance."}],"type":"paragraph"}]},{"name":"attributes","content":[{"inlineContent":[{"text":"Root attributes to be updated.","type":"text"}],"type":"paragraph"}]}],"kind":"parameters"},{"kind":"content","content":[{"anchor":"return-value","text":"Return Value","type":"heading","level":2},{"type":"paragraph","inlineContent":[{"text":"A request that will yield the updated user.","type":"text"}]}]},{"kind":"content","content":[{"type":"heading","anchor":"Usage","level":2,"text":"Usage"},{"inlineContent":[{"type":"text","text":"For example, if you need to change the "},{"type":"codeVoice","code":"email"},{"type":"text","text":":"}],"type":"paragraph"},{"syntax":"swift","code":["let attributes = UserPatchAttributes().email(\"new.email@auth0.com\","," connection: \"Username-Password-Authentication\","," clientId: clientId)"],"type":"codeListing"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Or, if you need to change the "},{"code":"user_metadata","type":"codeVoice"},{"type":"text","text":":"}]},{"type":"codeListing","syntax":"swift","code":["let attributes = UserPatchAttributes().userMetadata([\"first_name\": \"John\", \"last_name\": \"Appleseed\"])"]},{"type":"paragraph","inlineContent":[{"text":"You can even chain several changes together:","type":"text"}]},{"type":"codeListing","syntax":"swift","code":["let attributes = UserPatchAttributes()"," .email(\"new.email@auth0.com\","," verify: true, "," connection: \"Username-Password-Authentication\", "," clientId: clientId)"," .userMetadata([\"first_name\": \"John\", \"last_name\": \"Appleseed\"])"," .appMetadata([\"role\": \"admin\"])"]},{"type":"paragraph","inlineContent":[{"text":"Then, just pass the ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","type":"reference","isActive":true},{"text":" to the patch method:","type":"text"}]},{"type":"codeListing","syntax":"swift","code":["Auth0"," .users(token: credentials.accessToken, domain: domain)"," .patch(\"user-id\", attributes: attributes)"," .start { print($0) }"]},{"type":"aside","content":[{"inlineContent":[{"text":"The token must have one of the following scopes: ","type":"text"},{"code":"update:users","type":"codeVoice"},{"text":", ","type":"text"},{"code":"update:users_app_metadata","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"}],"style":"note","name":"Requires"}]}],"seeAlsoSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/patch_users_by_id"],"title":"Related Documentation","anchor":"Related-Documentation"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/users\/patch(_:attributes:)"]}],"sections":[],"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"]]},"metadata":{"modules":[{"name":"Auth0"}],"symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"patch","kind":"identifier"},{"text":"(","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"attributes","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"platforms":[{"beta":false,"deprecated":true,"message":"This operation can no longer be performed from native apps for security reasons","unavailable":false}],"role":"symbol","title":"patch(_:attributes:)","required":true,"roleHeading":"Instance Method","externalID":"s:5Auth05UsersP5patch_10attributesAA7RequestVySDySSypGAA15ManagementErrorVGSS_AA19UserPatchAttributesCtF"},"abstract":[{"type":"text","text":"Updates a user’s root values (those which are allowed to be updated)."}],"deprecationSummary":[{"type":"paragraph","inlineContent":[{"type":"text","text":"This operation can no longer be performed from native apps for security reasons"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"required":true,"kind":"symbol","url":"\/documentation\/auth0\/users\/patch(_:attributes:)","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"patch"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"attributes"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","kind":"typeIdentifier","text":"UserPatchAttributes"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError"},{"kind":"text","text":">"}],"deprecated":true,"title":"patch(_:attributes:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","abstract":[{"type":"text","text":"Updates a user’s root values (those which are allowed to be updated)."}],"type":"topic"},"https://auth0.com/docs/api/management/v2":{"type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","url":"https:\/\/auth0.com\/docs\/api\/management\/v2","title":"Management API v2","titleInlineContent":[{"type":"text","text":"Management API v2"}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementObject":{"type":"topic","title":"ManagementObject","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","role":"symbol","kind":"symbol","navigatorTitle":[{"text":"ManagementObject","kind":"identifier"}],"fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ManagementObject","kind":"identifier"}],"url":"\/documentation\/auth0\/managementobject","abstract":[{"text":"A dictionary containing a user profile.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"text":"UserInfo","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/userinfo","type":"topic","title":"UserInfo","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes":{"url":"\/documentation\/auth0\/userpatchattributes","kind":"symbol","role":"symbol","fragments":[{"text":"class","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserPatchAttributes","kind":"identifier"}],"navigatorTitle":[{"text":"UserPatchAttributes","kind":"identifier"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","title":"UserPatchAttributes","abstract":[{"type":"text","text":"User attributes that can be updated using the "},{"type":"reference","isActive":true,"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"},{"type":"text","text":"."}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"type":"topic","url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","kind":"symbol","title":"ManagementError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}]},"https://auth0.com/docs/api/management/v2#!/Users/patch_users_by_id":{"type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/patch_users_by_id","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/Users":{"type":"topic","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Users","kind":"identifier"}],"title":"Users","navigatorTitle":[{"text":"Users","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","url":"\/documentation\/auth0\/users","kind":"symbol","abstract":[{"type":"text","text":"Client for the Users endpoints of the Auth0 "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"type":"text","text":"."}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/request","kind":"symbol","abstract":[{"type":"text","text":"Auth0 API request."}]}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"]]},"metadata":{"platforms":[{"message":"This operation can no longer be performed from native apps for security reasons","unavailable":false,"deprecated":true,"beta":false}],"symbolKind":"method","modules":[{"name":"Auth0"}],"title":"patch(_:attributes:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"patch","kind":"identifier"},{"text":"(","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"attributes","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"UserPatchAttributes","preciseIdentifier":"s:5Auth019UserPatchAttributesC","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"externalID":"s:5Auth05UsersP5patch_10attributesAA7RequestVySDySSypGAA15ManagementErrorVGSS_AA19UserPatchAttributesCtF","role":"symbol","required":true,"roleHeading":"Instance Method"},"sections":[],"abstract":[{"text":"Updates a user’s root values (those which are allowed to be updated).","type":"text"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/users\/patch(_:attributes:)"]}],"deprecationSummary":[{"inlineContent":[{"text":"This operation can no longer be performed from native apps for security reasons","type":"text"}],"type":"paragraph"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","interfaceLanguage":"swift"},"seeAlsoSections":[{"anchor":"Related-Documentation","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},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"patch"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"attributes"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth019UserPatchAttributesC","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","kind":"typeIdentifier","text":"UserPatchAttributes"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07RequestV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","kind":"typeIdentifier","text":"Request"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:5Auth016ManagementObjecta","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","kind":"typeIdentifier","text":"ManagementObject"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth015ManagementErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","kind":"typeIdentifier","text":"ManagementError"},{"kind":"text","text":">"}],"languages":["swift"],"platforms":["iOS"]}]},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"text":"ID of the user to update. You can get this value from the ","type":"text"},{"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,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","type":"reference"},{"text":" instance.","type":"text"}],"type":"paragraph"}],"name":"identifier"},{"content":[{"inlineContent":[{"text":"Root attributes to be updated.","type":"text"}],"type":"paragraph"}],"name":"attributes"}]},{"content":[{"level":2,"anchor":"return-value","text":"Return Value","type":"heading"},{"inlineContent":[{"type":"text","text":"A request that will yield the updated user."}],"type":"paragraph"}],"kind":"content"},{"content":[{"level":2,"anchor":"Usage","text":"Usage","type":"heading"},{"inlineContent":[{"type":"text","text":"For example, if you need to change the "},{"code":"email","type":"codeVoice"},{"type":"text","text":":"}],"type":"paragraph"},{"syntax":"swift","code":["let attributes = UserPatchAttributes().email(\"new.email@auth0.com\","," connection: \"Username-Password-Authentication\","," clientId: clientId)"],"type":"codeListing"},{"inlineContent":[{"type":"text","text":"Or, if you need to change the "},{"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"},{"inlineContent":[{"type":"text","text":"You can even chain several changes together:"}],"type":"paragraph"},{"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"},{"inlineContent":[{"type":"text","text":"Then, just pass the "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","isActive":true},{"type":"text","text":" to the patch method:"}],"type":"paragraph"},{"syntax":"swift","code":["Auth0"," .users(token: credentials.accessToken, domain: domain)"," .patch(\"user-id\", attributes: attributes)"," .start { print($0) }"],"type":"codeListing"},{"content":[{"inlineContent":[{"text":"The token must have one of the following scopes: ","type":"text"},{"code":"update:users","type":"codeVoice"},{"text":", ","type":"text"},{"code":"update:users_app_metadata","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"}],"style":"note","name":"Requires","type":"aside"}],"kind":"content"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Request":{"title":"Request","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"abstract":[{"text":"Auth0 API request.","type":"text"}],"url":"\/documentation\/auth0\/request","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementObject":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"ManagementObject"}],"title":"ManagementObject","role":"symbol","fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementObject"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","abstract":[{"text":"A dictionary containing a user profile.","type":"text"}],"url":"\/documentation\/auth0\/managementobject"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"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","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},"doc://com.auth0.Auth0/documentation/Auth0/UserPatchAttributes":{"title":"UserPatchAttributes","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserPatchAttributes","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"UserPatchAttributes"}],"abstract":[{"text":"User attributes that can be updated using the ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","isActive":true,"type":"reference"},{"text":" method of ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","isActive":true,"type":"reference"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/userpatchattributes","navigatorTitle":[{"kind":"identifier","text":"UserPatchAttributes"}]},"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:attributes:)":{"role":"symbol","title":"patch(_:attributes:)","deprecated":true,"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"patch","kind":"identifier"},{"text":"(","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"attributes","kind":"externalParam"},{"kind":"text","text":": "},{"text":"UserPatchAttributes","kind":"typeIdentifier","preciseIdentifier":"s:5Auth019UserPatchAttributesC"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError","kind":"typeIdentifier"},{"kind":"text","text":">"}],"abstract":[{"type":"text","text":"Updates a user’s root values (those which are allowed to be updated)."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:attributes:)","url":"\/documentation\/auth0\/users\/patch(_:attributes:)","required":true,"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"title":"ManagementError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"title":"UserInfo","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"UserInfo"}],"abstract":[{"text":"OIDC Standard Claims user information.","type":"text"}],"url":"\/documentation\/auth0\/userinfo","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"url":"\/documentation\/auth0\/users","title":"Users","abstract":[{"type":"text","text":"Client for the Users endpoints of the Auth0 "},{"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","type":"reference","isActive":true},{"text":".","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"Users"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Users"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","role":"symbol","kind":"symbol","type":"topic"},"https://auth0.com/docs/api/management/v2#!/Users/patch_users_by_id":{"type":"link","titleInlineContent":[{"text":"Management API Endpoint","type":"text"}],"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"}}} \ 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 b65de84f6..a3be60898 100644 --- a/docs/data/documentation/auth0/users/patch(_:usermetadata:).json +++ b/docs/data/documentation/auth0/users/patch(_:usermetadata:).json @@ -1 +1 @@ -{"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"]]},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"patch"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"userMetadata"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]) -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError"},{"kind":"text","text":">"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"},{"parameters":[{"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"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","type":"reference","isActive":true},{"text":" instance.","type":"text"}],"type":"paragraph"}],"name":"identifier"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Metadata to update."}]}],"name":"userMetadata"}],"kind":"parameters"},{"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"}],"kind":"content"},{"content":[{"type":"heading","level":2,"anchor":"Usage","text":"Usage"},{"type":"codeListing","syntax":"swift","code":["Auth0"," .users(token: credentials.accessToken, domain: domain)"," .patch(\"user-id\", userMetadata: [\"first_name\": \"John\", \"last_name\": \"Appleseed\"])"," .start { print($0) }"]},{"type":"aside","style":"note","name":"Requires","content":[{"inlineContent":[{"type":"text","text":"The token must have the "},{"type":"codeVoice","code":"update:current_user_metadata"},{"type":"text","text":" scope."}],"type":"paragraph"}]}],"kind":"content"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/users\/patch(_:usermetadata:)"]}],"abstract":[{"type":"text","text":"Updates only the user’s "},{"code":"user_metadata","type":"codeVoice"},{"type":"text","text":" field."}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:userMetadata:)","interfaceLanguage":"swift"},"metadata":{"required":true,"roleHeading":"Instance Method","externalID":"s:5Auth05UsersP5patch_12userMetadataAA7RequestVySDySSypGAA15ManagementErrorVGSS_AHtF","symbolKind":"method","title":"patch(_:userMetadata:)","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"patch"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"userMetadata"},{"kind":"text","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"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:5Auth016ManagementObjecta","kind":"typeIdentifier","text":"ManagementObject"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth015ManagementErrorV","kind":"typeIdentifier","text":"ManagementError"},{"kind":"text","text":">"}],"role":"symbol"},"schemaVersion":{"minor":3,"patch":0,"major":0},"sections":[],"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/patch_users_by_id"],"anchor":"Related-Documentation","title":"Related Documentation"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:userMetadata:)":{"title":"patch(_:userMetadata:)","abstract":[{"type":"text","text":"Updates only the user’s "},{"type":"codeVoice","code":"user_metadata"},{"type":"text","text":" field."}],"type":"topic","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:userMetadata:)","url":"\/documentation\/auth0\/users\/patch(_:usermetadata:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"patch","kind":"identifier"},{"text":"(","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"userMetadata","kind":"externalParam"},{"text":": [","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"]) -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"required":true,"kind":"symbol"},"https://auth0.com/docs/api/management/v2":{"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","type":"link","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":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"text":"UserInfo","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/userinfo","type":"topic","title":"UserInfo","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"type":"topic","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Users","kind":"identifier"}],"title":"Users","navigatorTitle":[{"text":"Users","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","url":"\/documentation\/auth0\/users","kind":"symbol","abstract":[{"type":"text","text":"Client for the Users endpoints of the Auth0 "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"type":"text","text":"."}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementObject":{"type":"topic","title":"ManagementObject","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","role":"symbol","kind":"symbol","navigatorTitle":[{"text":"ManagementObject","kind":"identifier"}],"fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ManagementObject","kind":"identifier"}],"url":"\/documentation\/auth0\/managementobject","abstract":[{"text":"A dictionary containing a user profile.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"type":"topic","url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","kind":"symbol","title":"ManagementError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}]},"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","type":"link","titleInlineContent":[{"type":"text","text":"Management API Endpoint"}],"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/patch_users_by_id"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/request","kind":"symbol","abstract":[{"type":"text","text":"Auth0 API request."}]}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/users\/patch(_:usermetadata:)"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"]]},"abstract":[{"text":"Updates only the user’s ","type":"text"},{"code":"user_metadata","type":"codeVoice"},{"text":" field.","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"patch","kind":"identifier"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"identifier","kind":"internalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"userMetadata","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"]) -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","text":"Request","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:5Auth016ManagementObjecta","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","text":"ManagementObject","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth015ManagementErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","text":"ManagementError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"platforms":["iOS"]}]},{"parameters":[{"content":[{"inlineContent":[{"text":"ID of the user to update. You can get this value from the ","type":"text"},{"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,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","type":"reference"},{"text":" instance.","type":"text"}],"type":"paragraph"}],"name":"identifier"},{"content":[{"inlineContent":[{"text":"Metadata to update.","type":"text"}],"type":"paragraph"}],"name":"userMetadata"}],"kind":"parameters"},{"kind":"content","content":[{"text":"Return Value","level":2,"type":"heading","anchor":"return-value"},{"inlineContent":[{"type":"text","text":"A request that will yield the updated user."}],"type":"paragraph"}]},{"kind":"content","content":[{"text":"Usage","level":2,"type":"heading","anchor":"Usage"},{"syntax":"swift","code":["Auth0"," .users(token: credentials.accessToken, domain: domain)"," .patch(\"user-id\", userMetadata: [\"first_name\": \"John\", \"last_name\": \"Appleseed\"])"," .start { print($0) }"],"type":"codeListing"},{"content":[{"inlineContent":[{"text":"The token must have the ","type":"text"},{"code":"update:current_user_metadata","type":"codeVoice"},{"text":" scope.","type":"text"}],"type":"paragraph"}],"style":"note","name":"Requires","type":"aside"}]}],"kind":"symbol","schemaVersion":{"patch":0,"minor":3,"major":0},"sections":[],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/patch_users_by_id"],"anchor":"Related-Documentation"}],"metadata":{"symbolKind":"method","title":"patch(_:userMetadata:)","externalID":"s:5Auth05UsersP5patch_12userMetadataAA7RequestVySDySSypGAA15ManagementErrorVGSS_AHtF","roleHeading":"Instance Method","modules":[{"name":"Auth0"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"patch","kind":"identifier"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"userMetadata"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]) -> "},{"kind":"typeIdentifier","text":"Request","preciseIdentifier":"s:5Auth07RequestV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"kind":"text","text":">"}],"role":"symbol","required":true},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:userMetadata:)","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Users/patch(_:userMetadata:)":{"role":"symbol","title":"patch(_:userMetadata:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"patch"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"userMetadata"},{"kind":"text","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"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:5Auth016ManagementObjecta","kind":"typeIdentifier","text":"ManagementObject"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth015ManagementErrorV","kind":"typeIdentifier","text":"ManagementError"},{"kind":"text","text":">"}],"abstract":[{"type":"text","text":"Updates only the user’s "},{"type":"codeVoice","code":"user_metadata"},{"type":"text","text":" field."}],"kind":"symbol","url":"\/documentation\/auth0\/users\/patch(_:usermetadata:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/patch(_:userMetadata:)","required":true,"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"url":"\/documentation\/auth0\/users","title":"Users","abstract":[{"type":"text","text":"Client for the Users endpoints of the Auth0 "},{"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","type":"reference","isActive":true},{"text":".","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"Users"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Users"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","role":"symbol","kind":"symbol","type":"topic"},"https://auth0.com/docs/api/management/v2#!/Users/patch_users_by_id":{"title":"Management API Endpoint","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/patch_users_by_id","titleInlineContent":[{"text":"Management API Endpoint","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/patch_users_by_id"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementObject":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"ManagementObject"}],"title":"ManagementObject","role":"symbol","fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementObject"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","abstract":[{"text":"A dictionary containing a user profile.","type":"text"}],"url":"\/documentation\/auth0\/managementobject"},"https://auth0.com/docs/api/management/v2":{"title":"Management API v2","type":"link","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","titleInlineContent":[{"text":"Management API v2","type":"text"}],"url":"https:\/\/auth0.com\/docs\/api\/management\/v2"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"title":"Request","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"abstract":[{"text":"Auth0 API request.","type":"text"}],"url":"\/documentation\/auth0\/request","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"title":"UserInfo","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"UserInfo"}],"abstract":[{"text":"OIDC Standard Claims user information.","type":"text"}],"url":"\/documentation\/auth0\/userinfo","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"title":"ManagementError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}]}}} \ 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 119b74790..18e10ca81 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."}],"schemaVersion":{"minor":3,"major":0,"patch":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/users\/token"]}],"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"token","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"platforms":["iOS"]}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/token"},"metadata":{"modules":[{"name":"Auth0"}],"required":true,"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"token"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"roleHeading":"Instance Property","externalID":"s:5Auth05UsersP5tokenSSvp","symbolKind":"property","title":"token","role":"symbol"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"]]},"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Users":{"type":"topic","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Users","kind":"identifier"}],"title":"Users","navigatorTitle":[{"text":"Users","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","url":"\/documentation\/auth0\/users","kind":"symbol","abstract":[{"type":"text","text":"Client for the Users endpoints of the Auth0 "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"type":"text","text":"."}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Users/token":{"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"token","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"kind":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/token","url":"\/documentation\/auth0\/users\/token","abstract":[{"type":"text","text":"The Management API token."}],"required":true,"role":"symbol","title":"token"},"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"}],"url":"https:\/\/auth0.com\/docs\/api\/management\/v2"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"token"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"platforms":["iOS"]}]}],"sections":[],"abstract":[{"text":"The Management API token.","type":"text"}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/users\/token"]}],"metadata":{"role":"symbol","modules":[{"name":"Auth0"}],"title":"token","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"token","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"externalID":"s:5Auth05UsersP5tokenSSvp","roleHeading":"Instance Property","required":true,"symbolKind":"property"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/token"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"https://auth0.com/docs/api/management/v2":{"type":"link","titleInlineContent":[{"type":"text","text":"Management API v2"}],"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","title":"Management API v2","url":"https:\/\/auth0.com\/docs\/api\/management\/v2"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"url":"\/documentation\/auth0\/users","title":"Users","abstract":[{"type":"text","text":"Client for the Users endpoints of the Auth0 "},{"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","type":"reference","isActive":true},{"text":".","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"Users"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Users"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Users/token":{"role":"symbol","title":"token","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"token"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"abstract":[{"type":"text","text":"The Management API token."}],"kind":"symbol","url":"\/documentation\/auth0\/users\/token","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/token","required":true,"type":"topic"}}} \ 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 0a1794a9a..e85f155c4 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 @@ -{"abstract":[{"type":"text","text":"Removes an identity from a user."}],"kind":"symbol","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","anchor":"Related-Documentation"}],"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"unlink","kind":"identifier"},{"text":"(","kind":"text"},{"text":"identityId","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"provider","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"fromUserId","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"identifier","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Request","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<[","kind":"text"},{"text":"ManagementObject","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta","kind":"typeIdentifier"},{"text":"], ","kind":"text"},{"text":"ManagementError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]},{"kind":"parameters","parameters":[{"name":"identityId","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"ID of the identity to remove."}]}]},{"name":"provider","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Name of the identity provider."}]}]},{"name":"identifier","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"},{"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"}]}]}]},{"kind":"content","content":[{"level":2,"type":"heading","text":"Return Value","anchor":"return-value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A request to remove an identity."}]}]},{"kind":"content","content":[{"anchor":"Usage","text":"Usage","type":"heading","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"},{"name":"Requires","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The token must have the scope "},{"type":"codeVoice","code":"update:users"},{"type":"text","text":"."}]}],"type":"aside","style":"note"}]}],"variants":[{"paths":["\/documentation\/auth0\/users\/unlink(identityid:provider:fromuserid:)"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"unlink","kind":"identifier"},{"text":"(","kind":"text"},{"text":"identityId","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"provider","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"fromUserId","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"Request","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV"},{"text":"<[","kind":"text"},{"text":"ManagementObject","kind":"typeIdentifier","preciseIdentifier":"s:5Auth016ManagementObjecta"},{"text":"], ","kind":"text"},{"text":"ManagementError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth015ManagementErrorV"},{"text":">","kind":"text"}],"externalID":"s:5Auth05UsersP6unlink10identityId8provider08fromUserE0AA7RequestVySaySDySSypGGAA15ManagementErrorVGSS_S2StF","role":"symbol","required":true,"symbolKind":"method","title":"unlink(identityId:provider:fromUserId:)","roleHeading":"Instance Method","modules":[{"name":"Auth0"}]},"schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/unlink(identityId:provider:fromUserId:)","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"type":"topic","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Users","kind":"identifier"}],"title":"Users","navigatorTitle":[{"text":"Users","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","url":"\/documentation\/auth0\/users","kind":"symbol","abstract":[{"type":"text","text":"Client for the Users endpoints of the Auth0 "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"type":"text","text":"."}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"type":"topic","url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","kind":"symbol","title":"ManagementError","abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}]},"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"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","title":"Request","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Request","kind":"identifier"}],"navigatorTitle":[{"text":"Request","kind":"identifier"}],"role":"symbol","type":"topic","url":"\/documentation\/auth0\/request","kind":"symbol","abstract":[{"type":"text","text":"Auth0 API request."}]},"doc://com.auth0.Auth0/documentation/Auth0/ManagementObject":{"type":"topic","title":"ManagementObject","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","role":"symbol","kind":"symbol","navigatorTitle":[{"text":"ManagementObject","kind":"identifier"}],"fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ManagementObject","kind":"identifier"}],"url":"\/documentation\/auth0\/managementobject","abstract":[{"text":"A dictionary containing a user profile.","type":"text"}]},"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"}],"url":"https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/delete_user_identity_by_user_id"},"doc://com.auth0.Auth0/documentation/Auth0/Users/unlink(identityId:provider:fromUserId:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/unlink(identityId:provider:fromUserId:)","url":"\/documentation\/auth0\/users\/unlink(identityid:provider:fromuserid:)","kind":"symbol","abstract":[{"type":"text","text":"Removes an identity from a user."}],"title":"unlink(identityId:provider:fromUserId:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"unlink","kind":"identifier"},{"text":"(","kind":"text"},{"text":"identityId","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"provider","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"fromUserId","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Request","preciseIdentifier":"s:5Auth07RequestV","kind":"typeIdentifier"},{"text":"<[","kind":"text"},{"text":"ManagementObject","preciseIdentifier":"s:5Auth016ManagementObjecta","kind":"typeIdentifier"},{"text":"], ","kind":"text"},{"text":"ManagementError","preciseIdentifier":"s:5Auth015ManagementErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"required":true,"role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserInfo","kind":"identifier"}],"navigatorTitle":[{"text":"UserInfo","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/auth0\/userinfo","type":"topic","title":"UserInfo","abstract":[{"type":"text","text":"OIDC Standard Claims user information."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo"},"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"}}} \ No newline at end of file +{"abstract":[{"type":"text","text":"Removes an identity from a user."}],"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"],"anchor":"Related-Documentation","title":"Related Documentation"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"unlink","kind":"identifier"},{"text":"(","kind":"text"},{"text":"identityId","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"provider","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"fromUserId","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"identifier","kind":"internalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","text":"Request","kind":"typeIdentifier"},{"text":"<[","kind":"text"},{"preciseIdentifier":"s:5Auth016ManagementObjecta","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","text":"ManagementObject","kind":"typeIdentifier"},{"text":"], ","kind":"text"},{"preciseIdentifier":"s:5Auth015ManagementErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","text":"ManagementError","kind":"typeIdentifier"},{"text":">","kind":"text"}]}]},{"parameters":[{"name":"identityId","content":[{"inlineContent":[{"text":"ID of the identity to remove.","type":"text"}],"type":"paragraph"}]},{"name":"provider","content":[{"inlineContent":[{"text":"Name of the identity provider.","type":"text"}],"type":"paragraph"}]},{"name":"identifier","content":[{"inlineContent":[{"text":"ID of the user who owns the identity. You can get this value from the ","type":"text"},{"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"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","isActive":true,"type":"reference"},{"text":" instance.","type":"text"}],"type":"paragraph"}]}],"kind":"parameters"},{"kind":"content","content":[{"type":"heading","level":2,"anchor":"return-value","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A request to remove an identity."}]}]},{"kind":"content","content":[{"type":"heading","level":2,"anchor":"Usage","text":"Usage"},{"syntax":"swift","type":"codeListing","code":["Auth0"," .users(token: credentials.accessToken, domain: domain)"," .unlink(identityId: \"identity-id\", provider: \"github\", fromUserId: \"user-id\")"," .start { print($0) }"]},{"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"}],"style":"note"}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/users\/unlink(identityid:provider:fromuserid:)"]}],"schemaVersion":{"patch":0,"minor":3,"major":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"]]},"metadata":{"modules":[{"name":"Auth0"}],"title":"unlink(identityId:provider:fromUserId:)","roleHeading":"Instance Method","symbolKind":"method","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"unlink"},{"text":"(","kind":"text"},{"text":"identityId","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"provider"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"fromUserId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07RequestV","text":"Request"},{"text":"<[","kind":"text"},{"preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject","kind":"typeIdentifier"},{"text":"], ","kind":"text"},{"preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"required":true,"externalID":"s:5Auth05UsersP6unlink10identityId8provider08fromUserE0AA7RequestVySaySDySSypGGAA15ManagementErrorVGSS_S2StF"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/unlink(identityId:provider:fromUserId:)","interfaceLanguage":"swift"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/ManagementObject":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"ManagementObject"}],"title":"ManagementObject","role":"symbol","fragments":[{"text":"typealias","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementObject"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementObject","abstract":[{"text":"A dictionary containing a user profile.","type":"text"}],"url":"\/documentation\/auth0\/managementobject"},"doc://com.auth0.Auth0/documentation/Auth0/Users/unlink(identityId:provider:fromUserId:)":{"url":"\/documentation\/auth0\/users\/unlink(identityid:provider:fromuserid:)","required":true,"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"unlink","kind":"identifier"},{"text":"(","kind":"text"},{"text":"identityId","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"provider","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"fromUserId","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07RequestV","text":"Request","kind":"typeIdentifier"},{"text":"<[","kind":"text"},{"preciseIdentifier":"s:5Auth016ManagementObjecta","text":"ManagementObject","kind":"typeIdentifier"},{"text":"], ","kind":"text"},{"preciseIdentifier":"s:5Auth015ManagementErrorV","text":"ManagementError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"title":"unlink(identityId:provider:fromUserId:)","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Removes an identity from a user."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/unlink(identityId:provider:fromUserId:)","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"url":"\/documentation\/auth0\/users","title":"Users","abstract":[{"type":"text","text":"Client for the Users endpoints of the Auth0 "},{"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","type":"reference","isActive":true},{"text":".","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"Users"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Users"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Request":{"title":"Request","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Request","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Request"}],"abstract":[{"text":"Auth0 API request.","type":"text"}],"url":"\/documentation\/auth0\/request","navigatorTitle":[{"kind":"identifier","text":"Request"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserInfo":{"title":"UserInfo","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserInfo","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"UserInfo"}],"abstract":[{"text":"OIDC Standard Claims user information.","type":"text"}],"url":"\/documentation\/auth0\/userinfo","navigatorTitle":[{"kind":"identifier","text":"UserInfo"}]},"https://auth0.com/docs/manage-users/user-accounts/user-account-linking":{"type":"link","titleInlineContent":[{"type":"text","text":"User Account Linking"}],"identifier":"https:\/\/auth0.com\/docs\/manage-users\/user-accounts\/user-account-linking","title":"User Account Linking","url":"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":{"type":"link","titleInlineContent":[{"type":"text","text":"Management API Endpoint"}],"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/delete_user_identity_by_user_id","title":"Management API Endpoint","url":"https:\/\/auth0.com\/docs\/api\/management\/v2#!\/Users\/delete_user_identity_by_user_id"},"https://auth0.com/docs/api/management/v2":{"type":"link","titleInlineContent":[{"type":"text","text":"Management API v2"}],"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","title":"Management API v2","url":"https:\/\/auth0.com\/docs\/api\/management\/v2"},"doc://com.auth0.Auth0/documentation/Auth0/ManagementError":{"title":"ManagementError","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/ManagementError","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ManagementError"}],"abstract":[{"type":"text","text":"Represents an error during a request to the Auth0 Management API v2."}],"url":"\/documentation\/auth0\/managementerror","navigatorTitle":[{"kind":"identifier","text":"ManagementError"}]}}} \ 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 8101e54f8..4c7d73de2 100644 --- a/docs/data/documentation/auth0/users/url.json +++ b/docs/data/documentation/auth0/users/url.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"]]},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"url","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation3URLV","text":"URL","kind":"typeIdentifier"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}]}],"kind":"declarations"}],"variants":[{"paths":["\/documentation\/auth0\/users\/url"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"abstract":[{"text":"The Auth0 Domain URL.","type":"text"}],"metadata":{"role":"symbol","title":"url","roleHeading":"Instance Property","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"url","kind":"identifier"},{"text":": ","kind":"text"},{"text":"URL","preciseIdentifier":"s:10Foundation3URLV","kind":"typeIdentifier"}],"required":true,"externalID":"s:5Auth05UsersP3url10Foundation3URLVvp","modules":[{"name":"Auth0"}],"symbolKind":"property"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/url","interfaceLanguage":"swift"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Users/url":{"type":"topic","role":"symbol","kind":"symbol","title":"url","abstract":[{"type":"text","text":"The Auth0 Domain URL."}],"required":true,"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"url"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV","text":"URL"}],"url":"\/documentation\/auth0\/users\/url","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/url"},"https://auth0.com/docs/api/management/v2":{"title":"Management API v2","url":"https:\/\/auth0.com\/docs\/api\/management\/v2","type":"link","titleInlineContent":[{"type":"text","text":"Management API v2"}],"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},"doc://com.auth0.Auth0/documentation/Auth0/Users":{"type":"topic","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Users","kind":"identifier"}],"title":"Users","navigatorTitle":[{"text":"Users","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","url":"\/documentation\/auth0\/users","kind":"symbol","abstract":[{"type":"text","text":"Client for the Users endpoints of the Auth0 "},{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2"},{"type":"text","text":"."}],"role":"symbol"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users"]]},"metadata":{"modules":[{"name":"Auth0"}],"title":"url","externalID":"s:5Auth05UsersP3url10Foundation3URLVvp","role":"symbol","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","symbolKind":"property","required":true},"sections":[],"abstract":[{"type":"text","text":"The Auth0 Domain URL."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/users\/url"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/url"},"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"url","kind":"identifier"},{"text":": ","kind":"text"},{"text":"URL","preciseIdentifier":"s:10Foundation3URLV","kind":"typeIdentifier"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"platforms":["iOS"]}],"kind":"declarations"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Users":{"url":"\/documentation\/auth0\/users","title":"Users","abstract":[{"type":"text","text":"Client for the Users endpoints of the Auth0 "},{"identifier":"https:\/\/auth0.com\/docs\/api\/management\/v2","type":"reference","isActive":true},{"text":".","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"Users"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Users"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users","role":"symbol","kind":"symbol","type":"topic"},"https://auth0.com/docs/api/management/v2":{"title":"Management API 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"},"doc://com.auth0.Auth0/documentation/Auth0/Users/url":{"kind":"symbol","abstract":[{"type":"text","text":"The Auth0 Domain URL."}],"type":"topic","title":"url","url":"\/documentation\/auth0\/users\/url","required":true,"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Users\/url","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"url"},{"kind":"text","text":": "},{"preciseIdentifier":"s:10Foundation3URLV","kind":"typeIdentifier","text":"URL"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ 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 f505802bc..452023dd2 100644 --- a/docs/data/documentation/auth0/webauth(clientid:domain:session:).json +++ b/docs/data/documentation/auth0/webauth(clientid:domain:session:).json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"kind":"symbol","schemaVersion":{"minor":3,"patch":0,"major":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/webAuth(clientId:domain:session:)"},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"webAuth"},{"kind":"text","text":"("},{"kind":"externalParam","text":"clientId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"domain"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"session"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"URLSession","preciseIdentifier":"c:objc(cs)NSURLSession"},{"kind":"text","text":" = .shared) -> "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","kind":"typeIdentifier","text":"WebAuth","preciseIdentifier":"s:5Auth07WebAuthP"}],"languages":["swift"],"platforms":["iOS"]}]},{"kind":"parameters","parameters":[{"name":"clientId","content":[{"type":"paragraph","inlineContent":[{"text":"Client ID of your Auth0 application.","type":"text"}]}]},{"name":"domain","content":[{"type":"paragraph","inlineContent":[{"text":"Domain of your Auth0 account, for example ","type":"text"},{"code":"samples.us.auth0.com","type":"codeVoice"},{"text":".","type":"text"}]}]},{"name":"session","content":[{"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":"."}],"type":"paragraph"}]}]},{"kind":"content","content":[{"anchor":"return-value","level":2,"text":"Return Value","type":"heading"},{"inlineContent":[{"text":"Web Auth client.","type":"text"}],"type":"paragraph"}]},{"kind":"content","content":[{"text":"Usage","type":"heading","level":2,"anchor":"Usage"},{"type":"codeListing","code":["Auth0.webAuth(clientId: \"client-id\", domain: \"samples.us.auth0.com\")"],"syntax":"swift"}]}],"abstract":[{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/authenticate\/login\/auth0-universal-login","isActive":true},{"type":"text","text":" client for performing web-based"},{"type":"text","text":" "},{"type":"text","text":"authentication."}],"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth(clientid:domain:session:)"]}],"metadata":{"externalID":"s:5Auth07webAuth8clientId6domain7sessionAA03WebC0_pSS_SSSo12NSURLSessionCtF","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"webAuth"},{"kind":"text","text":"("},{"kind":"externalParam","text":"clientId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"domain"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"session"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"URLSession","preciseIdentifier":"c:objc(cs)NSURLSession"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"WebAuth","preciseIdentifier":"s:5Auth07WebAuthP"}],"symbolKind":"func","modules":[{"name":"Auth0"}],"roleHeading":"Function","title":"webAuth(clientId:domain:session:)","role":"symbol"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"title":"WebAuth","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"url":"\/documentation\/auth0\/webauth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/webAuth(clientId:domain:session:)":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"webAuth"},{"kind":"text","text":"("},{"kind":"externalParam","text":"clientId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"domain"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"session"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSURLSession","text":"URLSession"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07WebAuthP","text":"WebAuth"}],"title":"webAuth(clientId:domain:session:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/webAuth(clientId:domain:session:)","kind":"symbol","abstract":[{"identifier":"https:\/\/auth0.com\/docs\/authenticate\/login\/auth0-universal-login","isActive":true,"type":"reference"},{"text":" client for performing web-based","type":"text"},{"text":" ","type":"text"},{"text":"authentication.","type":"text"}],"url":"\/documentation\/auth0\/webauth(clientid:domain:session:)","role":"symbol","type":"topic"},"https://auth0.com/docs/authenticate/login/auth0-universal-login":{"url":"https:\/\/auth0.com\/docs\/authenticate\/login\/auth0-universal-login","type":"link","title":"Universal Login","titleInlineContent":[{"text":"Universal Login","type":"text"}],"identifier":"https:\/\/auth0.com\/docs\/authenticate\/login\/auth0-universal-login"}}} \ No newline at end of file +{"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"webAuth"},{"kind":"text","text":"("},{"kind":"externalParam","text":"clientId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"domain"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"session","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"URLSession","preciseIdentifier":"c:objc(cs)NSURLSession","kind":"typeIdentifier"},{"text":" = .shared) -> ","kind":"text"},{"text":"WebAuth","preciseIdentifier":"s:5Auth07WebAuthP","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"}]}],"kind":"declarations"},{"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"},{"type":"text","text":" instance used for networking. Defaults to "},{"type":"codeVoice","code":"URLSession.shared"},{"type":"text","text":"."}]}],"name":"session"}],"kind":"parameters"},{"content":[{"text":"Return Value","level":2,"type":"heading","anchor":"return-value"},{"inlineContent":[{"type":"text","text":"Web Auth client."}],"type":"paragraph"}],"kind":"content"},{"content":[{"text":"Usage","level":2,"type":"heading","anchor":"Usage"},{"syntax":"swift","code":["Auth0.webAuth(clientId: \"client-id\", domain: \"samples.us.auth0.com\")"],"type":"codeListing"}],"kind":"content"}],"sections":[],"abstract":[{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/authenticate\/login\/auth0-universal-login","isActive":true},{"type":"text","text":" client for performing web-based"},{"type":"text","text":" "},{"type":"text","text":"authentication."}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth(clientid:domain:session:)"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/webAuth(clientId:domain:session:)","interfaceLanguage":"swift"},"metadata":{"role":"symbol","title":"webAuth(clientId:domain:session:)","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"webAuth"},{"kind":"text","text":"("},{"kind":"externalParam","text":"clientId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"domain"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"session"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"URLSession","preciseIdentifier":"c:objc(cs)NSURLSession"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"WebAuth","preciseIdentifier":"s:5Auth07WebAuthP"}],"externalID":"s:5Auth07webAuth8clientId6domain7sessionAA03WebC0_pSS_SSSo12NSURLSessionCtF","roleHeading":"Function","symbolKind":"func"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"https://auth0.com/docs/authenticate/login/auth0-universal-login":{"url":"https:\/\/auth0.com\/docs\/authenticate\/login\/auth0-universal-login","title":"Universal Login","identifier":"https:\/\/auth0.com\/docs\/authenticate\/login\/auth0-universal-login","titleInlineContent":[{"text":"Universal Login","type":"text"}],"type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"url":"\/documentation\/auth0\/webauth","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"title":"WebAuth","navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/webAuth(clientId:domain:session:)":{"url":"\/documentation\/auth0\/webauth(clientid:domain:session:)","title":"webAuth(clientId:domain:session:)","abstract":[{"identifier":"https:\/\/auth0.com\/docs\/authenticate\/login\/auth0-universal-login","isActive":true,"type":"reference"},{"text":" client for performing web-based","type":"text"},{"text":" ","type":"text"},{"text":"authentication.","type":"text"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"webAuth","kind":"identifier"},{"text":"(","kind":"text"},{"text":"clientId","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"domain","kind":"externalParam"},{"text":": ","kind":"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"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth07WebAuthP","text":"WebAuth","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/webAuth(clientId:domain:session:)","role":"symbol","kind":"symbol","type":"topic"}}} \ 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 2530bc9bf..dbb7a7a64 100644 --- a/docs/data/documentation/auth0/webauth(session:bundle:).json +++ b/docs/data/documentation/auth0/webauth(session:bundle:).json @@ -1 +1 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/webAuth(session:bundle:)","interfaceLanguage":"swift"},"metadata":{"symbolKind":"func","externalID":"s:5Auth07webAuth7session6bundleAA03WebC0_pSo12NSURLSessionC_So8NSBundleCtF","roleHeading":"Function","title":"webAuth(session:bundle:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"webAuth"},{"kind":"text","text":"("},{"kind":"externalParam","text":"session"},{"kind":"text","text":": "},{"text":"URLSession","preciseIdentifier":"c:objc(cs)NSURLSession","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"bundle","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Bundle","preciseIdentifier":"c:objc(cs)NSBundle","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"WebAuth","preciseIdentifier":"s:5Auth07WebAuthP","kind":"typeIdentifier"}],"modules":[{"name":"Auth0"}],"role":"symbol"},"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"abstract":[{"identifier":"https:\/\/auth0.com\/docs\/authenticate\/login\/auth0-universal-login","isActive":true,"type":"reference"},{"text":" client for performing web-based","type":"text"},{"text":" ","type":"text"},{"text":"authentication.","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"webAuth"},{"kind":"text","text":"("},{"kind":"externalParam","text":"session"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSURLSession","text":"URLSession"},{"kind":"text","text":" = .shared, "},{"kind":"externalParam","text":"bundle"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSBundle","text":"Bundle"},{"kind":"text","text":" = Bundle.main) -> "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","kind":"typeIdentifier","preciseIdentifier":"s:5Auth07WebAuthP","text":"WebAuth"}],"platforms":["iOS"]}]},{"kind":"parameters","parameters":[{"name":"session","content":[{"inlineContent":[{"text":"","type":"text"},{"type":"codeVoice","code":"URLSession"},{"text":" instance used for networking. Defaults to ","type":"text"},{"type":"codeVoice","code":"URLSession.shared"},{"text":".","type":"text"}],"type":"paragraph"}]},{"name":"bundle","content":[{"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"},{"text":".","type":"text"}],"type":"paragraph"}]}]},{"kind":"content","content":[{"text":"Return Value","type":"heading","level":2,"anchor":"return-value"},{"inlineContent":[{"text":"Web Auth client.","type":"text"}],"type":"paragraph"}]},{"kind":"content","content":[{"text":"Usage","level":2,"anchor":"Usage","type":"heading"},{"syntax":"swift","code":["Auth0.webAuth()"],"type":"codeListing"},{"inlineContent":[{"text":"The Auth0 Domain is loaded from the ","type":"text"},{"type":"codeVoice","code":"Auth0.plist"},{"text":" file in your main bundle. It should have the following content:","type":"text"}],"type":"paragraph"},{"syntax":"xml","code":["","","",""," ClientId<\/key>"," YOUR_AUTH0_CLIENT_ID<\/string>"," Domain<\/key>"," YOUR_AUTH0_DOMAIN<\/string>","<\/dict>","<\/plist>"],"type":"codeListing"},{"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."}]}],"name":"Warning","style":"warning","type":"aside"}]}],"variants":[{"paths":["\/documentation\/auth0\/webauth(session:bundle:)"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"title":"WebAuth","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"url":"\/documentation\/auth0\/webauth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/webAuth(session:bundle:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/webAuth(session:bundle:)","kind":"symbol","url":"\/documentation\/auth0\/webauth(session:bundle:)","abstract":[{"type":"reference","identifier":"https:\/\/auth0.com\/docs\/authenticate\/login\/auth0-universal-login","isActive":true},{"type":"text","text":" client for performing web-based"},{"type":"text","text":" "},{"type":"text","text":"authentication."}],"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"webAuth"},{"kind":"text","text":"("},{"kind":"externalParam","text":"session"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"URLSession","preciseIdentifier":"c:objc(cs)NSURLSession"},{"kind":"text","text":", "},{"kind":"externalParam","text":"bundle"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bundle","preciseIdentifier":"c:objc(cs)NSBundle"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"WebAuth","preciseIdentifier":"s:5Auth07WebAuthP"}],"type":"topic","title":"webAuth(session:bundle:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"https://auth0.com/docs/authenticate/login/auth0-universal-login":{"titleInlineContent":[{"type":"text","text":"Universal Login"}],"title":"Universal Login","identifier":"https:\/\/auth0.com\/docs\/authenticate\/login\/auth0-universal-login","type":"link","url":"https:\/\/auth0.com\/docs\/authenticate\/login\/auth0-universal-login"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"metadata":{"symbolKind":"func","modules":[{"name":"Auth0"}],"title":"webAuth(session:bundle:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"webAuth"},{"kind":"text","text":"("},{"kind":"externalParam","text":"session"},{"kind":"text","text":": "},{"preciseIdentifier":"c:objc(cs)NSURLSession","kind":"typeIdentifier","text":"URLSession"},{"kind":"text","text":", "},{"kind":"externalParam","text":"bundle"},{"kind":"text","text":": "},{"preciseIdentifier":"c:objc(cs)NSBundle","kind":"typeIdentifier","text":"Bundle"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:5Auth07WebAuthP","kind":"typeIdentifier","text":"WebAuth"}],"externalID":"s:5Auth07webAuth7session6bundleAA03WebC0_pSo12NSURLSessionC_So8NSBundleCtF","role":"symbol","roleHeading":"Function"},"sections":[],"abstract":[{"identifier":"https:\/\/auth0.com\/docs\/authenticate\/login\/auth0-universal-login","type":"reference","isActive":true},{"text":" client for performing web-based","type":"text"},{"text":" ","type":"text"},{"text":"authentication.","type":"text"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth(session:bundle:)"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/webAuth(session:bundle:)"},"kind":"symbol","schemaVersion":{"minor":3,"major":0,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"webAuth"},{"kind":"text","text":"("},{"kind":"externalParam","text":"session"},{"kind":"text","text":": "},{"preciseIdentifier":"c:objc(cs)NSURLSession","kind":"typeIdentifier","text":"URLSession"},{"kind":"text","text":" = .shared, "},{"kind":"externalParam","text":"bundle"},{"kind":"text","text":": "},{"preciseIdentifier":"c:objc(cs)NSBundle","kind":"typeIdentifier","text":"Bundle"},{"kind":"text","text":" = Bundle.main) -> "},{"preciseIdentifier":"s:5Auth07WebAuthP","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","kind":"typeIdentifier","text":"WebAuth"}],"platforms":["iOS"]}]},{"kind":"parameters","parameters":[{"content":[{"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":"."}],"type":"paragraph"}],"name":"session"},{"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"}]},{"content":[{"level":2,"text":"Return Value","type":"heading","anchor":"return-value"},{"inlineContent":[{"type":"text","text":"Web Auth client."}],"type":"paragraph"}],"kind":"content"},{"content":[{"level":2,"text":"Usage","type":"heading","anchor":"Usage"},{"syntax":"swift","type":"codeListing","code":["Auth0.webAuth()"]},{"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","type":"codeListing","code":["","","",""," ClientId<\/key>"," YOUR_AUTH0_CLIENT_ID<\/string>"," Domain<\/key>"," YOUR_AUTH0_DOMAIN<\/string>","<\/dict>","<\/plist>"]},{"style":"warning","content":[{"inlineContent":[{"type":"text","text":"Calling this method without a valid "},{"type":"codeVoice","code":"Auth0.plist"},{"type":"text","text":" file will crash your application."}],"type":"paragraph"}],"type":"aside","name":"Warning"}],"kind":"content"}],"references":{"https://auth0.com/docs/authenticate/login/auth0-universal-login":{"type":"link","titleInlineContent":[{"text":"Universal Login","type":"text"}],"url":"https:\/\/auth0.com\/docs\/authenticate\/login\/auth0-universal-login","title":"Universal Login","identifier":"https:\/\/auth0.com\/docs\/authenticate\/login\/auth0-universal-login"},"doc://com.auth0.Auth0/documentation/Auth0/webAuth(session:bundle:)":{"url":"\/documentation\/auth0\/webauth(session:bundle:)","title":"webAuth(session:bundle:)","abstract":[{"isActive":true,"type":"reference","identifier":"https:\/\/auth0.com\/docs\/authenticate\/login\/auth0-universal-login"},{"type":"text","text":" client for performing web-based"},{"type":"text","text":" "},{"type":"text","text":"authentication."}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"webAuth"},{"kind":"text","text":"("},{"kind":"externalParam","text":"session"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSURLSession","text":"URLSession"},{"kind":"text","text":", "},{"kind":"externalParam","text":"bundle"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:objc(cs)NSBundle","text":"Bundle"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth07WebAuthP","text":"WebAuth"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/webAuth(session:bundle:)","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"url":"\/documentation\/auth0\/webauth","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"title":"WebAuth","navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","role":"symbol","kind":"symbol","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webauth.json b/docs/data/documentation/auth0/webauth.json index c8759266e..add9bd7e9 100644 --- a/docs/data/documentation/auth0/webauth.json +++ b/docs/data/documentation/auth0/webauth.json @@ -1 +1 @@ -{"sections":[],"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"],"generated":true,"anchor":"Instance-Properties"},{"title":"Instance Methods","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/audience(_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/authorizeURL(_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-4zqyr","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-8sl1o","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:callback:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/connection(_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/connectionScope(_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/headers(_:)","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()"],"generated":true,"anchor":"Instance-Methods"}],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","https:\/\/auth0.com\/docs\/authenticate\/login\/auth0-universal-login"],"anchor":"Related-Documentation"}],"schemaVersion":{"patch":0,"minor":3,"major":0},"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"metadata":{"roleHeading":"Protocol","externalID":"s:5Auth07WebAuthP","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"symbolKind":"protocol","role":"symbol","modules":[{"name":"Auth0"}],"navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"title":"WebAuth"},"abstract":[{"text":"Web-based authentication using Auth0.","type":"text"}],"relationshipsSections":[{"title":"Inherits From","kind":"relationships","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SenderConstraining","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable"],"type":"inheritsFrom"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuth"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","text":"Loggable","preciseIdentifier":"s:5Auth08LoggableP","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"SenderConstraining","preciseIdentifier":"s:5Auth018SenderConstrainingP","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SenderConstraining"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"Trackable","preciseIdentifier":"s:5Auth09TrackableP","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable"}]}]}],"variants":[{"paths":["\/documentation\/auth0\/webauth"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/redirectURL(_:)":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/redirectURL(_:)","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"redirectURL","kind":"identifier"},{"text":"(","kind":"text"},{"text":"URL","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"required":true,"role":"symbol","abstract":[{"type":"text","text":"Specify a custom redirect URL to be used."}],"url":"\/documentation\/auth0\/webauth\/redirecturl(_:)","title":"redirectURL(_:)"},"https://manage.auth0.com/#/apis":{"title":"Auth0 Dashboard","type":"link","url":"https:\/\/manage.auth0.com\/#\/apis","titleInlineContent":[{"type":"text","text":"Auth0 Dashboard"}],"identifier":"https:\/\/manage.auth0.com\/#\/apis"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/maxAge(_:)":{"title":"maxAge(_:)","abstract":[{"type":"text","text":"Specify a "},{"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."}],"required":true,"kind":"symbol","type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"maxAge"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/maxAge(_:)","url":"\/documentation\/auth0\/webauth\/maxage(_:)"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/useHTTPS()":{"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":" "},{"type":"text","text":"macOS, the bundle identifier of the app will be used as a custom scheme."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useHTTPS()","title":"useHTTPS()","required":true,"type":"topic","url":"\/documentation\/auth0\/webauth\/usehttps()","kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"useHTTPS"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","text":"Self"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/invitationURL(_:)":{"url":"\/documentation\/auth0\/webauth\/invitationurl(_:)","abstract":[{"type":"text","text":"Specify an invitation URL to join an organization."}],"type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"invitationURL"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"URL","preciseIdentifier":"s:10Foundation3URLV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/invitationURL(_:)","title":"invitationURL(_:)","required":true},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:)-8sl1o":{"url":"\/documentation\/auth0\/webauth\/clearsession(federated:)-8sl1o","required":true,"title":"clearSession(federated:)","role":"symbol","abstract":[{"text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session.","type":"text"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"clearSession","kind":"identifier"},{"text":"(","kind":"text"},{"text":"federated","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-8sl1o","defaultImplementations":2,"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/audience(_:)":{"kind":"symbol","title":"audience(_:)","role":"symbol","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"},{"text":"This value must match the ","type":"text"},{"inlineContent":[{"type":"text","text":"API Identifier"}],"type":"strong"},{"text":" displayed in the APIs section of the ","type":"text"},{"isActive":true,"identifier":"https:\/\/manage.auth0.com\/#\/apis","type":"reference"},{"text":".","type":"text"}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"audience"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/audience(_:)","type":"topic","url":"\/documentation\/auth0\/webauth\/audience(_:)","required":true},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/url":{"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"url"},{"kind":"text","text":": "},{"preciseIdentifier":"s:10Foundation3URLV","kind":"typeIdentifier","text":"URL"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/url","role":"symbol","kind":"symbol","abstract":[{"type":"text","text":"The Auth0 Domain URL."}],"title":"url","url":"\/documentation\/auth0\/webauth\/url","required":true},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/useEphemeralSession()":{"type":"topic","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)."}],"role":"symbol","url":"\/documentation\/auth0\/webauth\/useephemeralsession()","kind":"symbol","title":"useEphemeralSession()","required":true,"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"useEphemeralSession"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","text":"Self"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"title":"WebAuth","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"url":"\/documentation\/auth0\/webauth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/start()-qpqo":{"abstract":[{"type":"text","text":"Starts the Web Auth flow."}],"url":"\/documentation\/auth0\/webauth\/start()-qpqo","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"start"},{"kind":"text","text":"() -> "},{"preciseIdentifier":"s:7Combine12AnyPublisherV","kind":"typeIdentifier","text":"AnyPublisher"},{"kind":"text","text":"<"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","text":"Credentials"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier","text":"WebAuthError"},{"kind":"text","text":">"}],"kind":"symbol","type":"topic","required":true,"title":"start()","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/start()-qpqo"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/start()-98znq":{"kind":"symbol","abstract":[{"type":"text","text":"Starts the Web Auth flow."}],"url":"\/documentation\/auth0\/webauth\/start()-98znq","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"start"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"}],"type":"topic","required":true,"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/start()-98znq","title":"start()"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent":{"title":"WebAuthUserAgent","url":"\/documentation\/auth0\/webauthuseragent","navigatorTitle":[{"kind":"identifier","text":"WebAuthUserAgent"}],"abstract":[{"type":"text","text":"The external user agent used to perform a web-based operation."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","kind":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthUserAgent"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/connection(_:)":{"kind":"symbol","title":"connection(_:)","abstract":[{"text":"Specify an Auth0 connection to directly open that identity provider’s login page, skipping the Universal Login","type":"text"},{"text":" ","type":"text"},{"text":"page itself. By default no connection is specified, so the Universal Login page will be displayed.","type":"text"}],"type":"topic","role":"symbol","url":"\/documentation\/auth0\/webauth\/connection(_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/connection(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"connection"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"required":true},"doc://com.auth0.Auth0/documentation/Auth0/Loggable":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","abstract":[{"type":"text","text":"A type that can log statements for debugging purposes."}],"fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Loggable","kind":"identifier"}],"kind":"symbol","title":"Loggable","type":"topic","role":"symbol","navigatorTitle":[{"text":"Loggable","kind":"identifier"}],"url":"\/documentation\/auth0\/loggable"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clientId":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clientId","required":true,"url":"\/documentation\/auth0\/webauth\/clientid","kind":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"clientId"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"role":"symbol","abstract":[{"text":"The Auth0 Client ID.","type":"text"}],"title":"clientId"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/organization(_:)":{"required":true,"title":"organization(_:)","role":"symbol","type":"topic","url":"\/documentation\/auth0\/webauth\/organization(_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/organization(_:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"organization"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"kind":"symbol","abstract":[{"type":"text","text":"Specify an organization identifier to log in to."}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/connectionScope(_:)":{"required":true,"abstract":[{"text":"Specify provider scopes for OAuth2\/social connections, such as GitHub or Google.","type":"text"}],"role":"symbol","title":"connectionScope(_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/connectionScope(_:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"connectionScope","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"type":"topic","kind":"symbol","url":"\/documentation\/auth0\/webauth\/connectionscope(_:)"},"doc://com.auth0.Auth0/documentation/Auth0/SenderConstraining":{"navigatorTitle":[{"kind":"identifier","text":"SenderConstraining"}],"role":"symbol","kind":"symbol","abstract":[{"text":"A type that can use DPoP for securing requests.","type":"text"}],"url":"\/documentation\/auth0\/senderconstraining","type":"topic","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"SenderConstraining"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SenderConstraining","title":"SenderConstraining"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:)-4zqyr":{"url":"\/documentation\/auth0\/webauth\/clearsession(federated:)-4zqyr","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-4zqyr","kind":"symbol","abstract":[{"text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session.","type":"text"}],"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"clearSession"},{"kind":"text","text":"("},{"kind":"externalParam","text":"federated"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"AnyPublisher","preciseIdentifier":"s:7Combine12AnyPublisherV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV"},{"kind":"text","text":">"}],"defaultImplementations":2,"title":"clearSession(federated:)","required":true},"doc://com.auth0.Auth0/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"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/telemetry","title":"telemetry","required":true,"type":"topic","url":"\/documentation\/auth0\/webauth\/telemetry","kind":"symbol","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"telemetry","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Telemetry","kind":"typeIdentifier","preciseIdentifier":"s:5Auth09TelemetryV"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/scope(_:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/scope(_:)","abstract":[{"text":"Specify the scopes that will be requested during authentication.","type":"text"}],"title":"scope(_:)","required":true,"role":"symbol","url":"\/documentation\/auth0\/webauth\/scope(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"scope"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Telemetry":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Telemetry","kind":"identifier"}],"title":"Telemetry","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","url":"\/documentation\/auth0\/telemetry","kind":"symbol","abstract":[{"text":"Generates and sets the ","type":"text"},{"type":"codeVoice","code":"Auth0-Client"},{"text":" header.","type":"text"}],"role":"symbol","navigatorTitle":[{"text":"Telemetry","kind":"identifier"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"abstract":[{"text":"Represents an error during a Web Auth operation.","type":"text"}],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"type":"topic","role":"symbol","navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","title":"WebAuthError","url":"\/documentation\/auth0\/webautherror"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/leeway(_:)":{"role":"symbol","abstract":[{"type":"text","text":"Specify a leeway amount for ID token validation."},{"type":"text","text":" "},{"type":"text","text":"This value represents the clock skew for the validation of date claims, for example "},{"type":"codeVoice","code":"exp"},{"type":"text","text":"."}],"title":"leeway(_:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/leeway(_:)","url":"\/documentation\/auth0\/webauth\/leeway(_:)","required":true,"type":"topic","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"leeway"},{"kind":"text","text":"("},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/state(_:)":{"kind":"symbol","role":"symbol","title":"state(_:)","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/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":" "},{"type":"text","text":"corresponds to your request."},{"type":"text","text":" "},{"type":"text","text":"By default a random value is used."}],"url":"\/documentation\/auth0\/webauth\/state(_:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"state","kind":"identifier"},{"text":"(","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"required":true},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/start(_:)":{"abstract":[{"text":"Starts the Web Auth flow.","type":"text"}],"required":true,"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"start","kind":"identifier"},{"text":"((","kind":"text"},{"preciseIdentifier":"s:5Auth013WebAuthResulta","text":"WebAuthResult","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"text":">) -> ","kind":"text"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"text":")","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/start(_:)","url":"\/documentation\/auth0\/webauth\/start(_:)","title":"start(_:)","type":"topic","kind":"symbol","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/onClose(_:)":{"type":"topic","abstract":[{"type":"text","text":"Specify a callback to be called when the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent"},{"type":"text","text":" closes, while the flow continues with the code exchange."}],"kind":"symbol","title":"onClose(_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/onClose(_:)","url":"\/documentation\/auth0\/webauth\/onclose(_:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"onClose","kind":"identifier"},{"text":"((() -> ","kind":"text"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"text":")?) -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"required":true},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/authorizeURL(_:)":{"abstract":[{"type":"text","text":"Specify a custom authorize URL to be used."}],"kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"authorizeURL"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV","text":"URL"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/authorizeURL(_:)","required":true,"title":"authorizeURL(_:)","type":"topic","role":"symbol","url":"\/documentation\/auth0\/webauth\/authorizeurl(_:)"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/nonce(_:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/nonce(_:)","kind":"symbol","required":true,"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"nonce"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"type":"topic","title":"nonce(_:)","abstract":[{"type":"text","text":"Specify a "},{"code":"nonce","type":"codeVoice"},{"type":"text","text":" parameter for ID token validation."}],"url":"\/documentation\/auth0\/webauth\/nonce(_:)"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:callback:)":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"clearSession","kind":"identifier"},{"text":"(","kind":"text"},{"text":"federated","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"callback","kind":"externalParam"},{"text":": (","kind":"text"},{"text":"WebAuthResult","preciseIdentifier":"s:5Auth013WebAuthResulta","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:s4Voida","kind":"typeIdentifier","text":"Void"},{"kind":"text","text":">) -> "},{"preciseIdentifier":"s:s4Voida","kind":"typeIdentifier","text":"Void"},{"kind":"text","text":")"}],"type":"topic","defaultImplementations":1,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:callback:)","required":true,"title":"clearSession(federated:callback:)","kind":"symbol","url":"\/documentation\/auth0\/webauth\/clearsession(federated:callback:)","abstract":[{"text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session.","type":"text"}],"role":"symbol"},"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","url":"\/documentation\/auth0\/trackable","role":"symbol","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Trackable"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable","title":"Trackable","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Trackable"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/provider(_:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/provider(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"provider"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"WebAuthProvider","preciseIdentifier":"s:5Auth015WebAuthProvidera"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"kind":"symbol","required":true,"type":"topic","abstract":[{"text":"Specify a custom Web Auth provider to use instead of the default ","type":"text"},{"type":"codeVoice","code":"ASWebAuthenticationSession"},{"text":" implementation.","type":"text"}],"url":"\/documentation\/auth0\/webauth\/provider(_:)","title":"provider(_:)","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/parameters(_:)":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/parameters(_:)","type":"topic","abstract":[{"type":"text","text":"Specify additional parameters for authentication."}],"url":"\/documentation\/auth0\/webauth\/parameters(_:)","required":true,"title":"parameters(_:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"parameters","kind":"identifier"},{"text":"([","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"]) -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}]},"https://auth0.com/docs/authenticate/login/auth0-universal-login":{"title":"Universal Login","type":"link","url":"https:\/\/auth0.com\/docs\/authenticate\/login\/auth0-universal-login","titleInlineContent":[{"type":"text","text":"Universal Login"}],"identifier":"https:\/\/auth0.com\/docs\/authenticate\/login\/auth0-universal-login"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/issuer(_:)":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"issuer","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"url":"\/documentation\/auth0\/webauth\/issuer(_:)","abstract":[{"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.","type":"text"}],"kind":"symbol","required":true,"title":"issuer(_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/issuer(_:)","type":"topic","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/headers(_:)":{"title":"headers(_:)","url":"\/documentation\/auth0\/webauth\/headers(_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/headers(_:)","role":"symbol","abstract":[{"type":"text","text":"Specify additional headers for "},{"type":"codeVoice","code":"ASWebAuthenticationSession"},{"type":"text","text":"."}],"required":true,"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"headers","kind":"identifier"},{"text":"([","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"]) -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"type":"topic","kind":"symbol"}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"abstract":[{"text":"Web-based authentication using Auth0.","type":"text"}],"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"],"anchor":"Instance-Properties","generated":true},{"title":"Instance Methods","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/audience(_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/authorizeURL(_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-4zqyr","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-8sl1o","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:callback:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/connection(_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/connectionScope(_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/headers(_:)","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()"],"anchor":"Instance-Methods","generated":true}],"kind":"symbol","schemaVersion":{"patch":0,"major":0,"minor":3},"sections":[],"relationshipsSections":[{"title":"Inherits From","type":"inheritsFrom","kind":"relationships","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SenderConstraining","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable"]}],"seeAlsoSections":[{"anchor":"Related-Documentation","title":"Related Documentation","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","https:\/\/auth0.com\/docs\/authenticate\/login\/auth0-universal-login"]}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuth"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","text":"Loggable","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","preciseIdentifier":"s:5Auth08LoggableP"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"SenderConstraining","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SenderConstraining","preciseIdentifier":"s:5Auth018SenderConstrainingP"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"Trackable","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable","preciseIdentifier":"s:5Auth09TrackableP"}]}],"kind":"declarations"}],"metadata":{"externalID":"s:5Auth07WebAuthP","symbolKind":"protocol","title":"WebAuth","role":"symbol","roleHeading":"Protocol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"modules":[{"name":"Auth0"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/parameters(_:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/parameters(_:)","kind":"symbol","title":"parameters(_:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"parameters","kind":"identifier"},{"text":"([","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"]) -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"role":"symbol","required":true,"url":"\/documentation\/auth0\/webauth\/parameters(_:)","abstract":[{"type":"text","text":"Specify additional parameters for authentication."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/scope(_:)":{"type":"topic","title":"scope(_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/scope(_:)","kind":"symbol","abstract":[{"type":"text","text":"Specify the scopes that will be requested during authentication."}],"url":"\/documentation\/auth0\/webauth\/scope(_:)","required":true,"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"scope"},{"text":"(","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}]},"doc://com.auth0.Auth0/documentation/Auth0/SenderConstraining":{"kind":"symbol","abstract":[{"text":"A type that can use DPoP for securing requests.","type":"text"}],"type":"topic","title":"SenderConstraining","url":"\/documentation\/auth0\/senderconstraining","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"SenderConstraining"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/SenderConstraining","navigatorTitle":[{"kind":"identifier","text":"SenderConstraining"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/connectionScope(_:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/connectionScope(_:)","kind":"symbol","title":"connectionScope(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"connectionScope"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"role":"symbol","required":true,"url":"\/documentation\/auth0\/webauth\/connectionscope(_:)","abstract":[{"type":"text","text":"Specify provider scopes for OAuth2\/social connections, such as GitHub or Google."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/useEphemeralSession()":{"url":"\/documentation\/auth0\/webauth\/useephemeralsession()","title":"useEphemeralSession()","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)."}],"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"useEphemeralSession"},{"text":"() -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()","required":true,"kind":"symbol","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"url":"\/documentation\/auth0\/webauth","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"title":"WebAuth","navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/issuer(_:)":{"url":"\/documentation\/auth0\/webauth\/issuer(_:)","required":true,"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"issuer"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"title":"issuer(_:)","type":"topic","role":"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."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/issuer(_:)","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/maxAge(_:)":{"role":"symbol","title":"maxAge(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"maxAge"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"abstract":[{"type":"text","text":"Specify a "},{"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"},{"text":" claim in the ID token.","type":"text"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/maxAge(_:)","url":"\/documentation\/auth0\/webauth\/maxage(_:)","required":true,"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent":{"kind":"symbol","abstract":[{"type":"text","text":"The external user agent used to perform a web-based operation."}],"type":"topic","url":"\/documentation\/auth0\/webauthuseragent","title":"WebAuthUserAgent","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthUserAgent"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","navigatorTitle":[{"kind":"identifier","text":"WebAuthUserAgent"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/leeway(_:)":{"kind":"symbol","title":"leeway(_:)","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"leeway","kind":"identifier"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/leeway(_:)","required":true,"abstract":[{"type":"text","text":"Specify a leeway amount for ID token validation."},{"type":"text","text":" "},{"type":"text","text":"This value represents the clock skew for the validation of date claims, for example "},{"code":"exp","type":"codeVoice"},{"type":"text","text":"."}],"url":"\/documentation\/auth0\/webauth\/leeway(_:)"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/state(_:)":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/state(_:)","title":"state(_:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"state","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"role":"symbol","required":true,"url":"\/documentation\/auth0\/webauth\/state(_:)","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":" "},{"type":"text","text":"corresponds to your request."},{"type":"text","text":" "},{"type":"text","text":"By default a random value is used."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/audience(_:)":{"role":"symbol","title":"audience(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"audience"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"abstract":[{"type":"text","text":"Specify an audience name for the API that your application will call using the access token returned after"},{"type":"text","text":" "},{"type":"text","text":"authentication."},{"type":"text","text":" "},{"type":"text","text":"This value must match the "},{"type":"strong","inlineContent":[{"type":"text","text":"API Identifier"}]},{"type":"text","text":" displayed in the APIs section of the "},{"type":"reference","isActive":true,"identifier":"https:\/\/manage.auth0.com\/#\/apis"},{"type":"text","text":"."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/audience(_:)","url":"\/documentation\/auth0\/webauth\/audience(_:)","required":true,"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/start()-qpqo":{"type":"topic","abstract":[{"type":"text","text":"Starts the Web Auth flow."}],"title":"start()","url":"\/documentation\/auth0\/webauth\/start()-qpqo","kind":"symbol","required":true,"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"start","kind":"identifier"},{"text":"() -> ","kind":"text"},{"text":"AnyPublisher","preciseIdentifier":"s:7Combine12AnyPublisherV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/start()-qpqo"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/start(_:)":{"kind":"symbol","required":true,"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"start"},{"kind":"text","text":"(("},{"kind":"typeIdentifier","text":"WebAuthResult","preciseIdentifier":"s:5Auth013WebAuthResulta"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":">) -> "},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":")"}],"title":"start(_:)","type":"topic","role":"symbol","abstract":[{"text":"Starts the Web Auth flow.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/start(_:)","url":"\/documentation\/auth0\/webauth\/start(_:)"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/start()-98znq":{"kind":"symbol","title":"start()","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"start"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","text":"Credentials"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/start()-98znq","required":true,"abstract":[{"type":"text","text":"Starts the Web Auth flow."}],"url":"\/documentation\/auth0\/webauth\/start()-98znq"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/useHTTPS()":{"kind":"symbol","title":"useHTTPS()","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"useHTTPS"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","text":"Self"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useHTTPS()","required":true,"abstract":[{"type":"text","text":"Use "},{"type":"codeVoice","code":"https"},{"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."}],"url":"\/documentation\/auth0\/webauth\/usehttps()"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/provider(_:)":{"url":"\/documentation\/auth0\/webauth\/provider(_:)","abstract":[{"text":"Specify a custom Web Auth provider to use instead of the default ","type":"text"},{"code":"ASWebAuthenticationSession","type":"codeVoice"},{"text":" implementation.","type":"text"}],"title":"provider(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"provider"},{"kind":"text","text":"("},{"text":"WebAuthProvider","preciseIdentifier":"s:5Auth015WebAuthProvidera","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/provider(_:)","required":true,"kind":"symbol","role":"symbol","type":"topic"},"https://manage.auth0.com/#/apis":{"title":"Auth0 Dashboard","type":"link","identifier":"https:\/\/manage.auth0.com\/#\/apis","titleInlineContent":[{"type":"text","text":"Auth0 Dashboard"}],"url":"https:\/\/manage.auth0.com\/#\/apis"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/url":{"type":"topic","title":"url","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/url","kind":"symbol","abstract":[{"text":"The Auth0 Domain URL.","type":"text"}],"url":"\/documentation\/auth0\/webauth\/url","required":true,"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"url"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"URL","preciseIdentifier":"s:10Foundation3URLV"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clientId":{"type":"topic","title":"clientId","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clientId","kind":"symbol","abstract":[{"type":"text","text":"The Auth0 Client ID."}],"url":"\/documentation\/auth0\/webauth\/clientid","required":true,"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"clientId"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}]},"doc://com.auth0.Auth0/documentation/Auth0/Trackable":{"title":"Trackable","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Trackable","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Trackable"}],"abstract":[{"text":"A type that can send the ","type":"text"},{"code":"Auth0-Client","type":"codeVoice"},{"text":" header on every request to Auth0.","type":"text"}],"url":"\/documentation\/auth0\/trackable","navigatorTitle":[{"kind":"identifier","text":"Trackable"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/connection(_:)":{"url":"\/documentation\/auth0\/webauth\/connection(_:)","required":true,"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"connection"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"title":"connection(_:)","type":"topic","role":"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":" "},{"type":"text","text":"page itself. By default no connection is specified, so the Universal Login page will be displayed."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/connection(_:)","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Telemetry":{"kind":"symbol","abstract":[{"text":"Generates and sets the ","type":"text"},{"code":"Auth0-Client","type":"codeVoice"},{"text":" header.","type":"text"}],"type":"topic","title":"Telemetry","url":"\/documentation\/auth0\/telemetry","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Telemetry"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","navigatorTitle":[{"kind":"identifier","text":"Telemetry"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/invitationURL(_:)":{"type":"topic","abstract":[{"text":"Specify an invitation URL to join an organization.","type":"text"}],"title":"invitationURL(_:)","kind":"symbol","url":"\/documentation\/auth0\/webauth\/invitationurl(_:)","required":true,"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"invitationURL"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"URL","preciseIdentifier":"s:10Foundation3URLV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/invitationURL(_:)"},"doc://com.auth0.Auth0/documentation/Auth0/Loggable":{"role":"symbol","title":"Loggable","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Loggable"}],"navigatorTitle":[{"text":"Loggable","kind":"identifier"}],"abstract":[{"text":"A type that can log statements for debugging purposes.","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/loggable","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Loggable","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/organization(_:)":{"role":"symbol","title":"organization(_:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"organization","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"abstract":[{"type":"text","text":"Specify an organization identifier to log in to."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/organization(_:)","url":"\/documentation\/auth0\/webauth\/organization(_:)","required":true,"type":"topic"},"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","identifier":"https:\/\/auth0.com\/docs\/authenticate\/login\/auth0-universal-login","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"url":"\/documentation\/auth0\/webautherror","abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"title":"WebAuthError","navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/authorizeURL(_:)":{"type":"topic","abstract":[{"type":"text","text":"Specify a custom authorize URL to be used."}],"kind":"symbol","url":"\/documentation\/auth0\/webauth\/authorizeurl(_:)","title":"authorizeURL(_:)","required":true,"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"authorizeURL","kind":"identifier"},{"kind":"text","text":"("},{"preciseIdentifier":"s:10Foundation3URLV","text":"URL","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"Self","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/authorizeURL(_:)"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:)-4zqyr":{"defaultImplementations":2,"type":"topic","title":"clearSession(federated:)","url":"\/documentation\/auth0\/webauth\/clearsession(federated:)-4zqyr","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-4zqyr","kind":"symbol","abstract":[{"type":"text","text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session."}],"required":true,"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"clearSession"},{"kind":"text","text":"("},{"kind":"externalParam","text":"federated"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:7Combine12AnyPublisherV","kind":"typeIdentifier","text":"AnyPublisher"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:s4Voida","kind":"typeIdentifier","text":"Void"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier","text":"WebAuthError"},{"kind":"text","text":">"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/headers(_:)":{"type":"topic","abstract":[{"type":"text","text":"Specify additional headers for "},{"type":"codeVoice","code":"ASWebAuthenticationSession"},{"type":"text","text":"."}],"title":"headers(_:)","url":"\/documentation\/auth0\/webauth\/headers(_:)","kind":"symbol","required":true,"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"headers","kind":"identifier"},{"text":"([","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"]) -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/headers(_:)"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/nonce(_:)":{"url":"\/documentation\/auth0\/webauth\/nonce(_:)","required":true,"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"nonce"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"title":"nonce(_:)","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Specify a "},{"type":"codeVoice","code":"nonce"},{"type":"text","text":" parameter for ID token validation."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/nonce(_:)","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/onClose(_:)":{"url":"\/documentation\/auth0\/webauth\/onclose(_:)","title":"onClose(_:)","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"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"onClose","kind":"identifier"},{"text":"((() -> ","kind":"text"},{"text":"Void","preciseIdentifier":"s:s4Voida","kind":"typeIdentifier"},{"text":")?) -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/onClose(_:)","required":true,"kind":"symbol","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/redirectURL(_:)":{"type":"topic","abstract":[{"type":"text","text":"Specify a custom redirect URL to be used."}],"title":"redirectURL(_:)","url":"\/documentation\/auth0\/webauth\/redirecturl(_:)","kind":"symbol","required":true,"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"redirectURL"},{"kind":"text","text":"("},{"preciseIdentifier":"s:10Foundation3URLV","kind":"typeIdentifier","text":"URL"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/redirectURL(_:)"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/telemetry":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/telemetry","title":"telemetry","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"telemetry","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Telemetry","preciseIdentifier":"s:5Auth09TelemetryV"}],"role":"symbol","required":true,"url":"\/documentation\/auth0\/webauth\/telemetry","abstract":[{"text":"The ","type":"text"},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry"},{"text":" instance.","type":"text"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:callback:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:callback:)","kind":"symbol","title":"clearSession(federated:callback:)","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"clearSession"},{"kind":"text","text":"("},{"kind":"externalParam","text":"federated"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":", "},{"kind":"externalParam","text":"callback"},{"kind":"text","text":": ("},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth013WebAuthResulta","text":"WebAuthResult"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"kind":"text","text":">) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"kind":"text","text":")"}],"defaultImplementations":1,"role":"symbol","required":true,"url":"\/documentation\/auth0\/webauth\/clearsession(federated:callback:)","abstract":[{"type":"text","text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:)-8sl1o":{"url":"\/documentation\/auth0\/webauth\/clearsession(federated:)-8sl1o","required":true,"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"clearSession"},{"kind":"text","text":"("},{"kind":"externalParam","text":"federated"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"title":"clearSession(federated:)","type":"topic","defaultImplementations":2,"role":"symbol","abstract":[{"text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-8sl1o","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 8d453e643..df0038bc8 100644 --- a/docs/data/documentation/auth0/webauth/audience(_:).json +++ b/docs/data/documentation/auth0/webauth/audience(_:).json @@ -1 +1 @@ -{"variants":[{"paths":["\/documentation\/auth0\/webauth\/audience(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/audience(_:)"},"kind":"symbol","metadata":{"roleHeading":"Instance Method","modules":[{"name":"Auth0"}],"role":"symbol","required":true,"title":"audience(_:)","symbolKind":"method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"audience"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"externalID":"s:5Auth07WebAuthP8audienceyxSSF"},"schemaVersion":{"patch":0,"major":0,"minor":3},"abstract":[{"type":"text","text":"Specify an audience name for the API that your application will call using the access token returned after"},{"type":"text","text":" "},{"type":"text","text":"authentication."},{"type":"text","text":" "},{"type":"text","text":"This value must match the "},{"type":"strong","inlineContent":[{"type":"text","text":"API Identifier"}]},{"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":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"audience","kind":"identifier"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"audience","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"languages":["swift"],"platforms":["iOS"]}]},{"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"}]},{"kind":"content","content":[{"type":"heading","anchor":"return-value","level":2,"text":"Return Value"},{"inlineContent":[{"text":"The same ","type":"text"},{"code":"WebAuth","type":"codeVoice"},{"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"]]},"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/access-tokens\/get-access-tokens#control-access-token-audience"],"anchor":"Related-Documentation","title":"Related Documentation"}],"sections":[],"references":{"https://manage.auth0.com/#/apis":{"identifier":"https:\/\/manage.auth0.com\/#\/apis","type":"link","titleInlineContent":[{"type":"text","text":"Auth0 Dashboard"}],"title":"Auth0 Dashboard","url":"https:\/\/manage.auth0.com\/#\/apis"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/audience(_:)":{"kind":"symbol","title":"audience(_:)","role":"symbol","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"},{"text":"This value must match the ","type":"text"},{"inlineContent":[{"type":"text","text":"API Identifier"}],"type":"strong"},{"text":" displayed in the APIs section of the ","type":"text"},{"isActive":true,"identifier":"https:\/\/manage.auth0.com\/#\/apis","type":"reference"},{"text":".","type":"text"}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"audience"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/audience(_:)","type":"topic","url":"\/documentation\/auth0\/webauth\/audience(_:)","required":true},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"title":"WebAuth","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"url":"\/documentation\/auth0\/webauth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"kind":"symbol"},"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","titleInlineContent":[{"type":"text","text":"Audience"}],"title":"Audience","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/access-tokens\/get-access-tokens#control-access-token-audience"}}} \ No newline at end of file +{"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"audience","kind":"identifier"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"audience","kind":"internalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"languages":["swift"],"platforms":["iOS"]}]},{"kind":"parameters","parameters":[{"name":"audience","content":[{"type":"paragraph","inlineContent":[{"text":"Audience value. For example, ","type":"text"},{"code":"https:\/\/example.com\/api","type":"codeVoice"},{"text":".","type":"text"}]}]}]},{"kind":"content","content":[{"type":"heading","text":"Return Value","anchor":"return-value","level":2},{"type":"paragraph","inlineContent":[{"type":"text","text":"The same "},{"type":"codeVoice","code":"WebAuth"},{"type":"text","text":" instance to allow method chaining."}]}]}],"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":" "},{"type":"text","text":"authentication."},{"type":"text","text":" "},{"type":"text","text":"This value must match the "},{"type":"strong","inlineContent":[{"type":"text","text":"API Identifier"}]},{"type":"text","text":" displayed in the APIs section of the "},{"type":"reference","isActive":true,"identifier":"https:\/\/manage.auth0.com\/#\/apis"},{"type":"text","text":"."}],"kind":"symbol","seeAlsoSections":[{"anchor":"Related-Documentation","title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/secure\/tokens\/access-tokens\/get-access-tokens#control-access-token-audience"]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/audience(_:)"]}],"metadata":{"role":"symbol","modules":[{"name":"Auth0"}],"title":"audience(_:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"audience","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"externalID":"s:5Auth07WebAuthP8audienceyxSSF","roleHeading":"Instance Method","required":true,"symbolKind":"method"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/audience(_:)"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"https://auth0.com/docs/secure/tokens/access-tokens/get-access-tokens#control-access-token-audience":{"title":"Audience","titleInlineContent":[{"type":"text","text":"Audience"}],"type":"link","identifier":"https:\/\/auth0.com\/docs\/secure\/tokens\/access-tokens\/get-access-tokens#control-access-token-audience","url":"https:\/\/auth0.com\/docs\/secure\/tokens\/access-tokens\/get-access-tokens#control-access-token-audience"},"https://manage.auth0.com/#/apis":{"title":"Auth0 Dashboard","titleInlineContent":[{"type":"text","text":"Auth0 Dashboard"}],"type":"link","identifier":"https:\/\/manage.auth0.com\/#\/apis","url":"https:\/\/manage.auth0.com\/#\/apis"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"url":"\/documentation\/auth0\/webauth","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"title":"WebAuth","navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/audience(_:)":{"role":"symbol","title":"audience(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"audience"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"abstract":[{"type":"text","text":"Specify an audience name for the API that your application will call using the access token returned after"},{"type":"text","text":" "},{"type":"text","text":"authentication."},{"type":"text","text":" "},{"type":"text","text":"This value must match the "},{"type":"strong","inlineContent":[{"type":"text","text":"API Identifier"}]},{"type":"text","text":" displayed in the APIs section of the "},{"type":"reference","isActive":true,"identifier":"https:\/\/manage.auth0.com\/#\/apis"},{"type":"text","text":"."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/audience(_:)","url":"\/documentation\/auth0\/webauth\/audience(_:)","required":true,"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webauth/authorizeurl(_:).json b/docs/data/documentation/auth0/webauth/authorizeurl(_:).json index 85eba8786..efa2b3072 100644 --- a/docs/data/documentation/auth0/webauth/authorizeurl(_:).json +++ b/docs/data/documentation/auth0/webauth/authorizeurl(_:).json @@ -1 +1 @@ -{"sections":[],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"authorizeURL"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"authorizeURL"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"URL","preciseIdentifier":"s:10Foundation3URLV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"authorizeURL","content":[{"inlineContent":[{"type":"text","text":"Custom authorize URL."}],"type":"paragraph"}]}]},{"kind":"content","content":[{"type":"heading","level":2,"text":"Return Value","anchor":"return-value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The same "},{"type":"codeVoice","code":"WebAuth"},{"type":"text","text":" instance to allow method chaining."}]}]}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/authorizeurl(_:)"]}],"metadata":{"externalID":"s:5Auth07WebAuthP12authorizeURLyx10Foundation0E0VF","symbolKind":"method","title":"authorizeURL(_:)","modules":[{"name":"Auth0"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authorizeURL","kind":"identifier"},{"text":"(","kind":"text"},{"text":"URL","preciseIdentifier":"s:10Foundation3URLV","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"required":true,"roleHeading":"Instance Method","role":"symbol"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/authorizeURL(_:)","interfaceLanguage":"swift"},"schemaVersion":{"minor":3,"patch":0,"major":0},"abstract":[{"text":"Specify a custom authorize URL to be used.","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/authorizeURL(_:)":{"abstract":[{"type":"text","text":"Specify a custom authorize URL to be used."}],"kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"authorizeURL"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV","text":"URL"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/authorizeURL(_:)","required":true,"title":"authorizeURL(_:)","type":"topic","role":"symbol","url":"\/documentation\/auth0\/webauth\/authorizeurl(_:)"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"title":"WebAuth","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"url":"\/documentation\/auth0\/webauth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"kind":"symbol"}}} \ No newline at end of file +{"metadata":{"externalID":"s:5Auth07WebAuthP12authorizeURLyx10Foundation0E0VF","modules":[{"name":"Auth0"}],"title":"authorizeURL(_:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"authorizeURL","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:10Foundation3URLV","text":"URL","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"roleHeading":"Instance Method","role":"symbol","required":true,"symbolKind":"method"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/authorizeurl(_:)"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/authorizeURL(_:)"},"kind":"symbol","abstract":[{"type":"text","text":"Specify a custom authorize URL to be used."}],"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"},{"text":"authorizeURL","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"authorizeURL"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation3URLV","kind":"typeIdentifier","text":"URL"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"authorizeURL","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Custom authorize URL."}]}]}]},{"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"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"url":"\/documentation\/auth0\/webauth","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"title":"WebAuth","navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/authorizeURL(_:)":{"type":"topic","abstract":[{"type":"text","text":"Specify a custom authorize URL to be used."}],"kind":"symbol","url":"\/documentation\/auth0\/webauth\/authorizeurl(_:)","title":"authorizeURL(_:)","required":true,"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"authorizeURL","kind":"identifier"},{"kind":"text","text":"("},{"preciseIdentifier":"s:10Foundation3URLV","text":"URL","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"Self","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/authorizeURL(_:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ 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 d9c481ea9..865f55f2c 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"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/clearsession(federated:)-3k5r3"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"clearSession","kind":"identifier"},{"text":"(","kind":"text"},{"text":"federated","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"text":" = false) ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"},{"parameters":[{"name":"federated","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"If the identity provider session should be removed. Defaults to "},{"code":"false","type":"codeVoice"},{"type":"text","text":"."}]}]}],"kind":"parameters"},{"content":[{"level":2,"type":"heading","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":[{"type":"text","text":"Remove both the Auth0 session and the identity provider session:"}]},{"type":"codeListing","syntax":"swift","code":["try await Auth0.webAuth().clearSession(federated: true)"]},{"style":"note","name":"Requires","type":"aside","content":[{"inlineContent":[{"type":"text","text":"The "},{"inlineContent":[{"type":"text","text":"Callback URL"}],"type":"strong"},{"type":"text","text":" to have been added to the "},{"inlineContent":[{"type":"text","text":"Allowed Logout URLs"}],"type":"strong"},{"type":"text","text":" field of your Auth0 application"},{"type":"text","text":" "},{"type":"text","text":"settings in the "},{"isActive":true,"type":"reference","identifier":"https:\/\/manage.auth0.com\/#\/applications\/"},{"type":"text","text":"."}],"type":"paragraph"}]},{"style":"note","name":"Note","type":"aside","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"You don’t need to call this method if you are using "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()","isActive":true,"type":"reference"},{"type":"text","text":" on login, because there will"},{"type":"text","text":" "},{"type":"text","text":"be no shared cookie to remove."}]}]}],"kind":"content"}],"seeAlsoSections":[{"anchor":"Related-Documentation","title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/authenticate\/login\/logout"]}],"abstract":[{"text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session.","type":"text"}],"schemaVersion":{"major":0,"patch":0,"minor":3},"sections":[],"kind":"symbol","metadata":{"role":"symbol","externalID":"s:5Auth07WebAuthPAAE12clearSession9federatedySb_tYaKF","modules":[{"name":"Auth0"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"clearSession","kind":"identifier"},{"text":"(","kind":"text"},{"text":"federated","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"}],"extendedModule":"Auth0","roleHeading":"Instance Method","title":"clearSession(federated:)","symbolKind":"method"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/useEphemeralSession()":{"type":"topic","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)."}],"role":"symbol","url":"\/documentation\/auth0\/webauth\/useephemeralsession()","kind":"symbol","title":"useEphemeralSession()","required":true,"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"useEphemeralSession"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","text":"Self"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()"},"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/clearSession(federated:)-3k5r3":{"url":"\/documentation\/auth0\/webauth\/clearsession(federated:)-3k5r3","kind":"symbol","type":"topic","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-3k5r3","title":"clearSession(federated:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"clearSession"},{"kind":"text","text":"("},{"kind":"externalParam","text":"federated"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"abstract":[{"text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session.","type":"text"}]},"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/WebAuth":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"title":"WebAuth","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"url":"\/documentation\/auth0\/webauth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"metadata":{"externalID":"s:5Auth07WebAuthPAAE12clearSession9federatedySb_tYaKF","extendedModule":"Auth0","symbolKind":"method","title":"clearSession(federated:)","role":"symbol","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"clearSession"},{"kind":"text","text":"("},{"kind":"externalParam","text":"federated"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"modules":[{"name":"Auth0"}]},"sections":[],"variants":[{"paths":["\/documentation\/auth0\/webauth\/clearsession(federated:)-3k5r3"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-3k5r3","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"type":"text","text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/authenticate\/login\/logout"],"anchor":"Related-Documentation"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"clearSession"},{"kind":"text","text":"("},{"kind":"externalParam","text":"federated"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":" = false) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"platforms":["iOS"],"languages":["swift"]}]},{"parameters":[{"name":"federated","content":[{"inlineContent":[{"type":"text","text":"If the identity provider session should be removed. Defaults to "},{"type":"codeVoice","code":"false"},{"type":"text","text":"."}],"type":"paragraph"}]}],"kind":"parameters"},{"content":[{"type":"heading","level":2,"anchor":"Usage","text":"Usage"},{"code":["do {"," try await Auth0.webAuth().clearSession()"," print(\"Session cookie cleared\")","} catch {"," print(\"Failed with: \\(error)\")","}"],"type":"codeListing","syntax":"swift"},{"inlineContent":[{"type":"text","text":"Remove both the Auth0 session and the identity provider session:"}],"type":"paragraph"},{"type":"codeListing","syntax":"swift","code":["try await Auth0.webAuth().clearSession(federated: true)"]},{"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"},{"type":"text","text":" "},{"type":"text","text":"settings in the "},{"isActive":true,"identifier":"https:\/\/manage.auth0.com\/#\/applications\/","type":"reference"},{"type":"text","text":"."}]}],"type":"aside","name":"Requires"},{"style":"note","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"You don’t need to call this method if you are using "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()","isActive":true},{"type":"text","text":" on login, because there will"},{"type":"text","text":" "},{"type":"text","text":"be no shared cookie to remove."}]}],"type":"aside","name":"Note"}],"kind":"content"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/useEphemeralSession()":{"url":"\/documentation\/auth0\/webauth\/useephemeralsession()","title":"useEphemeralSession()","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)."}],"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"useEphemeralSession"},{"text":"() -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()","required":true,"kind":"symbol","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"url":"\/documentation\/auth0\/webauth","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"title":"WebAuth","navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:)-3k5r3":{"url":"\/documentation\/auth0\/webauth\/clearsession(federated:)-3k5r3","title":"clearSession(federated:)","abstract":[{"text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session.","type":"text"}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"clearSession"},{"kind":"text","text":"("},{"kind":"externalParam","text":"federated"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-3k5r3","role":"symbol","kind":"symbol","type":"topic"},"https://auth0.com/docs/authenticate/login/logout":{"title":"Logout","identifier":"https:\/\/auth0.com\/docs\/authenticate\/login\/logout","titleInlineContent":[{"type":"text","text":"Logout"}],"type":"link","url":"https:\/\/auth0.com\/docs\/authenticate\/login\/logout"},"https://manage.auth0.com/#/applications/":{"title":"Dashboard","identifier":"https:\/\/manage.auth0.com\/#\/applications\/","titleInlineContent":[{"type":"text","text":"Dashboard"}],"type":"link","url":"https:\/\/manage.auth0.com\/#\/applications\/"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"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 058bee10d..35f0bfe38 100644 --- a/docs/data/documentation/auth0/webauth/clearsession(federated:)-4zqyr.json +++ b/docs/data/documentation/auth0/webauth/clearsession(federated:)-4zqyr.json @@ -1 +1 @@ -{"metadata":{"modules":[{"name":"Auth0"}],"required":true,"title":"clearSession(federated:)","symbolKind":"method","externalID":"s:5Auth07WebAuthP12clearSession9federated7Combine12AnyPublisherVyytAA0bC5ErrorVGSb_tF","role":"symbol","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"clearSession"},{"kind":"text","text":"("},{"kind":"externalParam","text":"federated"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"AnyPublisher","preciseIdentifier":"s:7Combine12AnyPublisherV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV"},{"kind":"text","text":">"}]},"sections":[],"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"clearSession","kind":"identifier"},{"text":"(","kind":"text"},{"text":"federated","kind":"externalParam"},{"text":": ","kind":"text"},{"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"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","text":"WebAuthError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV"},{"text":">","kind":"text"}],"platforms":["iOS"]}]},{"kind":"parameters","parameters":[{"name":"federated","content":[{"inlineContent":[{"type":"text","text":"If the identity provider session should be removed. Defaults to "},{"type":"codeVoice","code":"false"},{"type":"text","text":"."}],"type":"paragraph"}]}]},{"kind":"content","content":[{"type":"heading","level":2,"text":"Return Value","anchor":"return-value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A type-erased publisher."}]}]},{"kind":"content","content":[{"text":"Usage","level":2,"type":"heading","anchor":"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"},{"inlineContent":[{"text":"Remove both the Auth0 session and the identity provider session:","type":"text"}],"type":"paragraph"},{"syntax":"swift","code":["Auth0"," .webAuth()"," .clearSession(federated: true)"," .sink(receiveCompletion: { print($0) },"," receiveValue: {})"," .store(in: &cancellables)"],"type":"codeListing"},{"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 "},{"type":"strong","inlineContent":[{"type":"text","text":"Allowed Logout URLs"}]},{"type":"text","text":" field of your Auth0 application"},{"type":"text","text":" "},{"type":"text","text":"settings in the "},{"identifier":"https:\/\/manage.auth0.com\/#\/applications\/","type":"reference","isActive":true},{"type":"text","text":"."}]}],"name":"Requires","style":"note","type":"aside"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"You don’t need to call this method if you are using "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()","isActive":true,"type":"reference"},{"type":"text","text":" on login, because there will"},{"type":"text","text":" "},{"type":"text","text":"be no shared cookie to remove."}]}],"name":"Note","style":"note","type":"aside"}]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-4zqyr"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"defaultImplementationsSections":[{"anchor":"WebAuth-Implementations","title":"WebAuth Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-6n4z6","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-3k5r3"]}],"seeAlsoSections":[{"anchor":"Related-Documentation","title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/authenticate\/login\/logout"]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/clearsession(federated:)-4zqyr"]}],"abstract":[{"type":"text","text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:)-6n4z6":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-6n4z6","kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"clearSession"},{"kind":"text","text":"("},{"kind":"externalParam","text":"federated"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"AnyPublisher","preciseIdentifier":"s:7Combine12AnyPublisherV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV"},{"kind":"text","text":">"}],"url":"\/documentation\/auth0\/webauth\/clearsession(federated:)-6n4z6","abstract":[{"text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session.","type":"text"}],"type":"topic","title":"clearSession(federated:)","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:)-3k5r3":{"url":"\/documentation\/auth0\/webauth\/clearsession(federated:)-3k5r3","kind":"symbol","type":"topic","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-3k5r3","title":"clearSession(federated:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"clearSession"},{"kind":"text","text":"("},{"kind":"externalParam","text":"federated"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"abstract":[{"text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"title":"WebAuth","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"url":"\/documentation\/auth0\/webauth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/useEphemeralSession()":{"type":"topic","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)."}],"role":"symbol","url":"\/documentation\/auth0\/webauth\/useephemeralsession()","kind":"symbol","title":"useEphemeralSession()","required":true,"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"useEphemeralSession"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","text":"Self"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"abstract":[{"text":"Represents an error during a Web Auth operation.","type":"text"}],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"type":"topic","role":"symbol","navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","title":"WebAuthError","url":"\/documentation\/auth0\/webautherror"},"https://auth0.com/docs/authenticate/login/logout":{"identifier":"https:\/\/auth0.com\/docs\/authenticate\/login\/logout","title":"Logout","titleInlineContent":[{"text":"Logout","type":"text"}],"url":"https:\/\/auth0.com\/docs\/authenticate\/login\/logout","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:)-4zqyr":{"url":"\/documentation\/auth0\/webauth\/clearsession(federated:)-4zqyr","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-4zqyr","kind":"symbol","abstract":[{"text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session.","type":"text"}],"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"clearSession"},{"kind":"text","text":"("},{"kind":"externalParam","text":"federated"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"AnyPublisher","preciseIdentifier":"s:7Combine12AnyPublisherV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV"},{"kind":"text","text":">"}],"defaultImplementations":2,"title":"clearSession(federated:)","required":true},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"https://manage.auth0.com/#/applications/":{"identifier":"https:\/\/manage.auth0.com\/#\/applications\/","title":"Dashboard","titleInlineContent":[{"text":"Dashboard","type":"text"}],"url":"https:\/\/manage.auth0.com\/#\/applications\/","type":"link"}}} \ No newline at end of file +{"metadata":{"symbolKind":"method","modules":[{"name":"Auth0"}],"title":"clearSession(federated:)","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"},{"text":") -> ","kind":"text"},{"text":"AnyPublisher","kind":"typeIdentifier","preciseIdentifier":"s:7Combine12AnyPublisherV"},{"text":"<","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":", ","kind":"text"},{"text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"externalID":"s:5Auth07WebAuthP12clearSession9federated7Combine12AnyPublisherVyytAA0bC5ErrorVGSb_tF","required":true,"role":"symbol","roleHeading":"Instance Method"},"sections":[],"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","anchor":"WebAuth-Implementations"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-4zqyr","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session.","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/authenticate\/login\/logout"],"anchor":"Related-Documentation","title":"Related Documentation"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"clearSession","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"federated"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":") -> "},{"text":"AnyPublisher","kind":"typeIdentifier","preciseIdentifier":"s:7Combine12AnyPublisherV"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:s4Voida","kind":"typeIdentifier","text":"Void"},{"kind":"text","text":", "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","text":"WebAuthError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV"},{"kind":"text","text":">"}]}]},{"kind":"parameters","parameters":[{"name":"federated","content":[{"inlineContent":[{"type":"text","text":"If the identity provider session should be removed. Defaults to "},{"type":"codeVoice","code":"false"},{"type":"text","text":"."}],"type":"paragraph"}]}]},{"content":[{"type":"heading","level":2,"anchor":"return-value","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A type-erased publisher."}]}],"kind":"content"},{"content":[{"type":"heading","level":2,"anchor":"Usage","text":"Usage"},{"type":"codeListing","syntax":"swift","code":["Auth0"," .webAuth()"," .clearSession()"," .sink(receiveCompletion: { completion in"," switch completion {"," case .finished:"," print(\"Session cookie cleared\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }, receiveValue: {})"," .store(in: &cancellables)"]},{"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)"," .sink(receiveCompletion: { print($0) },"," receiveValue: {})"," .store(in: &cancellables)"]},{"type":"aside","content":[{"type":"paragraph","inlineContent":[{"text":"The ","type":"text"},{"inlineContent":[{"type":"text","text":"Callback URL"}],"type":"strong"},{"text":" to have been added to the ","type":"text"},{"inlineContent":[{"type":"text","text":"Allowed Logout URLs"}],"type":"strong"},{"text":" field of your Auth0 application","type":"text"},{"text":" ","type":"text"},{"text":"settings in the ","type":"text"},{"identifier":"https:\/\/manage.auth0.com\/#\/applications\/","type":"reference","isActive":true},{"type":"text","text":"."}]}],"style":"note","name":"Requires"},{"type":"aside","style":"note","content":[{"inlineContent":[{"type":"text","text":"You don’t need to call this method if you are using "},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()"},{"type":"text","text":" on login, because there will"},{"type":"text","text":" "},{"type":"text","text":"be no shared cookie to remove."}],"type":"paragraph"}],"name":"Note"}],"kind":"content"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"https://auth0.com/docs/authenticate/login/logout":{"title":"Logout","url":"https:\/\/auth0.com\/docs\/authenticate\/login\/logout","type":"link","identifier":"https:\/\/auth0.com\/docs\/authenticate\/login\/logout","titleInlineContent":[{"type":"text","text":"Logout"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/useEphemeralSession()":{"url":"\/documentation\/auth0\/webauth\/useephemeralsession()","title":"useEphemeralSession()","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)."}],"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"useEphemeralSession"},{"text":"() -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()","required":true,"kind":"symbol","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"url":"\/documentation\/auth0\/webautherror","abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"title":"WebAuthError","navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:)-3k5r3":{"url":"\/documentation\/auth0\/webauth\/clearsession(federated:)-3k5r3","title":"clearSession(federated:)","abstract":[{"text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session.","type":"text"}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"clearSession"},{"kind":"text","text":"("},{"kind":"externalParam","text":"federated"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-3k5r3","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"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/clearSession(federated:)-4zqyr":{"defaultImplementations":2,"type":"topic","title":"clearSession(federated:)","url":"\/documentation\/auth0\/webauth\/clearsession(federated:)-4zqyr","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-4zqyr","kind":"symbol","abstract":[{"type":"text","text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session."}],"required":true,"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"clearSession"},{"kind":"text","text":"("},{"kind":"externalParam","text":"federated"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:7Combine12AnyPublisherV","kind":"typeIdentifier","text":"AnyPublisher"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:s4Voida","kind":"typeIdentifier","text":"Void"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier","text":"WebAuthError"},{"kind":"text","text":">"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"url":"\/documentation\/auth0\/webauth","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"title":"WebAuth","navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:)-6n4z6":{"title":"clearSession(federated:)","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-6n4z6","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"clearSession","kind":"identifier"},{"kind":"text","text":"("},{"text":"federated","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"AnyPublisher","preciseIdentifier":"s:7Combine12AnyPublisherV"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV"},{"kind":"text","text":">"}],"abstract":[{"text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session.","type":"text"}],"url":"\/documentation\/auth0\/webauth\/clearsession(federated:)-6n4z6"}}} \ 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 1441882ed..461fb3d46 100644 --- a/docs/data/documentation/auth0/webauth/clearsession(federated:)-6n4z6.json +++ b/docs/data/documentation/auth0/webauth/clearsession(federated:)-6n4z6.json @@ -1 +1 @@ -{"seeAlsoSections":[{"anchor":"Related-Documentation","identifiers":["https:\/\/auth0.com\/docs\/authenticate\/login\/logout"],"title":"Related Documentation"}],"metadata":{"role":"symbol","symbolKind":"method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"clearSession"},{"kind":"text","text":"("},{"kind":"externalParam","text":"federated"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"AnyPublisher","preciseIdentifier":"s:7Combine12AnyPublisherV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV"},{"kind":"text","text":">"}],"roleHeading":"Instance Method","modules":[{"name":"Auth0"}],"externalID":"s:5Auth07WebAuthPAAE12clearSession9federated7Combine12AnyPublisherVyytAA0bC5ErrorVGSb_tF","extendedModule":"Auth0","title":"clearSession(federated:)"},"kind":"symbol","schemaVersion":{"patch":0,"minor":3,"major":0},"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":" "},{"kind":"identifier","text":"clearSession"},{"kind":"text","text":"("},{"kind":"externalParam","text":"federated"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":" = false) -> "},{"kind":"typeIdentifier","text":"AnyPublisher","preciseIdentifier":"s:7Combine12AnyPublisherV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":", "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","kind":"typeIdentifier","text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV"},{"kind":"text","text":">"}],"languages":["swift"]}],"kind":"declarations"},{"parameters":[{"name":"federated","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"If the identity provider session should be removed. Defaults to "},{"type":"codeVoice","code":"false"},{"type":"text","text":"."}]}]}],"kind":"parameters"},{"kind":"content","content":[{"type":"heading","level":2,"text":"Return Value","anchor":"return-value"},{"type":"paragraph","inlineContent":[{"text":"A type-erased publisher.","type":"text"}]}]},{"kind":"content","content":[{"level":2,"text":"Usage","type":"heading","anchor":"Usage"},{"code":["Auth0"," .webAuth()"," .clearSession()"," .sink(receiveCompletion: { completion in"," switch completion {"," case .finished:"," print(\"Session cookie cleared\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"," }, receiveValue: {})"," .store(in: &cancellables)"],"syntax":"swift","type":"codeListing"},{"inlineContent":[{"text":"Remove both the Auth0 session and the identity provider session:","type":"text"}],"type":"paragraph"},{"code":["Auth0"," .webAuth()"," .clearSession(federated: true)"," .sink(receiveCompletion: { print($0) },"," receiveValue: {})"," .store(in: &cancellables)"],"syntax":"swift","type":"codeListing"},{"content":[{"type":"paragraph","inlineContent":[{"text":"The ","type":"text"},{"inlineContent":[{"text":"Callback URL","type":"text"}],"type":"strong"},{"text":" to have been added to the ","type":"text"},{"inlineContent":[{"type":"text","text":"Allowed Logout URLs"}],"type":"strong"},{"text":" field of your Auth0 application","type":"text"},{"text":" ","type":"text"},{"text":"settings in the ","type":"text"},{"isActive":true,"identifier":"https:\/\/manage.auth0.com\/#\/applications\/","type":"reference"},{"text":".","type":"text"}]}],"style":"note","name":"Requires","type":"aside"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"You don’t need to call this method if you are using "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()"},{"type":"text","text":" on login, because there will"},{"type":"text","text":" "},{"type":"text","text":"be no shared cookie to remove."}]}],"style":"note","name":"Note","type":"aside"}]}],"abstract":[{"type":"text","text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/clearsession(federated:)-6n4z6"]}],"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-6n4z6"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"title":"WebAuth","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"url":"\/documentation\/auth0\/webauth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:)-6n4z6":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-6n4z6","kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"clearSession"},{"kind":"text","text":"("},{"kind":"externalParam","text":"federated"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"AnyPublisher","preciseIdentifier":"s:7Combine12AnyPublisherV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV"},{"kind":"text","text":">"}],"url":"\/documentation\/auth0\/webauth\/clearsession(federated:)-6n4z6","abstract":[{"text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session.","type":"text"}],"type":"topic","title":"clearSession(federated:)","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"https://auth0.com/docs/authenticate/login/logout":{"url":"https:\/\/auth0.com\/docs\/authenticate\/login\/logout","type":"link","identifier":"https:\/\/auth0.com\/docs\/authenticate\/login\/logout","title":"Logout","titleInlineContent":[{"type":"text","text":"Logout"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"abstract":[{"text":"Represents an error during a Web Auth operation.","type":"text"}],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"type":"topic","role":"symbol","navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","title":"WebAuthError","url":"\/documentation\/auth0\/webautherror"},"https://manage.auth0.com/#/applications/":{"url":"https:\/\/manage.auth0.com\/#\/applications\/","title":"Dashboard","titleInlineContent":[{"type":"text","text":"Dashboard"}],"identifier":"https:\/\/manage.auth0.com\/#\/applications\/","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/useEphemeralSession()":{"type":"topic","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)."}],"role":"symbol","url":"\/documentation\/auth0\/webauth\/useephemeralsession()","kind":"symbol","title":"useEphemeralSession()","required":true,"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"useEphemeralSession"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","text":"Self"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()"}}} \ No newline at end of file +{"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-6n4z6"},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"clearSession","kind":"identifier"},{"text":"(","kind":"text"},{"text":"federated","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":" = false) -> ","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","text":"WebAuthError","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"},{"text":">","kind":"text"}],"platforms":["iOS"]}]},{"parameters":[{"content":[{"inlineContent":[{"type":"text","text":"If the identity provider session should be removed. Defaults to "},{"type":"codeVoice","code":"false"},{"type":"text","text":"."}],"type":"paragraph"}],"name":"federated"}],"kind":"parameters"},{"kind":"content","content":[{"text":"Return Value","level":2,"type":"heading","anchor":"return-value"},{"inlineContent":[{"text":"A type-erased publisher.","type":"text"}],"type":"paragraph"}]},{"kind":"content","content":[{"text":"Usage","level":2,"type":"heading","anchor":"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"},{"inlineContent":[{"text":"Remove both the Auth0 session and the identity provider session:","type":"text"}],"type":"paragraph"},{"syntax":"swift","code":["Auth0"," .webAuth()"," .clearSession(federated: true)"," .sink(receiveCompletion: { print($0) },"," receiveValue: {})"," .store(in: &cancellables)"],"type":"codeListing"},{"content":[{"inlineContent":[{"type":"text","text":"The "},{"inlineContent":[{"type":"text","text":"Callback URL"}],"type":"strong"},{"type":"text","text":" to have been added to the "},{"inlineContent":[{"type":"text","text":"Allowed Logout URLs"}],"type":"strong"},{"type":"text","text":" field of your Auth0 application"},{"type":"text","text":" "},{"type":"text","text":"settings in the "},{"identifier":"https:\/\/manage.auth0.com\/#\/applications\/","type":"reference","isActive":true},{"type":"text","text":"."}],"type":"paragraph"}],"style":"note","name":"Requires","type":"aside"},{"content":[{"inlineContent":[{"type":"text","text":"You don’t need to call this method if you are using "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()","type":"reference","isActive":true},{"type":"text","text":" on login, because there will"},{"type":"text","text":" "},{"type":"text","text":"be no shared cookie to remove."}],"type":"paragraph"}],"style":"note","name":"Note","type":"aside"}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/clearsession(federated:)-6n4z6"]}],"kind":"symbol","metadata":{"modules":[{"name":"Auth0"}],"title":"clearSession(federated:)","externalID":"s:5Auth07WebAuthPAAE12clearSession9federated7Combine12AnyPublisherVyytAA0bC5ErrorVGSb_tF","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"clearSession","kind":"identifier"},{"text":"(","kind":"text"},{"text":"federated","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"AnyPublisher","preciseIdentifier":"s:7Combine12AnyPublisherV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"Void","preciseIdentifier":"s:s4Voida","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"extendedModule":"Auth0","roleHeading":"Instance Method","symbolKind":"method"},"schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session.","type":"text"}],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/authenticate\/login\/logout"],"anchor":"Related-Documentation"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"references":{"https://auth0.com/docs/authenticate/login/logout":{"title":"Logout","titleInlineContent":[{"type":"text","text":"Logout"}],"url":"https:\/\/auth0.com\/docs\/authenticate\/login\/logout","identifier":"https:\/\/auth0.com\/docs\/authenticate\/login\/logout","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:)-6n4z6":{"title":"clearSession(federated:)","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-6n4z6","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"clearSession","kind":"identifier"},{"kind":"text","text":"("},{"text":"federated","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"AnyPublisher","preciseIdentifier":"s:7Combine12AnyPublisherV"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV"},{"kind":"text","text":">"}],"abstract":[{"text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session.","type":"text"}],"url":"\/documentation\/auth0\/webauth\/clearsession(federated:)-6n4z6"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/useEphemeralSession()":{"url":"\/documentation\/auth0\/webauth\/useephemeralsession()","title":"useEphemeralSession()","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)."}],"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"useEphemeralSession"},{"text":"() -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()","required":true,"kind":"symbol","role":"symbol","type":"topic"},"https://manage.auth0.com/#/applications/":{"title":"Dashboard","type":"link","titleInlineContent":[{"type":"text","text":"Dashboard"}],"identifier":"https:\/\/manage.auth0.com\/#\/applications\/","url":"https:\/\/manage.auth0.com\/#\/applications\/"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"url":"\/documentation\/auth0\/webauth","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"title":"WebAuth","navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"url":"\/documentation\/auth0\/webautherror","abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"title":"WebAuthError","navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","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 7de444722..86287db24 100644 --- a/docs/data/documentation/auth0/webauth/clearsession(federated:)-8sl1o.json +++ b/docs/data/documentation/auth0/webauth/clearsession(federated:)-8sl1o.json @@ -1 +1 @@ -{"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"],"anchor":"WebAuth-Implementations"}],"sections":[],"abstract":[{"type":"text","text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session."}],"kind":"symbol","seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/authenticate\/login\/logout"],"anchor":"Related-Documentation"}],"primaryContentSections":[{"declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"clearSession","kind":"identifier"},{"text":"(","kind":"text"},{"text":"federated","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"},{"parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"If the identity provider session should be removed. Defaults to "},{"type":"codeVoice","code":"false"},{"type":"text","text":"."}]}],"name":"federated"}],"kind":"parameters"},{"kind":"content","content":[{"anchor":"Usage","text":"Usage","type":"heading","level":2},{"syntax":"swift","type":"codeListing","code":["do {"," try await Auth0.webAuth().clearSession()"," print(\"Session cookie cleared\")","} catch {"," print(\"Failed with: \\(error)\")","}"]},{"inlineContent":[{"text":"Remove both the Auth0 session and the identity provider session:","type":"text"}],"type":"paragraph"},{"syntax":"swift","type":"codeListing","code":["try await Auth0.webAuth().clearSession(federated: true)"]},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"inlineContent":[{"type":"text","text":"Callback URL"}],"type":"strong"},{"type":"text","text":" to have been added to the "},{"inlineContent":[{"type":"text","text":"Allowed Logout URLs"}],"type":"strong"},{"type":"text","text":" field of your Auth0 application"},{"type":"text","text":" "},{"type":"text","text":"settings in the "},{"isActive":true,"type":"reference","identifier":"https:\/\/manage.auth0.com\/#\/applications\/"},{"type":"text","text":"."}]}],"style":"note","type":"aside","name":"Requires"},{"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"},{"text":" ","type":"text"},{"text":"be no shared cookie to remove.","type":"text"}]}],"style":"note","type":"aside","name":"Note"}]}],"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\/clearSession(federated:)-8sl1o"},"schemaVersion":{"minor":3,"patch":0,"major":0},"metadata":{"symbolKind":"method","title":"clearSession(federated:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"clearSession","kind":"identifier"},{"text":"(","kind":"text"},{"text":"federated","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"}],"required":true,"role":"symbol","modules":[{"name":"Auth0"}],"externalID":"s:5Auth07WebAuthP12clearSession9federatedySb_tYaKF","roleHeading":"Instance Method"},"variants":[{"paths":["\/documentation\/auth0\/webauth\/clearsession(federated:)-8sl1o"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"https://auth0.com/docs/authenticate/login/logout":{"url":"https:\/\/auth0.com\/docs\/authenticate\/login\/logout","identifier":"https:\/\/auth0.com\/docs\/authenticate\/login\/logout","titleInlineContent":[{"text":"Logout","type":"text"}],"type":"link","title":"Logout"},"https://manage.auth0.com/#/applications/":{"identifier":"https:\/\/manage.auth0.com\/#\/applications\/","url":"https:\/\/manage.auth0.com\/#\/applications\/","title":"Dashboard","type":"link","titleInlineContent":[{"text":"Dashboard","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/useEphemeralSession()":{"type":"topic","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)."}],"role":"symbol","url":"\/documentation\/auth0\/webauth\/useephemeralsession()","kind":"symbol","title":"useEphemeralSession()","required":true,"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"useEphemeralSession"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","text":"Self"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:)-6n4z6":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-6n4z6","kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"clearSession"},{"kind":"text","text":"("},{"kind":"externalParam","text":"federated"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"AnyPublisher","preciseIdentifier":"s:7Combine12AnyPublisherV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV"},{"kind":"text","text":">"}],"url":"\/documentation\/auth0\/webauth\/clearsession(federated:)-6n4z6","abstract":[{"text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session.","type":"text"}],"type":"topic","title":"clearSession(federated:)","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"title":"WebAuth","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"url":"\/documentation\/auth0\/webauth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:)-3k5r3":{"url":"\/documentation\/auth0\/webauth\/clearsession(federated:)-3k5r3","kind":"symbol","type":"topic","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-3k5r3","title":"clearSession(federated:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"clearSession"},{"kind":"text","text":"("},{"kind":"externalParam","text":"federated"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"abstract":[{"text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:)-8sl1o":{"url":"\/documentation\/auth0\/webauth\/clearsession(federated:)-8sl1o","required":true,"title":"clearSession(federated:)","role":"symbol","abstract":[{"text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session.","type":"text"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"clearSession","kind":"identifier"},{"text":"(","kind":"text"},{"text":"federated","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-8sl1o","defaultImplementations":2,"kind":"symbol"}}} \ No newline at end of file +{"metadata":{"modules":[{"name":"Auth0"}],"title":"clearSession(federated:)","roleHeading":"Instance Method","symbolKind":"method","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"clearSession"},{"kind":"text","text":"("},{"kind":"externalParam","text":"federated"},{"kind":"text","text":": "},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"required":true,"externalID":"s:5Auth07WebAuthP12clearSession9federatedySb_tYaKF"},"sections":[],"variants":[{"paths":["\/documentation\/auth0\/webauth\/clearsession(federated:)-8sl1o"],"traits":[{"interfaceLanguage":"swift"}]}],"defaultImplementationsSections":[{"anchor":"WebAuth-Implementations","title":"WebAuth Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-3k5r3","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-6n4z6"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-8sl1o"},"kind":"symbol","abstract":[{"text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session.","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/authenticate\/login\/logout"],"anchor":"Related-Documentation"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"clearSession"},{"kind":"text","text":"("},{"kind":"externalParam","text":"federated"},{"kind":"text","text":": "},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"languages":["swift"],"platforms":["iOS"]}]},{"parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"If the identity provider session should be removed. Defaults to "},{"type":"codeVoice","code":"false"},{"text":".","type":"text"}]}],"name":"federated"}],"kind":"parameters"},{"content":[{"type":"heading","text":"Usage","anchor":"Usage","level":2},{"code":["do {"," try await Auth0.webAuth().clearSession()"," print(\"Session cookie cleared\")","} catch {"," print(\"Failed with: \\(error)\")","}"],"type":"codeListing","syntax":"swift"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Remove both the Auth0 session and the identity provider session:"}]},{"type":"codeListing","syntax":"swift","code":["try await Auth0.webAuth().clearSession(federated: true)"]},{"type":"aside","content":[{"inlineContent":[{"type":"text","text":"The "},{"type":"strong","inlineContent":[{"type":"text","text":"Callback URL"}]},{"type":"text","text":" to have been added to the "},{"type":"strong","inlineContent":[{"type":"text","text":"Allowed Logout URLs"}]},{"type":"text","text":" field of your Auth0 application"},{"type":"text","text":" "},{"type":"text","text":"settings in the "},{"isActive":true,"type":"reference","identifier":"https:\/\/manage.auth0.com\/#\/applications\/"},{"type":"text","text":"."}],"type":"paragraph"}],"name":"Requires","style":"note"},{"type":"aside","content":[{"inlineContent":[{"type":"text","text":"You don’t need to call this method if you are using "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()","isActive":true,"type":"reference"},{"text":" on login, because there will","type":"text"},{"text":" ","type":"text"},{"text":"be no shared cookie to remove.","type":"text"}],"type":"paragraph"}],"name":"Note","style":"note"}],"kind":"content"}],"schemaVersion":{"minor":3,"patch":0,"major":0},"references":{"https://auth0.com/docs/authenticate/login/logout":{"title":"Logout","url":"https:\/\/auth0.com\/docs\/authenticate\/login\/logout","type":"link","identifier":"https:\/\/auth0.com\/docs\/authenticate\/login\/logout","titleInlineContent":[{"text":"Logout","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:)-6n4z6":{"title":"clearSession(federated:)","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-6n4z6","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"clearSession","kind":"identifier"},{"kind":"text","text":"("},{"text":"federated","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"AnyPublisher","preciseIdentifier":"s:7Combine12AnyPublisherV"},{"text":"<","kind":"text"},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV"},{"kind":"text","text":">"}],"abstract":[{"text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session.","type":"text"}],"url":"\/documentation\/auth0\/webauth\/clearsession(federated:)-6n4z6"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/useEphemeralSession()":{"url":"\/documentation\/auth0\/webauth\/useephemeralsession()","title":"useEphemeralSession()","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)."}],"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"useEphemeralSession"},{"text":"() -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()","required":true,"kind":"symbol","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:)-3k5r3":{"url":"\/documentation\/auth0\/webauth\/clearsession(federated:)-3k5r3","title":"clearSession(federated:)","abstract":[{"text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session.","type":"text"}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"clearSession"},{"kind":"text","text":"("},{"kind":"externalParam","text":"federated"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-3k5r3","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"url":"\/documentation\/auth0\/webauth","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"title":"WebAuth","navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","role":"symbol","kind":"symbol","type":"topic"},"https://manage.auth0.com/#/applications/":{"title":"Dashboard","titleInlineContent":[{"type":"text","text":"Dashboard"}],"url":"https:\/\/manage.auth0.com\/#\/applications\/","identifier":"https:\/\/manage.auth0.com\/#\/applications\/","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:)-8sl1o":{"url":"\/documentation\/auth0\/webauth\/clearsession(federated:)-8sl1o","required":true,"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"clearSession"},{"kind":"text","text":"("},{"kind":"externalParam","text":"federated"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"}],"title":"clearSession(federated:)","type":"topic","defaultImplementations":2,"role":"symbol","abstract":[{"text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:)-8sl1o","kind":"symbol"}}} \ 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 4b586910c..9c9313ecc 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 @@ -{"variants":[{"paths":["\/documentation\/auth0\/webauth\/clearsession(federated:callback:)-9yv61"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","seeAlsoSections":[{"title":"Related Documentation","anchor":"Related-Documentation","identifiers":["https:\/\/auth0.com\/docs\/authenticate\/login\/logout"]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"clearSession"},{"kind":"text","text":"("},{"kind":"externalParam","text":"federated"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":" = false, "},{"kind":"externalParam","text":"callback"},{"kind":"text","text":": "},{"kind":"attribute","text":"@escaping"},{"kind":"text","text":" ("},{"kind":"typeIdentifier","text":"WebAuthResult","preciseIdentifier":"s:5Auth013WebAuthResulta","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":">) -> "},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":")"}]}]},{"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"},{"code":"Result","type":"codeVoice"},{"text":" containing either an empty success case or an error.","type":"text"}]}]}]},{"kind":"content","content":[{"type":"heading","anchor":"Usage","level":2,"text":"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":[{"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) }"]},{"type":"aside","style":"note","name":"Requires","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 "},{"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 "},{"type":"reference","isActive":true,"identifier":"https:\/\/manage.auth0.com\/#\/applications\/"},{"type":"text","text":"."}]}]},{"type":"aside","style":"note","name":"Note","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"You don’t need to call this method if you are using "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()"},{"type":"text","text":" on login, because there will"},{"type":"text","text":" "},{"type":"text","text":"be no shared cookie to remove."}]}]}]}],"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\/clearSession(federated:callback:)-9yv61"},"metadata":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"clearSession","kind":"identifier"},{"text":"(","kind":"text"},{"text":"federated","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"callback","kind":"externalParam"},{"text":": (","kind":"text"},{"preciseIdentifier":"s:5Auth013WebAuthResulta","text":"WebAuthResult","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":">) -> "},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":")"}],"extendedModule":"Auth0","modules":[{"name":"Auth0"}],"title":"clearSession(federated:callback:)","role":"symbol","externalID":"s:5Auth07WebAuthPAAE12clearSession9federated8callbackySb_ys6ResultOyytAA0bC5ErrorVGctF","roleHeading":"Instance Method","symbolKind":"method"},"sections":[],"abstract":[{"text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session.","type":"text"}],"references":{"https://auth0.com/docs/authenticate/login/logout":{"url":"https:\/\/auth0.com\/docs\/authenticate\/login\/logout","titleInlineContent":[{"text":"Logout","type":"text"}],"type":"link","title":"Logout","identifier":"https:\/\/auth0.com\/docs\/authenticate\/login\/logout"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"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"},{"text":"federated","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"callback","kind":"externalParam"},{"text":": (","kind":"text"},{"preciseIdentifier":"s:5Auth013WebAuthResulta","text":"WebAuthResult","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"text":">) -> ","kind":"text"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"text":")","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:callback:)-9yv61","abstract":[{"text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session.","type":"text"}],"url":"\/documentation\/auth0\/webauth\/clearsession(federated:callback:)-9yv61","type":"topic","kind":"symbol","title":"clearSession(federated:callback:)","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/useEphemeralSession()":{"type":"topic","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)."}],"role":"symbol","url":"\/documentation\/auth0\/webauth\/useephemeralsession()","kind":"symbol","title":"useEphemeralSession()","required":true,"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"useEphemeralSession"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","text":"Self"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthResult":{"url":"\/documentation\/auth0\/webauthresult","navigatorTitle":[{"text":"WebAuthResult","kind":"identifier"}],"title":"WebAuthResult","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult","abstract":[{"code":"Result","type":"codeVoice"},{"text":" wrapper for Web Auth operations.","type":"text"}],"type":"topic","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthResult","kind":"identifier"}],"kind":"symbol","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"title":"WebAuth","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"url":"\/documentation\/auth0\/webauth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"kind":"symbol"},"https://manage.auth0.com/#/applications/":{"url":"https:\/\/manage.auth0.com\/#\/applications\/","identifier":"https:\/\/manage.auth0.com\/#\/applications\/","title":"Dashboard","titleInlineContent":[{"type":"text","text":"Dashboard"}],"type":"link"}}} \ No newline at end of file +{"variants":[{"paths":["\/documentation\/auth0\/webauth\/clearsession(federated:callback:)-9yv61"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"abstract":[{"text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session.","type":"text"}],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","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"},{"text":": ","kind":"text"},{"kind":"attribute","text":"@escaping"},{"text":" (","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult","text":"WebAuthResult","kind":"typeIdentifier","preciseIdentifier":"s:5Auth013WebAuthResulta"},{"text":"<","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":">) -> "},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":")"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"federated","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"If the identity provider session should be removed. Defaults to "},{"type":"codeVoice","code":"false"},{"type":"text","text":"."}]}]},{"name":"callback","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."}]}]}]},{"content":[{"level":2,"anchor":"Usage","type":"heading","text":"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"},{"inlineContent":[{"type":"text","text":"Remove both the Auth0 session and the identity provider session:"}],"type":"paragraph"},{"type":"codeListing","syntax":"swift","code":["Auth0"," .webAuth()"," .clearSession(federated: true) { print($0) }"]},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"type":"strong","inlineContent":[{"type":"text","text":"Callback URL"}]},{"type":"text","text":" to have been added to the "},{"type":"strong","inlineContent":[{"type":"text","text":"Allowed Logout URLs"}]},{"type":"text","text":" field of your Auth0 application"},{"type":"text","text":" "},{"type":"text","text":"settings in the "},{"type":"reference","identifier":"https:\/\/manage.auth0.com\/#\/applications\/","isActive":true},{"type":"text","text":"."}]}],"type":"aside","name":"Requires","style":"note"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"You don’t need to call this method if you are using "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()","isActive":true},{"type":"text","text":" on login, because there will"},{"type":"text","text":" "},{"type":"text","text":"be no shared cookie to remove."}]}],"type":"aside","name":"Note","style":"note"}],"kind":"content"}],"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/authenticate\/login\/logout"],"title":"Related Documentation","anchor":"Related-Documentation"}],"metadata":{"externalID":"s:5Auth07WebAuthPAAE12clearSession9federated8callbackySb_ys6ResultOyytAA0bC5ErrorVGctF","extendedModule":"Auth0","symbolKind":"method","title":"clearSession(federated:callback:)","roleHeading":"Instance Method","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"clearSession"},{"kind":"text","text":"("},{"kind":"externalParam","text":"federated"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":", "},{"kind":"externalParam","text":"callback"},{"kind":"text","text":": ("},{"kind":"typeIdentifier","text":"WebAuthResult","preciseIdentifier":"s:5Auth013WebAuthResulta"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":">) -> "},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":")"}],"modules":[{"name":"Auth0"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:callback:)-9yv61","interfaceLanguage":"swift"},"references":{"https://manage.auth0.com/#/applications/":{"title":"Dashboard","identifier":"https:\/\/manage.auth0.com\/#\/applications\/","titleInlineContent":[{"type":"text","text":"Dashboard"}],"type":"link","url":"https:\/\/manage.auth0.com\/#\/applications\/"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"https://auth0.com/docs/authenticate/login/logout":{"title":"Logout","identifier":"https:\/\/auth0.com\/docs\/authenticate\/login\/logout","titleInlineContent":[{"type":"text","text":"Logout"}],"type":"link","url":"https:\/\/auth0.com\/docs\/authenticate\/login\/logout"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthResult":{"url":"\/documentation\/auth0\/webauthresult","title":"WebAuthResult","abstract":[{"code":"Result","type":"codeVoice"},{"type":"text","text":" wrapper for Web Auth operations."}],"navigatorTitle":[{"text":"WebAuthResult","kind":"identifier"}],"fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthResult","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/useEphemeralSession()":{"url":"\/documentation\/auth0\/webauth\/useephemeralsession()","title":"useEphemeralSession()","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)."}],"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"useEphemeralSession"},{"text":"() -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()","required":true,"kind":"symbol","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:callback:)-9yv61":{"role":"symbol","title":"clearSession(federated:callback:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"clearSession"},{"kind":"text","text":"("},{"text":"federated","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"callback","kind":"externalParam"},{"text":": (","kind":"text"},{"preciseIdentifier":"s:5Auth013WebAuthResulta","text":"WebAuthResult","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"text":">) -> ","kind":"text"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"text":")","kind":"text"}],"abstract":[{"text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session.","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/webauth\/clearsession(federated:callback:)-9yv61","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:callback:)-9yv61","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"url":"\/documentation\/auth0\/webauth","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"title":"WebAuth","navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","role":"symbol","kind":"symbol","type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webauth/clearsession(federated:callback:).json b/docs/data/documentation/auth0/webauth/clearsession(federated:callback:).json index 5519baf8b..c14a7dae0 100644 --- a/docs/data/documentation/auth0/webauth/clearsession(federated:callback:).json +++ b/docs/data/documentation/auth0/webauth/clearsession(federated:callback:).json @@ -1 +1 @@ -{"kind":"symbol","defaultImplementationsSections":[{"title":"WebAuth Implementations","anchor":"WebAuth-Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:callback:)-9yv61"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"clearSession","kind":"identifier"},{"text":"(","kind":"text"},{"text":"federated","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"text":", ","kind":"text"},{"text":"callback","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"@escaping","kind":"attribute"},{"text":" (","kind":"text"},{"preciseIdentifier":"s:5Auth013WebAuthResulta","text":"WebAuthResult","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"text":">) -> ","kind":"text"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"text":")","kind":"text"}]}]},{"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":[{"inlineContent":[{"text":"Callback that receives a ","type":"text"},{"code":"Result","type":"codeVoice"},{"text":" containing either an empty success case or an error.","type":"text"}],"type":"paragraph"}],"name":"callback"}]},{"kind":"content","content":[{"text":"Usage","anchor":"Usage","type":"heading","level":2},{"syntax":"swift","type":"codeListing","code":["Auth0"," .webAuth()"," .clearSession { result in"," switch result {"," case .success:"," print(\"Session cookie cleared\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"]},{"type":"paragraph","inlineContent":[{"text":"Remove both the Auth0 session and the identity provider session:","type":"text"}]},{"syntax":"swift","type":"codeListing","code":["Auth0"," .webAuth()"," .clearSession(federated: true) { print($0) }"]},{"content":[{"inlineContent":[{"type":"text","text":"The "},{"type":"strong","inlineContent":[{"text":"Callback URL","type":"text"}]},{"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"},{"type":"text","text":" "},{"type":"text","text":"settings in the "},{"type":"reference","identifier":"https:\/\/manage.auth0.com\/#\/applications\/","isActive":true},{"type":"text","text":"."}],"type":"paragraph"}],"name":"Requires","type":"aside","style":"note"},{"content":[{"inlineContent":[{"type":"text","text":"You don’t need to call this method if you are using "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()","isActive":true},{"type":"text","text":" on login, because there will"},{"type":"text","text":" "},{"type":"text","text":"be no shared cookie to remove."}],"type":"paragraph"}],"name":"Note","type":"aside","style":"note"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:callback:)","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"metadata":{"roleHeading":"Instance Method","modules":[{"name":"Auth0"}],"required":true,"title":"clearSession(federated:callback:)","symbolKind":"method","role":"symbol","externalID":"s:5Auth07WebAuthP12clearSession9federated8callbackySb_ys6ResultOyytAA0bC5ErrorVGctF","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"clearSession"},{"kind":"text","text":"("},{"kind":"externalParam","text":"federated"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"},{"kind":"text","text":", "},{"kind":"externalParam","text":"callback"},{"kind":"text","text":": ("},{"preciseIdentifier":"s:5Auth013WebAuthResulta","kind":"typeIdentifier","text":"WebAuthResult"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:s4Voida","kind":"typeIdentifier","text":"Void"},{"kind":"text","text":">) -> "},{"preciseIdentifier":"s:s4Voida","kind":"typeIdentifier","text":"Void"},{"kind":"text","text":")"}]},"abstract":[{"type":"text","text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session."}],"schemaVersion":{"minor":3,"patch":0,"major":0},"sections":[],"seeAlsoSections":[{"title":"Related Documentation","anchor":"Related-Documentation","identifiers":["https:\/\/auth0.com\/docs\/authenticate\/login\/logout"]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/clearsession(federated:callback:)"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthResult":{"url":"\/documentation\/auth0\/webauthresult","navigatorTitle":[{"text":"WebAuthResult","kind":"identifier"}],"title":"WebAuthResult","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult","abstract":[{"code":"Result","type":"codeVoice"},{"text":" wrapper for Web Auth operations.","type":"text"}],"type":"topic","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthResult","kind":"identifier"}],"kind":"symbol","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:callback:)":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"clearSession","kind":"identifier"},{"text":"(","kind":"text"},{"text":"federated","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"callback","kind":"externalParam"},{"text":": (","kind":"text"},{"text":"WebAuthResult","preciseIdentifier":"s:5Auth013WebAuthResulta","kind":"typeIdentifier"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:s4Voida","kind":"typeIdentifier","text":"Void"},{"kind":"text","text":">) -> "},{"preciseIdentifier":"s:s4Voida","kind":"typeIdentifier","text":"Void"},{"kind":"text","text":")"}],"type":"topic","defaultImplementations":1,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:callback:)","required":true,"title":"clearSession(federated:callback:)","kind":"symbol","url":"\/documentation\/auth0\/webauth\/clearsession(federated:callback:)","abstract":[{"text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session.","type":"text"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"title":"WebAuth","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"url":"\/documentation\/auth0\/webauth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"kind":"symbol"},"https://auth0.com/docs/authenticate/login/logout":{"identifier":"https:\/\/auth0.com\/docs\/authenticate\/login\/logout","url":"https:\/\/auth0.com\/docs\/authenticate\/login\/logout","title":"Logout","type":"link","titleInlineContent":[{"text":"Logout","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/useEphemeralSession()":{"type":"topic","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)."}],"role":"symbol","url":"\/documentation\/auth0\/webauth\/useephemeralsession()","kind":"symbol","title":"useEphemeralSession()","required":true,"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"useEphemeralSession"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","text":"Self"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()"},"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"},{"text":"federated","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"callback","kind":"externalParam"},{"text":": (","kind":"text"},{"preciseIdentifier":"s:5Auth013WebAuthResulta","text":"WebAuthResult","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"text":">) -> ","kind":"text"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"text":")","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:callback:)-9yv61","abstract":[{"text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session.","type":"text"}],"url":"\/documentation\/auth0\/webauth\/clearsession(federated:callback:)-9yv61","type":"topic","kind":"symbol","title":"clearSession(federated:callback:)","role":"symbol"},"https://manage.auth0.com/#/applications/":{"url":"https:\/\/manage.auth0.com\/#\/applications\/","type":"link","titleInlineContent":[{"text":"Dashboard","type":"text"}],"identifier":"https:\/\/manage.auth0.com\/#\/applications\/","title":"Dashboard"}}} \ No newline at end of file +{"sections":[],"metadata":{"symbolKind":"method","title":"clearSession(federated:callback:)","roleHeading":"Instance Method","externalID":"s:5Auth07WebAuthP12clearSession9federated8callbackySb_ys6ResultOyytAA0bC5ErrorVGctF","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"clearSession"},{"kind":"text","text":"("},{"kind":"externalParam","text":"federated"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"},{"kind":"text","text":", "},{"kind":"externalParam","text":"callback"},{"kind":"text","text":": ("},{"kind":"typeIdentifier","text":"WebAuthResult","preciseIdentifier":"s:5Auth013WebAuthResulta"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":">) -> "},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":")"}],"role":"symbol","required":true},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:callback:)","interfaceLanguage":"swift"},"kind":"symbol","seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/authenticate\/login\/logout"],"anchor":"Related-Documentation"}],"defaultImplementationsSections":[{"title":"WebAuth Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:callback:)-9yv61"],"anchor":"WebAuth-Implementations"}],"variants":[{"paths":["\/documentation\/auth0\/webauth\/clearsession(federated:callback:)"],"traits":[{"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"},{"text":" ","kind":"text"},{"text":"clearSession","kind":"identifier"},{"text":"(","kind":"text"},{"text":"federated","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"},{"text":", ","kind":"text"},{"text":"callback","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"@escaping","kind":"attribute"},{"text":" (","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult","text":"WebAuthResult","kind":"typeIdentifier","preciseIdentifier":"s:5Auth013WebAuthResulta"},{"text":"<","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":">) -> ","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":")","kind":"text"}]}]},{"parameters":[{"name":"federated","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"If the identity provider session should be removed. Defaults to "},{"type":"codeVoice","code":"false"},{"type":"text","text":"."}]}]},{"name":"callback","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."}]}]}],"kind":"parameters"},{"kind":"content","content":[{"level":2,"anchor":"Usage","type":"heading","text":"Usage"},{"code":["Auth0"," .webAuth()"," .clearSession { result in"," switch result {"," case .success:"," print(\"Session cookie cleared\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }"],"type":"codeListing","syntax":"swift"},{"inlineContent":[{"type":"text","text":"Remove both the Auth0 session and the identity provider session:"}],"type":"paragraph"},{"code":["Auth0"," .webAuth()"," .clearSession(federated: true) { print($0) }"],"type":"codeListing","syntax":"swift"},{"name":"Requires","content":[{"type":"paragraph","inlineContent":[{"text":"The ","type":"text"},{"inlineContent":[{"type":"text","text":"Callback URL"}],"type":"strong"},{"text":" to have been added to the ","type":"text"},{"inlineContent":[{"type":"text","text":"Allowed Logout URLs"}],"type":"strong"},{"type":"text","text":" field of your Auth0 application"},{"text":" ","type":"text"},{"text":"settings in the ","type":"text"},{"type":"reference","identifier":"https:\/\/manage.auth0.com\/#\/applications\/","isActive":true},{"type":"text","text":"."}]}],"type":"aside","style":"note"},{"type":"aside","style":"note","content":[{"inlineContent":[{"text":"You don’t need to call this method if you are using ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()","isActive":true,"type":"reference"},{"type":"text","text":" on login, because there will"},{"type":"text","text":" "},{"type":"text","text":"be no shared cookie to remove."}],"type":"paragraph"}],"name":"Note"}]}],"abstract":[{"type":"text","text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:callback:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:callback:)","kind":"symbol","title":"clearSession(federated:callback:)","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"clearSession"},{"kind":"text","text":"("},{"kind":"externalParam","text":"federated"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"},{"kind":"text","text":", "},{"kind":"externalParam","text":"callback"},{"kind":"text","text":": ("},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth013WebAuthResulta","text":"WebAuthResult"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"kind":"text","text":">) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"kind":"text","text":")"}],"defaultImplementations":1,"role":"symbol","required":true,"url":"\/documentation\/auth0\/webauth\/clearsession(federated:callback:)","abstract":[{"type":"text","text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session."}],"type":"topic"},"https://auth0.com/docs/authenticate/login/logout":{"title":"Logout","type":"link","identifier":"https:\/\/auth0.com\/docs\/authenticate\/login\/logout","titleInlineContent":[{"type":"text","text":"Logout"}],"url":"https:\/\/auth0.com\/docs\/authenticate\/login\/logout"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/useEphemeralSession()":{"url":"\/documentation\/auth0\/webauth\/useephemeralsession()","title":"useEphemeralSession()","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)."}],"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"useEphemeralSession"},{"text":"() -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()","required":true,"kind":"symbol","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:callback:)-9yv61":{"role":"symbol","title":"clearSession(federated:callback:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"clearSession"},{"kind":"text","text":"("},{"text":"federated","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"callback","kind":"externalParam"},{"text":": (","kind":"text"},{"preciseIdentifier":"s:5Auth013WebAuthResulta","text":"WebAuthResult","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"text":">) -> ","kind":"text"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"text":")","kind":"text"}],"abstract":[{"text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session.","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/webauth\/clearsession(federated:callback:)-9yv61","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:callback:)-9yv61","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"https://manage.auth0.com/#/applications/":{"titleInlineContent":[{"type":"text","text":"Dashboard"}],"url":"https:\/\/manage.auth0.com\/#\/applications\/","type":"link","title":"Dashboard","identifier":"https:\/\/manage.auth0.com\/#\/applications\/"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"url":"\/documentation\/auth0\/webauth","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"title":"WebAuth","navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthResult":{"url":"\/documentation\/auth0\/webauthresult","title":"WebAuthResult","abstract":[{"code":"Result","type":"codeVoice"},{"type":"text","text":" wrapper for Web Auth operations."}],"navigatorTitle":[{"text":"WebAuthResult","kind":"identifier"}],"fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthResult","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult","role":"symbol","kind":"symbol","type":"topic"}}} \ 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 802f56cbc..2ec71d301 100644 --- a/docs/data/documentation/auth0/webauth/clientid.json +++ b/docs/data/documentation/auth0/webauth/clientid.json @@ -1 +1 @@ -{"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"clientId","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"languages":["swift"]}],"kind":"declarations"}],"schemaVersion":{"patch":0,"minor":3,"major":0},"variants":[{"paths":["\/documentation\/auth0\/webauth\/clientid"],"traits":[{"interfaceLanguage":"swift"}]}],"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\/clientId"},"kind":"symbol","sections":[],"abstract":[{"type":"text","text":"The Auth0 Client ID."}],"metadata":{"roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"role":"symbol","required":true,"externalID":"s:5Auth07WebAuthP8clientIdSSvp","title":"clientId","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"clientId"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"symbolKind":"property"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"title":"WebAuth","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"url":"\/documentation\/auth0\/webauth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clientId":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clientId","required":true,"url":"\/documentation\/auth0\/webauth\/clientid","kind":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"clientId"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"role":"symbol","abstract":[{"text":"The Auth0 Client ID.","type":"text"}],"title":"clientId"}}} \ No newline at end of file +{"metadata":{"symbolKind":"property","roleHeading":"Instance Property","externalID":"s:5Auth07WebAuthP8clientIdSSvp","title":"clientId","modules":[{"name":"Auth0"}],"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"clientId","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"role":"symbol","required":true},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/clientid"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clientId"},"kind":"symbol","abstract":[{"type":"text","text":"The Auth0 Client ID."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"clientId","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clientId":{"type":"topic","title":"clientId","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clientId","kind":"symbol","abstract":[{"type":"text","text":"The Auth0 Client ID."}],"url":"\/documentation\/auth0\/webauth\/clientid","required":true,"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"clientId"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"url":"\/documentation\/auth0\/webauth","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"title":"WebAuth","navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","role":"symbol","kind":"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 63e2d4d7f..caea9ca8f 100644 --- a/docs/data/documentation/auth0/webauth/connection(_:).json +++ b/docs/data/documentation/auth0/webauth/connection(_:).json @@ -1 +1 @@ -{"metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"connection"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"symbolKind":"method","modules":[{"name":"Auth0"}],"required":true,"roleHeading":"Instance Method","externalID":"s:5Auth07WebAuthP10connectionyxSSF","role":"symbol","title":"connection(_:)"},"abstract":[{"type":"text","text":"Specify an Auth0 connection to directly open that identity provider’s login page, skipping the Universal Login"},{"type":"text","text":" "},{"type":"text","text":"page itself. By default no connection is specified, so the Universal Login page will be displayed."}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/connection(_:)","interfaceLanguage":"swift"},"variants":[{"paths":["\/documentation\/auth0\/webauth\/connection(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"connection","kind":"identifier"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"connection","kind":"internalParam"},{"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":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Name of the connection. For example, "},{"code":"github","type":"codeVoice"},{"type":"text","text":"."}]}],"name":"connection"}]},{"content":[{"level":2,"anchor":"return-value","type":"heading","text":"Return Value"},{"inlineContent":[{"type":"text","text":"The same "},{"type":"codeVoice","code":"WebAuth"},{"type":"text","text":" instance to allow method chaining."}],"type":"paragraph"}],"kind":"content"}],"kind":"symbol","sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"schemaVersion":{"minor":3,"patch":0,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"title":"WebAuth","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"url":"\/documentation\/auth0\/webauth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/connection(_:)":{"kind":"symbol","title":"connection(_:)","abstract":[{"text":"Specify an Auth0 connection to directly open that identity provider’s login page, skipping the Universal Login","type":"text"},{"text":" ","type":"text"},{"text":"page itself. By default no connection is specified, so the Universal Login page will be displayed.","type":"text"}],"type":"topic","role":"symbol","url":"\/documentation\/auth0\/webauth\/connection(_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/connection(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"connection"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"required":true}}} \ No newline at end of file +{"metadata":{"symbolKind":"method","title":"connection(_:)","roleHeading":"Instance Method","externalID":"s:5Auth07WebAuthP10connectionyxSSF","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"connection"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"role":"symbol","required":true},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/connection(_:)"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/connection(_:)","interfaceLanguage":"swift"},"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":" "},{"type":"text","text":"page itself. By default no connection is specified, so the Universal Login page will be displayed."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"connection"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"connection"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}]}]},{"parameters":[{"content":[{"inlineContent":[{"type":"text","text":"Name of the connection. For example, "},{"type":"codeVoice","code":"github"},{"type":"text","text":"."}],"type":"paragraph"}],"name":"connection"}],"kind":"parameters"},{"kind":"content","content":[{"anchor":"return-value","type":"heading","level":2,"text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The same "},{"code":"WebAuth","type":"codeVoice"},{"type":"text","text":" instance to allow method chaining."}]}]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"url":"\/documentation\/auth0\/webauth","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"title":"WebAuth","navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/connection(_:)":{"url":"\/documentation\/auth0\/webauth\/connection(_:)","required":true,"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"connection"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"title":"connection(_:)","type":"topic","role":"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":" "},{"type":"text","text":"page itself. By default no connection is specified, so the Universal Login page will be displayed."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/connection(_:)","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ 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 3c8e2032b..56ba547af 100644 --- a/docs/data/documentation/auth0/webauth/connectionscope(_:).json +++ b/docs/data/documentation/auth0/webauth/connectionscope(_:).json @@ -1 +1 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/connectionScope(_:)","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"type":"text","text":"Specify provider scopes for OAuth2\/social connections, such as GitHub or Google."}],"metadata":{"role":"symbol","title":"connectionScope(_:)","modules":[{"name":"Auth0"}],"required":true,"symbolKind":"method","roleHeading":"Instance Method","externalID":"s:5Auth07WebAuthP15connectionScopeyxSSF","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"connectionScope","kind":"identifier"},{"text":"(","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}]},"schemaVersion":{"major":0,"minor":3,"patch":0},"seeAlsoSections":[{"anchor":"Related-Documentation","title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/authenticate\/identity-providers\/adding-scopes-for-an-external-idp"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"variants":[{"paths":["\/documentation\/auth0\/webauth\/connectionscope(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"connectionScope"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"connectionScope"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"platforms":["iOS"],"languages":["swift"]}]},{"parameters":[{"content":[{"inlineContent":[{"text":"Space-separated list of requested OAuth2\/social scope values. For example,","type":"text"},{"text":" ","type":"text"},{"code":"public_repo read:user","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"}],"name":"connectionScope"}],"kind":"parameters"},{"content":[{"anchor":"return-value","type":"heading","level":2,"text":"Return Value"},{"inlineContent":[{"text":"The same ","type":"text"},{"code":"WebAuth","type":"codeVoice"},{"text":" instance to allow method chaining.","type":"text"}],"type":"paragraph"}],"kind":"content"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"title":"WebAuth","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"url":"\/documentation\/auth0\/webauth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"kind":"symbol"},"https://auth0.com/docs/authenticate/identity-providers/adding-scopes-for-an-external-idp":{"type":"link","titleInlineContent":[{"text":"Connection Scopes","type":"text"}],"title":"Connection Scopes","url":"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"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/connectionScope(_:)":{"required":true,"abstract":[{"text":"Specify provider scopes for OAuth2\/social connections, such as GitHub or Google.","type":"text"}],"role":"symbol","title":"connectionScope(_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/connectionScope(_:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"connectionScope","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"type":"topic","kind":"symbol","url":"\/documentation\/auth0\/webauth\/connectionscope(_:)"}}} \ No newline at end of file +{"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/connectionScope(_:)","interfaceLanguage":"swift"},"kind":"symbol","metadata":{"modules":[{"name":"Auth0"}],"externalID":"s:5Auth07WebAuthP15connectionScopeyxSSF","title":"connectionScope(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"connectionScope"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"roleHeading":"Instance Method","role":"symbol","required":true,"symbolKind":"method"},"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/auth0.com\/docs\/authenticate\/identity-providers\/adding-scopes-for-an-external-idp"],"anchor":"Related-Documentation"}],"variants":[{"paths":["\/documentation\/auth0\/webauth\/connectionscope(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"connectionScope","kind":"identifier"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"connectionScope","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}]}]},{"parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Space-separated list of requested OAuth2\/social scope values. For example,"},{"type":"text","text":" "},{"type":"codeVoice","code":"public_repo read:user"},{"type":"text","text":"."}]}],"name":"connectionScope"}],"kind":"parameters"},{"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."}]}],"kind":"content"}],"abstract":[{"type":"text","text":"Specify provider scopes for OAuth2\/social connections, such as GitHub or Google."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"url":"\/documentation\/auth0\/webauth","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"title":"WebAuth","navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","role":"symbol","kind":"symbol","type":"topic"},"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":[{"type":"text","text":"Connection Scopes"}],"type":"link","url":"https:\/\/auth0.com\/docs\/authenticate\/identity-providers\/adding-scopes-for-an-external-idp"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/connectionScope(_:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/connectionScope(_:)","kind":"symbol","title":"connectionScope(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"connectionScope"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"role":"symbol","required":true,"url":"\/documentation\/auth0\/webauth\/connectionscope(_:)","abstract":[{"type":"text","text":"Specify provider scopes for OAuth2\/social connections, such as GitHub or Google."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webauth/headers(_:).json b/docs/data/documentation/auth0/webauth/headers(_:).json index dc72649e5..9bc272872 100644 --- a/docs/data/documentation/auth0/webauth/headers(_:).json +++ b/docs/data/documentation/auth0/webauth/headers(_:).json @@ -1 +1 @@ -{"metadata":{"modules":[{"name":"Auth0"}],"roleHeading":"Instance Method","platforms":[{"deprecated":false,"beta":false,"introducedAt":"17.4","unavailable":false,"name":"iOS"},{"deprecated":false,"beta":false,"introducedAt":"17.4","unavailable":false,"name":"iPadOS"},{"deprecated":false,"beta":false,"introducedAt":"17.4","unavailable":false,"name":"Mac Catalyst"},{"deprecated":false,"beta":false,"introducedAt":"14.4","unavailable":false,"name":"macOS"},{"deprecated":false,"beta":false,"introducedAt":"1.2","unavailable":false,"name":"visionOS"}],"role":"symbol","externalID":"s:5Auth07WebAuthP7headersyxSDyS2SGF","required":true,"title":"headers(_:)","symbolKind":"method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"headers"},{"kind":"text","text":"(["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"]) -> "},{"kind":"typeIdentifier","text":"Self"}]},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/headers(_:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Specify additional headers for "},{"type":"codeVoice","code":"ASWebAuthenticationSession"},{"type":"text","text":"."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/headers(_:)"]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"headers"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"headers"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" : "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"]) -> "},{"kind":"typeIdentifier","text":"Self"}]}]},{"kind":"parameters","parameters":[{"name":"headers","content":[{"inlineContent":[{"type":"text","text":"Additional headers."}],"type":"paragraph"}]}]},{"kind":"content","content":[{"level":2,"text":"Return Value","type":"heading","anchor":"return-value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The same "},{"type":"codeVoice","code":"WebAuth"},{"type":"text","text":" instance to allow method chaining."}]}]},{"kind":"content","content":[{"type":"heading","level":2,"text":"Discussion","anchor":"discussion"},{"type":"aside","style":"note","name":"Note","content":[{"type":"paragraph","inlineContent":[{"text":"Don’t use this method along with ","type":"text"},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/provider(_:)"},{"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"}]}]}]}],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/developer.apple.com\/documentation\/authenticationservices\/aswebauthenticationsession\/additionalheaderfields"],"anchor":"Related-Documentation"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/provider(_:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/provider(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"provider"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"WebAuthProvider","preciseIdentifier":"s:5Auth015WebAuthProvidera"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"kind":"symbol","required":true,"type":"topic","abstract":[{"text":"Specify a custom Web Auth provider to use instead of the default ","type":"text"},{"type":"codeVoice","code":"ASWebAuthenticationSession"},{"text":" implementation.","type":"text"}],"url":"\/documentation\/auth0\/webauth\/provider(_:)","title":"provider(_:)","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"title":"WebAuth","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"url":"\/documentation\/auth0\/webauth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"kind":"symbol"},"https://developer.apple.com/documentation/authenticationservices/aswebauthenticationsession/additionalheaderfields":{"type":"link","titleInlineContent":[{"type":"text","text":"additionalHeaderFields"}],"title":"additionalHeaderFields","url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/aswebauthenticationsession\/additionalheaderfields","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/aswebauthenticationsession\/additionalheaderfields"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/headers(_:)":{"title":"headers(_:)","url":"\/documentation\/auth0\/webauth\/headers(_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/headers(_:)","role":"symbol","abstract":[{"type":"text","text":"Specify additional headers for "},{"type":"codeVoice","code":"ASWebAuthenticationSession"},{"type":"text","text":"."}],"required":true,"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"headers","kind":"identifier"},{"text":"([","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"]) -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"type":"topic","kind":"symbol"}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/headers(_:)"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"abstract":[{"type":"text","text":"Specify additional headers for "},{"type":"codeVoice","code":"ASWebAuthenticationSession"},{"type":"text","text":"."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"headers","kind":"identifier"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"headers","kind":"internalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"]) -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}]}]},{"parameters":[{"name":"headers","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Additional headers."}]}]}],"kind":"parameters"},{"content":[{"type":"heading","anchor":"return-value","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."}]}],"kind":"content"},{"content":[{"type":"heading","anchor":"discussion","level":2,"text":"Discussion"},{"type":"aside","name":"Note","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Don’t use this method along with "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/provider(_:)"},{"type":"text","text":". Use either one or the other, because this"},{"type":"text","text":" "},{"type":"text","text":"method will only work with the default "},{"type":"codeVoice","code":"ASWebAuthenticationSession"},{"type":"text","text":" implementation."}]}],"style":"note"}],"kind":"content"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","sections":[],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/developer.apple.com\/documentation\/authenticationservices\/aswebauthenticationsession\/additionalheaderfields"],"anchor":"Related-Documentation"}],"metadata":{"platforms":[{"unavailable":false,"name":"iOS","beta":false,"introducedAt":"17.4","deprecated":false},{"unavailable":false,"name":"iPadOS","beta":false,"introducedAt":"17.4","deprecated":false},{"unavailable":false,"name":"Mac Catalyst","beta":false,"introducedAt":"17.4","deprecated":false},{"unavailable":false,"name":"macOS","beta":false,"introducedAt":"14.4","deprecated":false},{"unavailable":false,"name":"visionOS","beta":false,"introducedAt":"1.2","deprecated":false}],"symbolKind":"method","modules":[{"name":"Auth0"}],"title":"headers(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"headers"},{"kind":"text","text":"(["},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":" : "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"]) -> "},{"kind":"typeIdentifier","text":"Self"}],"externalID":"s:5Auth07WebAuthP7headersyxSDyS2SGF","role":"symbol","required":true,"roleHeading":"Instance Method"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/headers(_:)"},"references":{"https://developer.apple.com/documentation/authenticationservices/aswebauthenticationsession/additionalheaderfields":{"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/aswebauthenticationsession\/additionalheaderfields","title":"additionalHeaderFields","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/aswebauthenticationsession\/additionalheaderfields","titleInlineContent":[{"type":"text","text":"additionalHeaderFields"}],"type":"link"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/headers(_:)":{"type":"topic","abstract":[{"type":"text","text":"Specify additional headers for "},{"type":"codeVoice","code":"ASWebAuthenticationSession"},{"type":"text","text":"."}],"title":"headers(_:)","url":"\/documentation\/auth0\/webauth\/headers(_:)","kind":"symbol","required":true,"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"headers","kind":"identifier"},{"text":"([","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"]) -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/headers(_:)"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"url":"\/documentation\/auth0\/webauth","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"title":"WebAuth","navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/provider(_:)":{"url":"\/documentation\/auth0\/webauth\/provider(_:)","abstract":[{"text":"Specify a custom Web Auth provider to use instead of the default ","type":"text"},{"code":"ASWebAuthenticationSession","type":"codeVoice"},{"text":" implementation.","type":"text"}],"title":"provider(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"provider"},{"kind":"text","text":"("},{"text":"WebAuthProvider","preciseIdentifier":"s:5Auth015WebAuthProvidera","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/provider(_:)","required":true,"kind":"symbol","role":"symbol","type":"topic"}}} \ 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 e2248f116..d9c58bd20 100644 --- a/docs/data/documentation/auth0/webauth/invitationurl(_:).json +++ b/docs/data/documentation/auth0/webauth/invitationurl(_:).json @@ -1 +1 @@ -{"schemaVersion":{"minor":3,"major":0,"patch":0},"abstract":[{"text":"Specify an invitation URL to join an organization.","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"sections":[],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"invitationURL","kind":"identifier"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"invitationURL","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"URL","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"languages":["swift"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"invitationURL","content":[{"type":"paragraph","inlineContent":[{"text":"Invitation URL for the organization.","type":"text"}]}]}]},{"content":[{"type":"heading","level":2,"text":"Return Value","anchor":"return-value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The same "},{"type":"codeVoice","code":"WebAuth"},{"type":"text","text":" instance to allow method chaining."}]}],"kind":"content"}],"metadata":{"roleHeading":"Instance Method","symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"invitationURL","kind":"identifier"},{"text":"(","kind":"text"},{"text":"URL","preciseIdentifier":"s:10Foundation3URLV","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"title":"invitationURL(_:)","modules":[{"name":"Auth0"}],"required":true,"externalID":"s:5Auth07WebAuthP13invitationURLyx10Foundation0E0VF","role":"symbol"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/invitationURL(_:)","interfaceLanguage":"swift"},"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/invitationurl(_:)"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/invitationURL(_:)":{"url":"\/documentation\/auth0\/webauth\/invitationurl(_:)","abstract":[{"type":"text","text":"Specify an invitation URL to join an organization."}],"type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"invitationURL"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"URL","preciseIdentifier":"s:10Foundation3URLV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/invitationURL(_:)","title":"invitationURL(_:)","required":true},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"title":"WebAuth","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"url":"\/documentation\/auth0\/webauth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"variants":[{"paths":["\/documentation\/auth0\/webauth\/invitationurl(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"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"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"invitationURL"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"invitationURL"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV","text":"URL"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"languages":["swift"],"platforms":["iOS"]}]},{"parameters":[{"content":[{"inlineContent":[{"type":"text","text":"Invitation URL for the organization."}],"type":"paragraph"}],"name":"invitationURL"}],"kind":"parameters"},{"content":[{"level":2,"anchor":"return-value","text":"Return Value","type":"heading"},{"inlineContent":[{"type":"text","text":"The same "},{"code":"WebAuth","type":"codeVoice"},{"type":"text","text":" instance to allow method chaining."}],"type":"paragraph"}],"kind":"content"}],"schemaVersion":{"minor":3,"patch":0,"major":0},"kind":"symbol","sections":[],"metadata":{"externalID":"s:5Auth07WebAuthP13invitationURLyx10Foundation0E0VF","symbolKind":"method","title":"invitationURL(_:)","role":"symbol","required":true,"roleHeading":"Instance Method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"invitationURL","kind":"identifier"},{"text":"(","kind":"text"},{"text":"URL","preciseIdentifier":"s:10Foundation3URLV","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"modules":[{"name":"Auth0"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/invitationURL(_:)","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"url":"\/documentation\/auth0\/webauth","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"title":"WebAuth","navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/invitationURL(_:)":{"type":"topic","abstract":[{"text":"Specify an invitation URL to join an organization.","type":"text"}],"title":"invitationURL(_:)","kind":"symbol","url":"\/documentation\/auth0\/webauth\/invitationurl(_:)","required":true,"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"invitationURL"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"URL","preciseIdentifier":"s:10Foundation3URLV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/invitationURL(_:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ 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 1b3ebe4e3..8d861cbe7 100644 --- a/docs/data/documentation/auth0/webauth/issuer(_:).json +++ b/docs/data/documentation/auth0/webauth/issuer(_:).json @@ -1 +1 @@ -{"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"]]},"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/webauth\/issuer(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"issuer","kind":"identifier"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"issuer","kind":"internalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"type":"text","text":"Custom issuer value. For example, "},{"type":"codeVoice","code":"https:\/\/example.com\/"},{"type":"text","text":"."}],"type":"paragraph"}],"name":"issuer"}]},{"content":[{"type":"heading","text":"Return Value","level":2,"anchor":"return-value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The same "},{"type":"codeVoice","code":"WebAuth"},{"type":"text","text":" instance to allow method chaining."}]}],"kind":"content"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"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."}],"metadata":{"symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"issuer","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"title":"issuer(_:)","role":"symbol","required":true,"roleHeading":"Instance Method","externalID":"s:5Auth07WebAuthP6issueryxSSF","modules":[{"name":"Auth0"}]},"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"title":"WebAuth","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"url":"\/documentation\/auth0\/webauth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/issuer(_:)":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"issuer","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"url":"\/documentation\/auth0\/webauth\/issuer(_:)","abstract":[{"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.","type":"text"}],"kind":"symbol","required":true,"title":"issuer(_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/issuer(_:)","type":"topic","role":"symbol"}}} \ No newline at end of file +{"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."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"issuer"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"issuer"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"platforms":["iOS"],"languages":["swift"]}]},{"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":"parameters"},{"content":[{"type":"heading","level":2,"text":"Return Value","anchor":"return-value"},{"inlineContent":[{"type":"text","text":"The same "},{"code":"WebAuth","type":"codeVoice"},{"type":"text","text":" instance to allow method chaining."}],"type":"paragraph"}],"kind":"content"}],"variants":[{"paths":["\/documentation\/auth0\/webauth\/issuer(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"metadata":{"modules":[{"name":"Auth0"}],"title":"issuer(_:)","roleHeading":"Instance Method","symbolKind":"method","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"issuer"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"required":true,"externalID":"s:5Auth07WebAuthP6issueryxSSF"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/issuer(_:)","interfaceLanguage":"swift"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/issuer(_:)":{"url":"\/documentation\/auth0\/webauth\/issuer(_:)","required":true,"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"issuer"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"title":"issuer(_:)","type":"topic","role":"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."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/issuer(_:)","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"url":"\/documentation\/auth0\/webauth","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"title":"WebAuth","navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","role":"symbol","kind":"symbol","type":"topic"}}} \ 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 dfe2ac2b2..8d84f5aa6 100644 --- a/docs/data/documentation/auth0/webauth/leeway(_:).json +++ b/docs/data/documentation/auth0/webauth/leeway(_:).json @@ -1 +1 @@ -{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/leeway(_:)"]}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"sections":[],"abstract":[{"type":"text","text":"Specify a leeway amount for ID token validation."},{"type":"text","text":" "},{"type":"text","text":"This value represents the clock skew for the validation of date claims, for example "},{"type":"codeVoice","code":"exp"},{"type":"text","text":"."}],"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"required":true,"externalID":"s:5Auth07WebAuthP6leewayyxSiF","symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"leeway","kind":"identifier"},{"text":"(","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"title":"leeway(_:)","role":"symbol","modules":[{"name":"Auth0"}],"roleHeading":"Instance Method"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/leeway(_:)"},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"leeway","kind":"identifier"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"leeway","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}]}],"kind":"declarations"},{"parameters":[{"name":"leeway","content":[{"inlineContent":[{"type":"text","text":"Number of milliseconds. Defaults to "},{"type":"codeVoice","code":"60_000"},{"type":"text","text":" (1 minute)."}],"type":"paragraph"}]}],"kind":"parameters"},{"kind":"content","content":[{"level":2,"anchor":"return-value","type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The same "},{"type":"codeVoice","code":"WebAuth"},{"type":"text","text":" instance to allow method chaining."}]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"title":"WebAuth","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"url":"\/documentation\/auth0\/webauth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/leeway(_:)":{"role":"symbol","abstract":[{"type":"text","text":"Specify a leeway amount for ID token validation."},{"type":"text","text":" "},{"type":"text","text":"This value represents the clock skew for the validation of date claims, for example "},{"type":"codeVoice","code":"exp"},{"type":"text","text":"."}],"title":"leeway(_:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/leeway(_:)","url":"\/documentation\/auth0\/webauth\/leeway(_:)","required":true,"type":"topic","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"leeway"},{"kind":"text","text":"("},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}]}}} \ No newline at end of file +{"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"leeway"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"text":" ","kind":"text"},{"kind":"internalParam","text":"leeway"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"platforms":["iOS"]}],"kind":"declarations"},{"parameters":[{"name":"leeway","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Number of milliseconds. Defaults to "},{"code":"60_000","type":"codeVoice"},{"type":"text","text":" (1 minute)."}]}]}],"kind":"parameters"},{"kind":"content","content":[{"level":2,"text":"Return Value","type":"heading","anchor":"return-value"},{"inlineContent":[{"type":"text","text":"The same "},{"code":"WebAuth","type":"codeVoice"},{"type":"text","text":" instance to allow method chaining."}],"type":"paragraph"}]}],"sections":[],"abstract":[{"text":"Specify a leeway amount for ID token validation.","type":"text"},{"text":" ","type":"text"},{"text":"This value represents the clock skew for the validation of date claims, for example ","type":"text"},{"code":"exp","type":"codeVoice"},{"text":".","type":"text"}],"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/webauth\/leeway(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/leeway(_:)"},"metadata":{"role":"symbol","modules":[{"name":"Auth0"}],"title":"leeway(_:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"leeway","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"externalID":"s:5Auth07WebAuthP6leewayyxSiF","roleHeading":"Instance Method","required":true,"symbolKind":"method"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/leeway(_:)":{"kind":"symbol","title":"leeway(_:)","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"leeway","kind":"identifier"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/leeway(_:)","required":true,"abstract":[{"type":"text","text":"Specify a leeway amount for ID token validation."},{"type":"text","text":" "},{"type":"text","text":"This value represents the clock skew for the validation of date claims, for example "},{"code":"exp","type":"codeVoice"},{"type":"text","text":"."}],"url":"\/documentation\/auth0\/webauth\/leeway(_:)"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"url":"\/documentation\/auth0\/webauth","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"title":"WebAuth","navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","role":"symbol","kind":"symbol","type":"topic"}}} \ 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 5f9fa9e29..5095f6785 100644 --- a/docs/data/documentation/auth0/webauth/maxage(_:).json +++ b/docs/data/documentation/auth0/webauth/maxage(_:).json @@ -1 +1 @@ -{"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"maxAge"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"maxAge"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"platforms":["iOS"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Number of milliseconds."}]}],"name":"maxAge"}]},{"content":[{"type":"heading","anchor":"return-value","text":"Return Value","level":2},{"type":"paragraph","inlineContent":[{"text":"The same ","type":"text"},{"code":"WebAuth","type":"codeVoice"},{"text":" instance to allow method chaining.","type":"text"}]}],"kind":"content"}],"abstract":[{"text":"Specify a ","type":"text"},{"type":"codeVoice","code":"max_age"},{"text":" parameter for authentication.","type":"text"},{"text":" ","type":"text"},{"text":"Sending this parameter will require the presence of the ","type":"text"},{"type":"codeVoice","code":"auth_time"},{"text":" claim in the ID token.","type":"text"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/maxage(_:)"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"metadata":{"modules":[{"name":"Auth0"}],"role":"symbol","roleHeading":"Instance Method","symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"maxAge","kind":"identifier"},{"text":"(","kind":"text"},{"text":"Int","preciseIdentifier":"s:Si","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"title":"maxAge(_:)","externalID":"s:5Auth07WebAuthP6maxAgeyxSiF","required":true},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/maxAge(_:)"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/maxAge(_:)":{"title":"maxAge(_:)","abstract":[{"type":"text","text":"Specify a "},{"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."}],"required":true,"kind":"symbol","type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"maxAge"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/maxAge(_:)","url":"\/documentation\/auth0\/webauth\/maxage(_:)"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"title":"WebAuth","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"url":"\/documentation\/auth0\/webauth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"kind":"symbol"}}} \ No newline at end of file +{"abstract":[{"type":"text","text":"Specify a "},{"type":"codeVoice","code":"max_age"},{"text":" parameter for authentication.","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"Sending this parameter will require the presence of the "},{"code":"auth_time","type":"codeVoice"},{"type":"text","text":" claim in the ID token."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"maxAge"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"maxAge"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"platforms":["iOS"]}]},{"parameters":[{"name":"maxAge","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Number of milliseconds."}]}]}],"kind":"parameters"},{"content":[{"level":2,"text":"Return Value","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"}],"kind":"content"}],"variants":[{"paths":["\/documentation\/auth0\/webauth\/maxage(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"metadata":{"role":"symbol","title":"maxAge(_:)","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"maxAge"},{"kind":"text","text":"("},{"text":"Int","preciseIdentifier":"s:Si","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"externalID":"s:5Auth07WebAuthP6maxAgeyxSiF","roleHeading":"Instance Method","required":true,"symbolKind":"method"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/maxAge(_:)","interfaceLanguage":"swift"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"url":"\/documentation\/auth0\/webauth","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"title":"WebAuth","navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/maxAge(_:)":{"role":"symbol","title":"maxAge(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"maxAge"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"abstract":[{"type":"text","text":"Specify a "},{"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"},{"text":" claim in the ID token.","type":"text"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/maxAge(_:)","url":"\/documentation\/auth0\/webauth\/maxage(_:)","required":true,"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ 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 44a7e32a4..247ee0d06 100644 --- a/docs/data/documentation/auth0/webauth/nonce(_:).json +++ b/docs/data/documentation/auth0/webauth/nonce(_:).json @@ -1 +1 @@ -{"variants":[{"paths":["\/documentation\/auth0\/webauth\/nonce(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"symbolKind":"method","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"nonce","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"modules":[{"name":"Auth0"}],"title":"nonce(_:)","externalID":"s:5Auth07WebAuthP5nonceyxSSF","required":true,"roleHeading":"Instance Method"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/nonce(_:)"},"schemaVersion":{"minor":3,"major":0,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"kind":"symbol","sections":[],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"nonce","kind":"identifier"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"nonce","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}]}],"kind":"declarations"},{"parameters":[{"name":"nonce","content":[{"inlineContent":[{"type":"text","text":"Nonce value."}],"type":"paragraph"}]}],"kind":"parameters"},{"kind":"content","content":[{"type":"heading","level":2,"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."}]}]}],"abstract":[{"type":"text","text":"Specify a "},{"type":"codeVoice","code":"nonce"},{"type":"text","text":" parameter for ID token validation."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/nonce(_:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/nonce(_:)","kind":"symbol","required":true,"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"nonce"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"type":"topic","title":"nonce(_:)","abstract":[{"type":"text","text":"Specify a "},{"code":"nonce","type":"codeVoice"},{"type":"text","text":" parameter for ID token validation."}],"url":"\/documentation\/auth0\/webauth\/nonce(_:)"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"title":"WebAuth","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"url":"\/documentation\/auth0\/webauth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"abstract":[{"type":"text","text":"Specify a "},{"type":"codeVoice","code":"nonce"},{"type":"text","text":" parameter for ID token validation."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"nonce"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"_"},{"text":" ","kind":"text"},{"kind":"internalParam","text":"nonce"},{"kind":"text","text":": "},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"platforms":["iOS"],"languages":["swift"]}]},{"parameters":[{"content":[{"inlineContent":[{"type":"text","text":"Nonce value."}],"type":"paragraph"}],"name":"nonce"}],"kind":"parameters"},{"kind":"content","content":[{"level":2,"anchor":"return-value","type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The same "},{"code":"WebAuth","type":"codeVoice"},{"type":"text","text":" instance to allow method chaining."}]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/nonce(_:)"]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"metadata":{"externalID":"s:5Auth07WebAuthP5nonceyxSSF","modules":[{"name":"Auth0"}],"title":"nonce(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"nonce"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"roleHeading":"Instance Method","role":"symbol","required":true,"symbolKind":"method"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/nonce(_:)","interfaceLanguage":"swift"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/nonce(_:)":{"url":"\/documentation\/auth0\/webauth\/nonce(_:)","required":true,"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"nonce"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"title":"nonce(_:)","type":"topic","role":"symbol","abstract":[{"type":"text","text":"Specify a "},{"type":"codeVoice","code":"nonce"},{"type":"text","text":" parameter for ID token validation."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/nonce(_:)","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"url":"\/documentation\/auth0\/webauth","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"title":"WebAuth","navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ 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 3c5d483a9..094b15112 100644 --- a/docs/data/documentation/auth0/webauth/onclose(_:).json +++ b/docs/data/documentation/auth0/webauth/onclose(_:).json @@ -1 +1 @@ -{"kind":"symbol","abstract":[{"text":"Specify a callback to be called when the ","type":"text"},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent"},{"text":" closes, while the flow continues with the code exchange.","type":"text"}],"metadata":{"modules":[{"name":"Auth0"}],"required":true,"role":"symbol","roleHeading":"Instance Method","externalID":"s:5Auth07WebAuthP7onCloseyxyycSgF","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"onClose","kind":"identifier"},{"text":"((() -> ","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":")?) -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"symbolKind":"method","title":"onClose(_:)"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"sections":[],"schemaVersion":{"patch":0,"minor":3,"major":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/onClose(_:)","interfaceLanguage":"swift"},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"onClose"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"callback"},{"kind":"text","text":": (() -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"kind":"text","text":")?) -> "},{"kind":"typeIdentifier","text":"Self"}]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"callback","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A callback to be executed"}]}]}]},{"content":[{"text":"Return Value","type":"heading","level":2,"anchor":"return-value"},{"type":"paragraph","inlineContent":[{"text":"The same ","type":"text"},{"code":"WebAuth","type":"codeVoice"},{"text":" instance to allow method chaining.","type":"text"}]}],"kind":"content"}],"variants":[{"paths":["\/documentation\/auth0\/webauth\/onclose(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent":{"title":"WebAuthUserAgent","url":"\/documentation\/auth0\/webauthuseragent","navigatorTitle":[{"kind":"identifier","text":"WebAuthUserAgent"}],"abstract":[{"type":"text","text":"The external user agent used to perform a web-based operation."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","kind":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthUserAgent"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/onClose(_:)":{"type":"topic","abstract":[{"type":"text","text":"Specify a callback to be called when the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent"},{"type":"text","text":" closes, while the flow continues with the code exchange."}],"kind":"symbol","title":"onClose(_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/onClose(_:)","url":"\/documentation\/auth0\/webauth\/onclose(_:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"onClose","kind":"identifier"},{"text":"((() -> ","kind":"text"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"text":")?) -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"required":true},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"title":"WebAuth","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"url":"\/documentation\/auth0\/webauth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"kind":"symbol"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"metadata":{"symbolKind":"method","modules":[{"name":"Auth0"}],"title":"onClose(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"onClose"},{"kind":"text","text":"((() -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"kind":"text","text":")?) -> "},{"kind":"typeIdentifier","text":"Self"}],"externalID":"s:5Auth07WebAuthP7onCloseyxyycSgF","required":true,"role":"symbol","roleHeading":"Instance Method"},"sections":[],"abstract":[{"type":"text","text":"Specify a callback to be called when the "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","isActive":true},{"type":"text","text":" closes, while the flow continues with the code exchange."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/onclose(_:)"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/onClose(_:)","interfaceLanguage":"swift"},"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"onClose"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"callback"},{"kind":"text","text":": (() -> "},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":")?) -> "},{"kind":"typeIdentifier","text":"Self"}]}],"kind":"declarations"},{"parameters":[{"content":[{"inlineContent":[{"text":"A callback to be executed","type":"text"}],"type":"paragraph"}],"name":"callback"}],"kind":"parameters"},{"content":[{"level":2,"type":"heading","anchor":"return-value","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The same "},{"code":"WebAuth","type":"codeVoice"},{"type":"text","text":" instance to allow method chaining."}]}],"kind":"content"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent":{"kind":"symbol","abstract":[{"type":"text","text":"The external user agent used to perform a web-based operation."}],"type":"topic","url":"\/documentation\/auth0\/webauthuseragent","title":"WebAuthUserAgent","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthUserAgent"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","navigatorTitle":[{"kind":"identifier","text":"WebAuthUserAgent"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/onClose(_:)":{"url":"\/documentation\/auth0\/webauth\/onclose(_:)","title":"onClose(_:)","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"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"onClose","kind":"identifier"},{"text":"((() -> ","kind":"text"},{"text":"Void","preciseIdentifier":"s:s4Voida","kind":"typeIdentifier"},{"text":")?) -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/onClose(_:)","required":true,"kind":"symbol","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"url":"\/documentation\/auth0\/webauth","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"title":"WebAuth","navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","role":"symbol","kind":"symbol","type":"topic"}}} \ 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 6d49f8a37..1244552f6 100644 --- a/docs/data/documentation/auth0/webauth/organization(_:).json +++ b/docs/data/documentation/auth0/webauth/organization(_:).json @@ -1 +1 @@ -{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/organization(_:)"},"abstract":[{"type":"text","text":"Specify an organization identifier to log in to."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"organization","kind":"identifier"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"organization","kind":"internalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"languages":["swift"]}]},{"kind":"parameters","parameters":[{"name":"organization","content":[{"inlineContent":[{"type":"text","text":"ID of the organization."}],"type":"paragraph"}]}]},{"content":[{"anchor":"return-value","type":"heading","text":"Return Value","level":2},{"type":"paragraph","inlineContent":[{"type":"text","text":"The same "},{"type":"codeVoice","code":"WebAuth"},{"type":"text","text":" instance to allow method chaining."}]}],"kind":"content"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"variants":[{"paths":["\/documentation\/auth0\/webauth\/organization(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"patch":0,"minor":3},"metadata":{"roleHeading":"Instance Method","externalID":"s:5Auth07WebAuthP12organizationyxSSF","title":"organization(_:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"organization","kind":"identifier"},{"text":"(","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"required":true,"modules":[{"name":"Auth0"}],"role":"symbol","symbolKind":"method"},"sections":[],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"title":"WebAuth","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"url":"\/documentation\/auth0\/webauth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/organization(_:)":{"required":true,"title":"organization(_:)","role":"symbol","type":"topic","url":"\/documentation\/auth0\/webauth\/organization(_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/organization(_:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"organization"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"kind":"symbol","abstract":[{"type":"text","text":"Specify an organization identifier to log in to."}]}}} \ No newline at end of file +{"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"organization"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"organization"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}]}]},{"parameters":[{"name":"organization","content":[{"inlineContent":[{"text":"ID of the organization.","type":"text"}],"type":"paragraph"}]}],"kind":"parameters"},{"kind":"content","content":[{"level":2,"anchor":"return-value","type":"heading","text":"Return Value"},{"inlineContent":[{"type":"text","text":"The same "},{"code":"WebAuth","type":"codeVoice"},{"type":"text","text":" instance to allow method chaining."}],"type":"paragraph"}]}],"sections":[],"abstract":[{"type":"text","text":"Specify an organization identifier to log in to."}],"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/webauth\/organization(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"role":"symbol","title":"organization(_:)","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"organization"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"externalID":"s:5Auth07WebAuthP12organizationyxSSF","roleHeading":"Instance Method","required":true,"symbolKind":"method"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/organization(_:)","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"url":"\/documentation\/auth0\/webauth","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"title":"WebAuth","navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/organization(_:)":{"role":"symbol","title":"organization(_:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"organization","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"abstract":[{"type":"text","text":"Specify an organization identifier to log in to."}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/organization(_:)","url":"\/documentation\/auth0\/webauth\/organization(_:)","required":true,"type":"topic"}}} \ 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 80dda7537..5d09a6cb2 100644 --- a/docs/data/documentation/auth0/webauth/parameters(_:).json +++ b/docs/data/documentation/auth0/webauth/parameters(_:).json @@ -1 +1 @@ -{"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"parameters"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"parameters"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"]) -> "},{"kind":"typeIdentifier","text":"Self"}],"platforms":["iOS"]}]},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"text":"Additional authentication parameters.","type":"text"}]}],"name":"parameters"}]},{"kind":"content","content":[{"level":2,"text":"Return Value","anchor":"return-value","type":"heading"},{"inlineContent":[{"type":"text","text":"The same "},{"code":"WebAuth","type":"codeVoice"},{"type":"text","text":" instance to allow method chaining."}],"type":"paragraph"}]}],"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/parameters(_:)"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/parameters(_:)"]}],"metadata":{"roleHeading":"Instance Method","required":true,"symbolKind":"method","externalID":"s:5Auth07WebAuthP10parametersyxSDyS2SGF","title":"parameters(_:)","role":"symbol","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"parameters"},{"kind":"text","text":"(["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"]) -> "},{"kind":"typeIdentifier","text":"Self"}]},"abstract":[{"type":"text","text":"Specify additional parameters for authentication."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/parameters(_:)":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/parameters(_:)","type":"topic","abstract":[{"type":"text","text":"Specify additional parameters for authentication."}],"url":"\/documentation\/auth0\/webauth\/parameters(_:)","required":true,"title":"parameters(_:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"parameters","kind":"identifier"},{"text":"([","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"]) -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"title":"WebAuth","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"url":"\/documentation\/auth0\/webauth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/parameters(_:)"},"kind":"symbol","metadata":{"symbolKind":"method","roleHeading":"Instance Method","externalID":"s:5Auth07WebAuthP10parametersyxSDyS2SGF","title":"parameters(_:)","modules":[{"name":"Auth0"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"parameters","kind":"identifier"},{"text":"([","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"]) -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"role":"symbol","required":true},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/parameters(_:)"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"schemaVersion":{"minor":3,"patch":0,"major":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"parameters","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"parameters"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"]) -> "},{"text":"Self","kind":"typeIdentifier"}],"languages":["swift"],"platforms":["iOS"]}]},{"parameters":[{"name":"parameters","content":[{"inlineContent":[{"type":"text","text":"Additional authentication parameters."}],"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"},{"code":"WebAuth","type":"codeVoice"},{"text":" instance to allow method chaining.","type":"text"}]}]}],"abstract":[{"type":"text","text":"Specify additional parameters for authentication."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"url":"\/documentation\/auth0\/webauth","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"title":"WebAuth","navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/parameters(_:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/parameters(_:)","kind":"symbol","title":"parameters(_:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"parameters","kind":"identifier"},{"text":"([","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"]) -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"role":"symbol","required":true,"url":"\/documentation\/auth0\/webauth\/parameters(_:)","abstract":[{"type":"text","text":"Specify additional parameters for authentication."}],"type":"topic"}}} \ 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 30ba03b6c..70e4e2c2b 100644 --- a/docs/data/documentation/auth0/webauth/provider(_:).json +++ b/docs/data/documentation/auth0/webauth/provider(_:).json @@ -1 +1 @@ -{"kind":"symbol","schemaVersion":{"patch":0,"minor":3,"major":0},"seeAlsoSections":[{"title":"Related Documentation","anchor":"Related-Documentation","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserAgents","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProvider"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"provider"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"provider"},{"kind":"text","text":": "},{"kind":"attribute","text":"@escaping"},{"kind":"text","text":" "},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProvider","preciseIdentifier":"s:5Auth015WebAuthProvidera","text":"WebAuthProvider"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"platforms":["iOS"],"languages":["swift"]}]},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"type":"text","text":"A custom Web Auth provider."}],"type":"paragraph"}],"name":"provider"}]},{"kind":"content","content":[{"type":"heading","level":2,"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."}]}]},{"kind":"content","content":[{"level":2,"anchor":"discussion","text":"Discussion","type":"heading"},{"style":"note","name":"Note","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Don’t use this method along with "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()","type":"reference","isActive":true},{"type":"text","text":". Use either one or the other, because"},{"type":"text","text":" "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()","type":"reference","isActive":true},{"type":"text","text":" will only work with the default "},{"type":"codeVoice","code":"ASWebAuthenticationSession"},{"type":"text","text":" implementation."}]}],"type":"aside"}]}],"abstract":[{"type":"text","text":"Specify a custom Web Auth provider to use instead of the default "},{"code":"ASWebAuthenticationSession","type":"codeVoice"},{"type":"text","text":" implementation."}],"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"metadata":{"externalID":"s:5Auth07WebAuthP8provideryxAA0bC9UserAgent_p10Foundation3URLV_ys6ResultOyytAA0bC5ErrorVGctcF","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"provider"},{"kind":"text","text":"("},{"preciseIdentifier":"s:5Auth015WebAuthProvidera","kind":"typeIdentifier","text":"WebAuthProvider"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"modules":[{"name":"Auth0"}],"symbolKind":"method","roleHeading":"Instance Method","required":true,"role":"symbol","title":"provider(_:)"},"variants":[{"paths":["\/documentation\/auth0\/webauth\/provider(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/provider(_:)"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthProvider":{"type":"topic","navigatorTitle":[{"kind":"identifier","text":"WebAuthProvider"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProvider","kind":"symbol","title":"WebAuthProvider","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"},{"text":" to perform a web-based operation.","type":"text"},{"text":" ","type":"text"},{"text":"The ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","isActive":true,"type":"reference"},{"text":" opens the URL in an external user agent and then invokes the callback when done.","type":"text"}],"fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthProvider"}],"url":"\/documentation\/auth0\/webauthprovider"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"title":"WebAuth","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"url":"\/documentation\/auth0\/webauth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent":{"title":"WebAuthUserAgent","url":"\/documentation\/auth0\/webauthuseragent","navigatorTitle":[{"kind":"identifier","text":"WebAuthUserAgent"}],"abstract":[{"type":"text","text":"The external user agent used to perform a web-based operation."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","kind":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthUserAgent"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/provider(_:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/provider(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"provider"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"WebAuthProvider","preciseIdentifier":"s:5Auth015WebAuthProvidera"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"kind":"symbol","required":true,"type":"topic","abstract":[{"text":"Specify a custom Web Auth provider to use instead of the default ","type":"text"},{"type":"codeVoice","code":"ASWebAuthenticationSession"},{"text":" implementation.","type":"text"}],"url":"\/documentation\/auth0\/webauth\/provider(_:)","title":"provider(_:)","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserAgents":{"title":"ASWebAuthenticationSession vs SFSafariViewController (iOS)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserAgents","abstract":[],"kind":"article","type":"topic","role":"article","url":"\/documentation\/auth0\/useragents"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/useEphemeralSession()":{"type":"topic","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)."}],"role":"symbol","url":"\/documentation\/auth0\/webauth\/useephemeralsession()","kind":"symbol","title":"useEphemeralSession()","required":true,"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"useEphemeralSession"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","text":"Self"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()"}}} \ No newline at end of file +{"abstract":[{"type":"text","text":"Specify a custom Web Auth provider to use instead of the default "},{"code":"ASWebAuthenticationSession","type":"codeVoice"},{"type":"text","text":" implementation."}],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserAgents","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProvider"],"anchor":"Related-Documentation"}],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"provider"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"provider"},{"kind":"text","text":": "},{"kind":"attribute","text":"@escaping"},{"kind":"text","text":" "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015WebAuthProvidera","text":"WebAuthProvider","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProvider"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"provider","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A custom Web Auth provider."}]}]}]},{"content":[{"type":"heading","level":2,"text":"Return Value","anchor":"return-value"},{"inlineContent":[{"type":"text","text":"The same "},{"type":"codeVoice","code":"WebAuth"},{"type":"text","text":" instance to allow method chaining."}],"type":"paragraph"}],"kind":"content"},{"content":[{"type":"heading","level":2,"text":"Discussion","anchor":"discussion"},{"name":"Note","style":"note","type":"aside","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Don’t use this method along with "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()","type":"reference","isActive":true},{"type":"text","text":". Use either one or the other, because"},{"type":"text","text":" "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()","type":"reference","isActive":true},{"type":"text","text":" will only work with the default "},{"code":"ASWebAuthenticationSession","type":"codeVoice"},{"type":"text","text":" implementation."}]}]}],"kind":"content"}],"variants":[{"paths":["\/documentation\/auth0\/webauth\/provider(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"metadata":{"modules":[{"name":"Auth0"}],"title":"provider(_:)","roleHeading":"Instance Method","symbolKind":"method","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"provider"},{"kind":"text","text":"("},{"preciseIdentifier":"s:5Auth015WebAuthProvidera","kind":"typeIdentifier","text":"WebAuthProvider"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"required":true,"externalID":"s:5Auth07WebAuthP8provideryxAA0bC9UserAgent_p10Foundation3URLV_ys6ResultOyytAA0bC5ErrorVGctcF"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/provider(_:)","interfaceLanguage":"swift"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/provider(_:)":{"url":"\/documentation\/auth0\/webauth\/provider(_:)","abstract":[{"text":"Specify a custom Web Auth provider to use instead of the default ","type":"text"},{"code":"ASWebAuthenticationSession","type":"codeVoice"},{"text":" implementation.","type":"text"}],"title":"provider(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"provider"},{"kind":"text","text":"("},{"text":"WebAuthProvider","preciseIdentifier":"s:5Auth015WebAuthProvidera","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/provider(_:)","required":true,"kind":"symbol","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserAgents":{"title":"ASWebAuthenticationSession vs SFSafariViewController (iOS)","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserAgents","role":"article","kind":"article","abstract":[],"url":"\/documentation\/auth0\/useragents"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/useEphemeralSession()":{"url":"\/documentation\/auth0\/webauth\/useephemeralsession()","title":"useEphemeralSession()","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)."}],"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"useEphemeralSession"},{"text":"() -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()","required":true,"kind":"symbol","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"url":"\/documentation\/auth0\/webauth","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"title":"WebAuth","navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent":{"kind":"symbol","abstract":[{"type":"text","text":"The external user agent used to perform a web-based operation."}],"type":"topic","url":"\/documentation\/auth0\/webauthuseragent","title":"WebAuthUserAgent","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthUserAgent"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","navigatorTitle":[{"kind":"identifier","text":"WebAuthUserAgent"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthProvider":{"role":"symbol","title":"WebAuthProvider","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthProvider"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuthProvider"}],"abstract":[{"type":"text","text":"Thunk that returns a function that creates and returns a "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","isActive":true,"type":"reference"},{"text":" to perform a web-based operation.","type":"text"},{"type":"text","text":" "},{"type":"text","text":"The "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","isActive":true},{"text":" opens the URL in an external user agent and then invokes the callback when done.","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/webauthprovider","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProvider","type":"topic"}}} \ 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 3badf4a0b..ee9fe893a 100644 --- a/docs/data/documentation/auth0/webauth/redirecturl(_:).json +++ b/docs/data/documentation/auth0/webauth/redirecturl(_:).json @@ -1 +1 @@ -{"metadata":{"externalID":"s:5Auth07WebAuthP11redirectURLyx10Foundation0E0VF","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"redirectURL","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:10Foundation3URLV","text":"URL","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"symbolKind":"method","roleHeading":"Instance Method","required":true,"role":"symbol","modules":[{"name":"Auth0"}],"title":"redirectURL(_:)"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/redirectURL(_:)","interfaceLanguage":"swift"},"schemaVersion":{"patch":0,"major":0,"minor":3},"abstract":[{"type":"text","text":"Specify a custom redirect URL to be used."}],"primaryContentSections":[{"declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"redirectURL","kind":"identifier"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"redirectURL","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"URL","preciseIdentifier":"s:10Foundation3URLV","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"},{"parameters":[{"content":[{"inlineContent":[{"type":"text","text":"Custom redirect URL."}],"type":"paragraph"}],"name":"redirectURL"}],"kind":"parameters"},{"kind":"content","content":[{"level":2,"anchor":"return-value","text":"Return Value","type":"heading"},{"inlineContent":[{"text":"The same ","type":"text"},{"code":"WebAuth","type":"codeVoice"},{"text":" instance to allow method chaining.","type":"text"}],"type":"paragraph"}]}],"variants":[{"paths":["\/documentation\/auth0\/webauth\/redirecturl(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"sections":[],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/redirectURL(_:)":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/redirectURL(_:)","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"redirectURL","kind":"identifier"},{"text":"(","kind":"text"},{"text":"URL","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"required":true,"role":"symbol","abstract":[{"type":"text","text":"Specify a custom redirect URL to be used."}],"url":"\/documentation\/auth0\/webauth\/redirecturl(_:)","title":"redirectURL(_:)"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"title":"WebAuth","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"url":"\/documentation\/auth0\/webauth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"kind":"symbol"}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/redirecturl(_:)"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"abstract":[{"type":"text","text":"Specify a custom redirect URL to be used."}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"redirectURL"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"redirectURL"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"URL","preciseIdentifier":"s:10Foundation3URLV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}]}],"kind":"declarations"},{"parameters":[{"content":[{"inlineContent":[{"text":"Custom redirect URL.","type":"text"}],"type":"paragraph"}],"name":"redirectURL"}],"kind":"parameters"},{"content":[{"level":2,"type":"heading","anchor":"return-value","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The same "},{"code":"WebAuth","type":"codeVoice"},{"type":"text","text":" instance to allow method chaining."}]}],"kind":"content"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","sections":[],"metadata":{"externalID":"s:5Auth07WebAuthP11redirectURLyx10Foundation0E0VF","symbolKind":"method","title":"redirectURL(_:)","required":true,"roleHeading":"Instance Method","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"redirectURL"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV","text":"URL"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"modules":[{"name":"Auth0"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/redirectURL(_:)","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/redirectURL(_:)":{"type":"topic","abstract":[{"type":"text","text":"Specify a custom redirect URL to be used."}],"title":"redirectURL(_:)","url":"\/documentation\/auth0\/webauth\/redirecturl(_:)","kind":"symbol","required":true,"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"redirectURL"},{"kind":"text","text":"("},{"preciseIdentifier":"s:10Foundation3URLV","kind":"typeIdentifier","text":"URL"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/redirectURL(_:)"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"url":"\/documentation\/auth0\/webauth","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"title":"WebAuth","navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","role":"symbol","kind":"symbol","type":"topic"}}} \ 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 e788da631..95905c643 100644 --- a/docs/data/documentation/auth0/webauth/scope(_:).json +++ b/docs/data/documentation/auth0/webauth/scope(_:).json @@ -1 +1 @@ -{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/scope(_:)"},"kind":"symbol","abstract":[{"text":"Specify the scopes that will be requested during authentication.","type":"text"}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"scope","kind":"identifier"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"scope","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"platforms":["iOS"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Space-separated list of requested scope values. For example,"},{"type":"text","text":" "},{"type":"codeVoice","code":"openid profile email offline_access"},{"type":"text","text":"."}]}],"name":"scope"}]},{"kind":"content","content":[{"type":"heading","text":"Return Value","anchor":"return-value","level":2},{"type":"paragraph","inlineContent":[{"type":"text","text":"The same "},{"type":"codeVoice","code":"WebAuth"},{"type":"text","text":" instance to allow method chaining."}]}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"sections":[],"metadata":{"modules":[{"name":"Auth0"}],"externalID":"s:5Auth07WebAuthP5scopeyxSSF","role":"symbol","title":"scope(_:)","required":true,"symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"scope","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"roleHeading":"Instance Method"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/scope(_:)"]}],"seeAlsoSections":[{"identifiers":["https:\/\/auth0.com\/docs\/get-started\/apis\/scopes"],"anchor":"Related-Documentation","title":"Related Documentation"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"references":{"https://auth0.com/docs/get-started/apis/scopes":{"type":"link","title":"Scopes","titleInlineContent":[{"type":"text","text":"Scopes"}],"identifier":"https:\/\/auth0.com\/docs\/get-started\/apis\/scopes","url":"https:\/\/auth0.com\/docs\/get-started\/apis\/scopes"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"title":"WebAuth","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"url":"\/documentation\/auth0\/webauth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/scope(_:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/scope(_:)","abstract":[{"text":"Specify the scopes that will be requested during authentication.","type":"text"}],"title":"scope(_:)","required":true,"role":"symbol","url":"\/documentation\/auth0\/webauth\/scope(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"scope"},{"kind":"text","text":"("},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"kind":"symbol","type":"topic"}}} \ No newline at end of file +{"metadata":{"externalID":"s:5Auth07WebAuthP5scopeyxSSF","symbolKind":"method","title":"scope(_:)","roleHeading":"Instance Method","required":true,"role":"symbol","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"},{"text":"Self","kind":"typeIdentifier"}],"modules":[{"name":"Auth0"}]},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/scope(_:)"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/scope(_:)","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"text":"Specify the scopes that will be requested during authentication.","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"seeAlsoSections":[{"title":"Related Documentation","anchor":"Related-Documentation","identifiers":["https:\/\/auth0.com\/docs\/get-started\/apis\/scopes"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"scope","kind":"identifier"},{"text":"(","kind":"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"]}]},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"type":"text","text":"Space-separated list of requested scope values. For example,"},{"type":"text","text":" "},{"code":"openid profile email offline_access","type":"codeVoice"},{"type":"text","text":"."}],"type":"paragraph"}],"name":"scope"}]},{"content":[{"level":2,"type":"heading","anchor":"return-value","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The same "},{"code":"WebAuth","type":"codeVoice"},{"type":"text","text":" instance to allow method chaining."}]}],"kind":"content"}],"schemaVersion":{"minor":3,"patch":0,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"url":"\/documentation\/auth0\/webauth","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"title":"WebAuth","navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","role":"symbol","kind":"symbol","type":"topic"},"https://auth0.com/docs/get-started/apis/scopes":{"title":"Scopes","type":"link","titleInlineContent":[{"type":"text","text":"Scopes"}],"identifier":"https:\/\/auth0.com\/docs\/get-started\/apis\/scopes","url":"https:\/\/auth0.com\/docs\/get-started\/apis\/scopes"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/scope(_:)":{"type":"topic","title":"scope(_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/scope(_:)","kind":"symbol","abstract":[{"type":"text","text":"Specify the scopes that will be requested during authentication."}],"url":"\/documentation\/auth0\/webauth\/scope(_:)","required":true,"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"scope"},{"text":"(","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ 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 88e4de307..a472b7727 100644 --- a/docs/data/documentation/auth0/webauth/start()-98znq.json +++ b/docs/data/documentation/auth0/webauth/start()-98znq.json @@ -1 +1 @@ -{"variants":[{"paths":["\/documentation\/auth0\/webauth\/start()-98znq"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"externalID":"s:5Auth07WebAuthP5startAA11CredentialsCyYaKF","role":"symbol","symbolKind":"method","roleHeading":"Instance Method","title":"start()","required":true,"modules":[{"name":"Auth0"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"start","kind":"identifier"},{"text":"() ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier"}]},"abstract":[{"text":"Starts the Web Auth flow.","type":"text"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"start"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","text":"Credentials"}]}],"kind":"declarations"},{"kind":"content","content":[{"type":"heading","text":"Return Value","level":2,"anchor":"return-value"},{"inlineContent":[{"text":"The result of the Web Auth flow.","type":"text"}],"type":"paragraph"}]},{"kind":"content","content":[{"type":"heading","anchor":"Usage","text":"Usage","level":2},{"type":"codeListing","syntax":"swift","code":["do {"," let credentials = try await Auth0.webAuth().start()"," print(\"Obtained credentials: \\(credentials)\")","} catch {"," print(\"Failed with: \\(error)\")","}"]},{"type":"paragraph","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 it will throw a "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/userCancelled","isActive":true},{"type":"text","text":" error."}]},{"type":"aside","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"An error of type "},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"},{"type":"text","text":"."}]}],"style":"note","name":"Throws"},{"type":"aside","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"type":"strong","inlineContent":[{"text":"Callback URL","type":"text"}]},{"type":"text","text":" to have been added to the "},{"type":"strong","inlineContent":[{"text":"Allowed Callback URLs","type":"text"}]},{"type":"text","text":" field of your Auth0"},{"type":"text","text":" "},{"type":"text","text":"application settings in the "},{"type":"reference","isActive":true,"identifier":"https:\/\/manage.auth0.com\/#\/applications\/"},{"type":"text","text":"."}]}],"style":"note","name":"Requires"}]}],"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\/start()-98znq"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"abstract":[{"text":"Represents an error during a Web Auth operation.","type":"text"}],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"type":"topic","role":"symbol","navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","title":"WebAuthError","url":"\/documentation\/auth0\/webautherror"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/userCancelled":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/userCancelled","kind":"symbol","role":"symbol","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","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/webautherror\/usercancelled","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"userCancelled"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"}],"title":"userCancelled","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"https://manage.auth0.com/#/applications/":{"identifier":"https:\/\/manage.auth0.com\/#\/applications\/","title":"Dashboard","type":"link","titleInlineContent":[{"text":"Dashboard","type":"text"}],"url":"https:\/\/manage.auth0.com\/#\/applications\/"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"title":"WebAuth","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"url":"\/documentation\/auth0\/webauth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"title":"cause","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","kind":"symbol","abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":"?"}],"role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"url":"\/documentation\/auth0\/credentials","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"role":"symbol","type":"topic","abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/start()-98znq":{"kind":"symbol","abstract":[{"type":"text","text":"Starts the Web Auth flow."}],"url":"\/documentation\/auth0\/webauth\/start()-98znq","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"start"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"}],"type":"topic","required":true,"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/start()-98znq","title":"start()"}}} \ No newline at end of file +{"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"start","kind":"identifier"},{"text":"() ","kind":"text"},{"kind":"keyword","text":"async"},{"text":" ","kind":"text"},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","text":"Credentials"}]}]},{"content":[{"level":2,"type":"heading","anchor":"return-value","text":"Return Value"},{"inlineContent":[{"type":"text","text":"The result of the Web Auth flow."}],"type":"paragraph"}],"kind":"content"},{"content":[{"type":"heading","level":2,"anchor":"Usage","text":"Usage"},{"code":["do {"," let credentials = try await Auth0.webAuth().start()"," print(\"Obtained credentials: \\(credentials)\")","} catch {"," print(\"Failed with: \\(error)\")","}"],"type":"codeListing","syntax":"swift"},{"inlineContent":[{"text":"Any ongoing Web Auth transaction will be automatically cancelled when starting a new one,","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"and it will throw a "},{"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":"An error of type "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","isActive":true},{"type":"text","text":"."}]}],"name":"Throws"},{"type":"aside","style":"note","content":[{"inlineContent":[{"type":"text","text":"The "},{"inlineContent":[{"text":"Callback URL","type":"text"}],"type":"strong"},{"type":"text","text":" to have been added to the "},{"inlineContent":[{"type":"text","text":"Allowed Callback URLs"}],"type":"strong"},{"text":" field of your Auth0","type":"text"},{"text":" ","type":"text"},{"text":"application settings in the ","type":"text"},{"identifier":"https:\/\/manage.auth0.com\/#\/applications\/","isActive":true,"type":"reference"},{"text":".","type":"text"}],"type":"paragraph"}],"name":"Requires"}],"kind":"content"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/start()-98znq"]}],"sections":[],"schemaVersion":{"patch":0,"minor":3,"major":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/start()-98znq","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"abstract":[{"text":"Starts the Web Auth flow.","type":"text"}],"metadata":{"role":"symbol","modules":[{"name":"Auth0"}],"title":"start()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"start"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials"}],"externalID":"s:5Auth07WebAuthP5startAA11CredentialsCyYaKF","roleHeading":"Instance Method","required":true,"symbolKind":"method"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"kind":"symbol","title":"cause","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier","text":"Error"},{"kind":"text","text":"?"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","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":"."}],"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"url":"\/documentation\/auth0\/webautherror","abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"title":"WebAuthError","navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/start()-98znq":{"kind":"symbol","title":"start()","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"start"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","text":"Credentials"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/start()-98znq","required":true,"abstract":[{"type":"text","text":"Starts the Web Auth flow."}],"url":"\/documentation\/auth0\/webauth\/start()-98znq"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"Credentials","kind":"identifier"}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"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":{"url":"\/documentation\/auth0\/webauth","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"title":"WebAuth","navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/userCancelled":{"kind":"symbol","title":"userCancelled","role":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"userCancelled"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/userCancelled","abstract":[{"type":"text","text":"The user cancelled the Web Auth operation."},{"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\/webautherror\/usercancelled"}}} \ 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 59130b8c2..92df98db5 100644 --- a/docs/data/documentation/auth0/webauth/start()-qpqo.json +++ b/docs/data/documentation/auth0/webauth/start()-qpqo.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"kind":"symbol","primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"start"},{"kind":"text","text":"() -> "},{"preciseIdentifier":"s:7Combine12AnyPublisherV","kind":"typeIdentifier","text":"AnyPublisher"},{"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":", "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier","text":"WebAuthError"},{"kind":"text","text":">"}]}],"kind":"declarations"},{"kind":"content","content":[{"type":"heading","anchor":"return-value","level":2,"text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A type-erased publisher."}]}]},{"kind":"content","content":[{"text":"Usage","type":"heading","level":2,"anchor":"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"},{"type":"paragraph","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 the subscription will complete with a result containing a "},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/userCancelled"},{"type":"text","text":" error."}]},{"style":"note","name":"Requires","content":[{"inlineContent":[{"text":"The ","type":"text"},{"type":"strong","inlineContent":[{"type":"text","text":"Callback URL"}]},{"text":" to have been added to the ","type":"text"},{"type":"strong","inlineContent":[{"type":"text","text":"Allowed Callback URLs"}]},{"text":" field of your Auth0","type":"text"},{"text":" ","type":"text"},{"text":"application settings in the ","type":"text"},{"identifier":"https:\/\/manage.auth0.com\/#\/applications\/","type":"reference","isActive":true},{"text":".","type":"text"}],"type":"paragraph"}],"type":"aside"}]}],"metadata":{"title":"start()","modules":[{"name":"Auth0"}],"externalID":"s:5Auth07WebAuthP5start7Combine12AnyPublisherVyAA11CredentialsCAA0bC5ErrorVGyF","required":true,"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"start","kind":"identifier"},{"text":"() -> ","kind":"text"},{"text":"AnyPublisher","preciseIdentifier":"s:7Combine12AnyPublisherV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"symbolKind":"method","roleHeading":"Instance Method","role":"symbol"},"sections":[],"schemaVersion":{"patch":0,"minor":3,"major":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/start()-qpqo","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Starts the Web Auth flow."}],"variants":[{"paths":["\/documentation\/auth0\/webauth\/start()-qpqo"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"title":"WebAuth","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"url":"\/documentation\/auth0\/webauth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"url":"\/documentation\/auth0\/credentials","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"role":"symbol","type":"topic","abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/userCancelled":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/userCancelled","kind":"symbol","role":"symbol","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","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/webautherror\/usercancelled","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"userCancelled"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"}],"title":"userCancelled","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"title":"cause","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","kind":"symbol","abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":"?"}],"role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"abstract":[{"text":"Represents an error during a Web Auth operation.","type":"text"}],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"type":"topic","role":"symbol","navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","title":"WebAuthError","url":"\/documentation\/auth0\/webautherror"},"https://manage.auth0.com/#/applications/":{"identifier":"https:\/\/manage.auth0.com\/#\/applications\/","type":"link","titleInlineContent":[{"type":"text","text":"Dashboard"}],"url":"https:\/\/manage.auth0.com\/#\/applications\/","title":"Dashboard"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/start()-qpqo":{"abstract":[{"type":"text","text":"Starts the Web Auth flow."}],"url":"\/documentation\/auth0\/webauth\/start()-qpqo","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"start"},{"kind":"text","text":"() -> "},{"preciseIdentifier":"s:7Combine12AnyPublisherV","kind":"typeIdentifier","text":"AnyPublisher"},{"kind":"text","text":"<"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier","text":"Credentials"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier","text":"WebAuthError"},{"kind":"text","text":">"}],"kind":"symbol","type":"topic","required":true,"title":"start()","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/start()-qpqo"}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/start()-qpqo"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"abstract":[{"type":"text","text":"Starts the Web Auth flow."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"start"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","text":"AnyPublisher","preciseIdentifier":"s:7Combine12AnyPublisherV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Credentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"WebAuthError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV"},{"kind":"text","text":">"}],"languages":["swift"],"platforms":["iOS"]}]},{"content":[{"type":"heading","text":"Return Value","anchor":"return-value","level":2},{"type":"paragraph","inlineContent":[{"text":"A type-erased publisher.","type":"text"}]}],"kind":"content"},{"content":[{"type":"heading","text":"Usage","anchor":"Usage","level":2},{"type":"codeListing","code":["Auth0"," .webAuth()"," .start()"," .sink(receiveCompletion: { completion in"," if case .failure(let error) = completion {"," print(\"Failed with: \\(error)\")"," }"," }, receiveValue: { credentials in"," print(\"Obtained credentials: \\(credentials)\")"," })"," .store(in: &cancellables)"],"syntax":"swift"},{"type":"paragraph","inlineContent":[{"text":"Any ongoing Web Auth transaction will be automatically cancelled when starting a new one,","type":"text"},{"text":" ","type":"text"},{"text":"and the subscription will complete with a result containing a ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/userCancelled","type":"reference"},{"text":" error.","type":"text"}]},{"type":"aside","name":"Requires","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":[{"type":"text","text":"Allowed Callback URLs"}]},{"type":"text","text":" field of your Auth0"},{"type":"text","text":" "},{"type":"text","text":"application settings in the "},{"type":"reference","identifier":"https:\/\/manage.auth0.com\/#\/applications\/","isActive":true},{"type":"text","text":"."}],"type":"paragraph"}]}],"kind":"content"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","sections":[],"metadata":{"externalID":"s:5Auth07WebAuthP5start7Combine12AnyPublisherVyAA11CredentialsCAA0bC5ErrorVGyF","symbolKind":"method","title":"start()","roleHeading":"Instance Method","role":"symbol","required":true,"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"start","kind":"identifier"},{"text":"() -> ","kind":"text"},{"preciseIdentifier":"s:7Combine12AnyPublisherV","text":"AnyPublisher","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError","kind":"typeIdentifier"},{"text":">","kind":"text"}],"modules":[{"name":"Auth0"}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/start()-qpqo"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"kind":"symbol","title":"cause","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier","text":"Error"},{"kind":"text","text":"?"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","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":"."}],"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi"},"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"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"url":"\/documentation\/auth0\/webauth","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"title":"WebAuth","navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"url":"\/documentation\/auth0\/webautherror","abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"title":"WebAuthError","navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/start()-qpqo":{"type":"topic","abstract":[{"type":"text","text":"Starts the Web Auth flow."}],"title":"start()","url":"\/documentation\/auth0\/webauth\/start()-qpqo","kind":"symbol","required":true,"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"start","kind":"identifier"},{"text":"() -> ","kind":"text"},{"text":"AnyPublisher","preciseIdentifier":"s:7Combine12AnyPublisherV","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/start()-qpqo"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"Credentials","kind":"identifier"}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/userCancelled":{"kind":"symbol","title":"userCancelled","role":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"userCancelled"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/userCancelled","abstract":[{"type":"text","text":"The user cancelled the Web Auth operation."},{"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\/webautherror\/usercancelled"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webauth/start(_:).json b/docs/data/documentation/auth0/webauth/start(_:).json index 7fdc520d2..3fc33cb43 100644 --- a/docs/data/documentation/auth0/webauth/start(_:).json +++ b/docs/data/documentation/auth0/webauth/start(_:).json @@ -1 +1 @@ -{"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"}],"kind":"symbol","primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"start","kind":"identifier"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"callback","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"@escaping","kind":"attribute"},{"text":" (","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult","text":"WebAuthResult","kind":"typeIdentifier","preciseIdentifier":"s:5Auth013WebAuthResulta"},{"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":">) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"kind":"text","text":")"}],"languages":["swift"]}],"kind":"declarations"},{"parameters":[{"content":[{"inlineContent":[{"type":"text","text":"Callback that receives a "},{"code":"Result","type":"codeVoice"},{"type":"text","text":" containing either the user’s credentials or an error."}],"type":"paragraph"}],"name":"callback"}],"kind":"parameters"},{"kind":"content","content":[{"type":"heading","level":2,"anchor":"Usage","text":"Usage"},{"type":"codeListing","code":["Auth0"," .webAuth()"," .start { result in"," switch result {"," case .success(let credentials):"," print(\"Obtained credentials: \\(credentials)\")"," case .failure(let error):"," print(\"Failed with: \\(error)\")"," }","}"],"syntax":"swift"},{"type":"paragraph","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 "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/userCancelled"},{"type":"text","text":" error."}]},{"type":"aside","content":[{"inlineContent":[{"type":"text","text":"The "},{"type":"strong","inlineContent":[{"type":"text","text":"Callback URL"}]},{"type":"text","text":" to have been added to the "},{"type":"strong","inlineContent":[{"text":"Allowed Callback URLs","type":"text"}]},{"type":"text","text":" field of your Auth0"},{"type":"text","text":" "},{"type":"text","text":"application settings in the "},{"type":"reference","isActive":true,"identifier":"https:\/\/manage.auth0.com\/#\/applications\/"},{"type":"text","text":"."}],"type":"paragraph"}],"style":"note","name":"Requires"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/start(_:)","interfaceLanguage":"swift"},"variants":[{"paths":["\/documentation\/auth0\/webauth\/start(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"start","kind":"identifier"},{"text":"((","kind":"text"},{"text":"WebAuthResult","kind":"typeIdentifier","preciseIdentifier":"s:5Auth013WebAuthResulta"},{"text":"<","kind":"text"},{"text":"Credentials","kind":"typeIdentifier","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"text":">) -> ","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":")","kind":"text"}],"externalID":"s:5Auth07WebAuthP5startyyys6ResultOyAA11CredentialsCAA0bC5ErrorVGcF","title":"start(_:)","roleHeading":"Instance Method","required":true,"symbolKind":"method","modules":[{"name":"Auth0"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"title":"WebAuth","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"url":"\/documentation\/auth0\/webauth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/start(_:)":{"abstract":[{"text":"Starts the Web Auth flow.","type":"text"}],"required":true,"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"start","kind":"identifier"},{"text":"((","kind":"text"},{"preciseIdentifier":"s:5Auth013WebAuthResulta","text":"WebAuthResult","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","text":"Credentials","kind":"typeIdentifier"},{"text":">) -> ","kind":"text"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"text":")","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/start(_:)","url":"\/documentation\/auth0\/webauth\/start(_:)","title":"start(_:)","type":"topic","kind":"symbol","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"title":"cause","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","kind":"symbol","abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":"?"}],"role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/userCancelled":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/userCancelled","kind":"symbol","role":"symbol","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","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/webautherror\/usercancelled","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"userCancelled"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"}],"title":"userCancelled","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthResult":{"url":"\/documentation\/auth0\/webauthresult","navigatorTitle":[{"text":"WebAuthResult","kind":"identifier"}],"title":"WebAuthResult","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult","abstract":[{"code":"Result","type":"codeVoice"},{"text":" wrapper for Web Auth operations.","type":"text"}],"type":"topic","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthResult","kind":"identifier"}],"kind":"symbol","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}],"url":"\/documentation\/auth0\/credentials","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"Credentials"}],"role":"symbol","type":"topic","abstract":[{"text":"User’s credentials obtained from Auth0.","type":"text"}]},"https://manage.auth0.com/#/applications/":{"titleInlineContent":[{"text":"Dashboard","type":"text"}],"identifier":"https:\/\/manage.auth0.com\/#\/applications\/","url":"https:\/\/manage.auth0.com\/#\/applications\/","type":"link","title":"Dashboard"}}} \ No newline at end of file +{"abstract":[{"text":"Starts the Web Auth flow.","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"start","kind":"identifier"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"callback","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"@escaping","kind":"attribute"},{"text":" (","kind":"text"},{"preciseIdentifier":"s:5Auth013WebAuthResulta","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult","text":"WebAuthResult","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","text":"Credentials","kind":"typeIdentifier"},{"text":">) -> ","kind":"text"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"text":")","kind":"text"}],"platforms":["iOS"]}]},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"type":"text","text":"Callback that receives a "},{"type":"codeVoice","code":"Result"},{"type":"text","text":" containing either the user’s credentials or an error."}],"type":"paragraph"}],"name":"callback"}]},{"content":[{"text":"Usage","level":2,"anchor":"Usage","type":"heading"},{"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)\")"," }","}"],"type":"codeListing"},{"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"},{"name":"Requires","style":"note","content":[{"inlineContent":[{"type":"text","text":"The "},{"type":"strong","inlineContent":[{"text":"Callback URL","type":"text"}]},{"type":"text","text":" to have been added to the "},{"type":"strong","inlineContent":[{"text":"Allowed Callback URLs","type":"text"}]},{"type":"text","text":" field of your Auth0"},{"type":"text","text":" "},{"type":"text","text":"application settings in the "},{"type":"reference","isActive":true,"identifier":"https:\/\/manage.auth0.com\/#\/applications\/"},{"type":"text","text":"."}],"type":"paragraph"}],"type":"aside"}],"kind":"content"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/start(_:)"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"metadata":{"symbolKind":"method","title":"start(_:)","externalID":"s:5Auth07WebAuthP5startyyys6ResultOyAA11CredentialsCAA0bC5ErrorVGcF","roleHeading":"Instance Method","modules":[{"name":"Auth0"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"start","kind":"identifier"},{"text":"((","kind":"text"},{"text":"WebAuthResult","preciseIdentifier":"s:5Auth013WebAuthResulta","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials","kind":"typeIdentifier"},{"text":">) -> ","kind":"text"},{"text":"Void","preciseIdentifier":"s:s4Voida","kind":"typeIdentifier"},{"text":")","kind":"text"}],"role":"symbol","required":true},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/start(_:)"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"kind":"symbol","title":"cause","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier","text":"Error"},{"kind":"text","text":"?"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","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":"."}],"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/start(_:)":{"kind":"symbol","required":true,"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"start"},{"kind":"text","text":"(("},{"kind":"typeIdentifier","text":"WebAuthResult","preciseIdentifier":"s:5Auth013WebAuthResulta"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Credentials","preciseIdentifier":"c:@M@Auth0@objc(cs)A0Credentials"},{"kind":"text","text":">) -> "},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"},{"kind":"text","text":")"}],"title":"start(_:)","type":"topic","role":"symbol","abstract":[{"text":"Starts the Web Auth flow.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/start(_:)","url":"\/documentation\/auth0\/webauth\/start(_:)"},"doc://com.auth0.Auth0/documentation/Auth0/Credentials":{"title":"Credentials","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Credentials","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"Credentials","kind":"identifier"}],"abstract":[{"type":"text","text":"User’s credentials obtained from Auth0."}],"url":"\/documentation\/auth0\/credentials","navigatorTitle":[{"kind":"identifier","text":"Credentials"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"https://manage.auth0.com/#/applications/":{"title":"Dashboard","titleInlineContent":[{"text":"Dashboard","type":"text"}],"url":"https:\/\/manage.auth0.com\/#\/applications\/","identifier":"https:\/\/manage.auth0.com\/#\/applications\/","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthResult":{"url":"\/documentation\/auth0\/webauthresult","title":"WebAuthResult","abstract":[{"code":"Result","type":"codeVoice"},{"type":"text","text":" wrapper for Web Auth operations."}],"navigatorTitle":[{"text":"WebAuthResult","kind":"identifier"}],"fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthResult","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"url":"\/documentation\/auth0\/webauth","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"title":"WebAuth","navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/userCancelled":{"kind":"symbol","title":"userCancelled","role":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"userCancelled"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/userCancelled","abstract":[{"type":"text","text":"The user cancelled the Web Auth operation."},{"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\/webautherror\/usercancelled"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webauth/state(_:).json b/docs/data/documentation/auth0/webauth/state(_:).json index 1050d460b..7eb09fe4e 100644 --- a/docs/data/documentation/auth0/webauth/state(_:).json +++ b/docs/data/documentation/auth0/webauth/state(_:).json @@ -1 +1 @@ -{"sections":[],"metadata":{"roleHeading":"Instance Method","required":true,"externalID":"s:5Auth07WebAuthP5stateyxSSF","title":"state(_:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"state","kind":"identifier"},{"text":"(","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"modules":[{"name":"Auth0"}],"symbolKind":"method"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/state(_:)","interfaceLanguage":"swift"},"schemaVersion":{"minor":3,"major":0,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"kind":"symbol","primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"state","kind":"identifier"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"state","kind":"internalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"languages":["swift"]}],"kind":"declarations"},{"parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"State value."}]}],"name":"state"}],"kind":"parameters"},{"content":[{"level":2,"text":"Return Value","anchor":"return-value","type":"heading"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The same "},{"code":"WebAuth","type":"codeVoice"},{"type":"text","text":" instance to allow method chaining."}]}],"kind":"content"}],"variants":[{"paths":["\/documentation\/auth0\/webauth\/state(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"text":"Specify a ","type":"text"},{"type":"codeVoice","code":"state"},{"text":" parameter that will be sent back after authentication to verify that the response","type":"text"},{"text":" ","type":"text"},{"text":"corresponds to your request.","type":"text"},{"text":" ","type":"text"},{"text":"By default a random value is used.","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"title":"WebAuth","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"url":"\/documentation\/auth0\/webauth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/state(_:)":{"kind":"symbol","role":"symbol","title":"state(_:)","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/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":" "},{"type":"text","text":"corresponds to your request."},{"type":"text","text":" "},{"type":"text","text":"By default a random value is used."}],"url":"\/documentation\/auth0\/webauth\/state(_:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"state","kind":"identifier"},{"text":"(","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"required":true}}} \ No newline at end of file +{"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":" "},{"type":"text","text":"corresponds to your request."},{"type":"text","text":" "},{"type":"text","text":"By default a random value is used."}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"state"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"text":"state","kind":"internalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"state","content":[{"inlineContent":[{"type":"text","text":"State value."}],"type":"paragraph"}]}]},{"kind":"content","content":[{"type":"heading","text":"Return Value","anchor":"return-value","level":2},{"inlineContent":[{"type":"text","text":"The same "},{"type":"codeVoice","code":"WebAuth"},{"type":"text","text":" instance to allow method chaining."}],"type":"paragraph"}]}],"variants":[{"paths":["\/documentation\/auth0\/webauth\/state(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"metadata":{"externalID":"s:5Auth07WebAuthP5stateyxSSF","modules":[{"name":"Auth0"}],"title":"state(_:)","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"state","kind":"identifier"},{"kind":"text","text":"("},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"Self","kind":"typeIdentifier"}],"roleHeading":"Instance Method","role":"symbol","required":true,"symbolKind":"method"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/state(_:)","interfaceLanguage":"swift"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"url":"\/documentation\/auth0\/webauth","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"title":"WebAuth","navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/state(_:)":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/state(_:)","title":"state(_:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"state","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"role":"symbol","required":true,"url":"\/documentation\/auth0\/webauth\/state(_:)","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":" "},{"type":"text","text":"corresponds to your request."},{"type":"text","text":" "},{"type":"text","text":"By default a random value is used."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ 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 1a0b8100c..e8deb145a 100644 --- a/docs/data/documentation/auth0/webauth/telemetry.json +++ b/docs/data/documentation/auth0/webauth/telemetry.json @@ -1 +1 @@ -{"sections":[],"schemaVersion":{"major":0,"patch":0,"minor":3},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"telemetry"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth09TelemetryV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","kind":"typeIdentifier","text":"Telemetry"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" "},{"kind":"keyword","text":"set"},{"kind":"text","text":" }"}],"platforms":["iOS"]}]}],"variants":[{"paths":["\/documentation\/auth0\/webauth\/telemetry"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"metadata":{"roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"symbolKind":"property","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"telemetry","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Telemetry","kind":"typeIdentifier","preciseIdentifier":"s:5Auth09TelemetryV"}],"externalID":"s:5Auth07WebAuthP9telemetryAA9TelemetryVvp","title":"telemetry","role":"symbol","required":true},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/telemetry"},"kind":"symbol","abstract":[{"text":"The ","type":"text"},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry"},{"text":" instance.","type":"text"}],"references":{"doc://com.auth0.Auth0/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"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/telemetry","title":"telemetry","required":true,"type":"topic","url":"\/documentation\/auth0\/webauth\/telemetry","kind":"symbol","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"telemetry","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Telemetry","kind":"typeIdentifier","preciseIdentifier":"s:5Auth09TelemetryV"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"title":"WebAuth","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"url":"\/documentation\/auth0\/webauth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Telemetry":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Telemetry","kind":"identifier"}],"title":"Telemetry","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","url":"\/documentation\/auth0\/telemetry","kind":"symbol","abstract":[{"text":"Generates and sets the ","type":"text"},{"type":"codeVoice","code":"Auth0-Client"},{"text":" header.","type":"text"}],"role":"symbol","navigatorTitle":[{"text":"Telemetry","kind":"identifier"}],"type":"topic"}}} \ No newline at end of file +{"sections":[],"metadata":{"symbolKind":"property","title":"telemetry","roleHeading":"Instance Property","externalID":"s:5Auth07WebAuthP9telemetryAA9TelemetryVvp","modules":[{"name":"Auth0"}],"fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"telemetry","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth09TelemetryV","text":"Telemetry","kind":"typeIdentifier"}],"role":"symbol","required":true},"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/telemetry"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/telemetry"]}],"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":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"telemetry"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Telemetry","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","preciseIdentifier":"s:5Auth09TelemetryV"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" "},{"kind":"keyword","text":"set"},{"kind":"text","text":" }"}]}]}],"abstract":[{"type":"text","text":"The "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","type":"reference","isActive":true},{"type":"text","text":" instance."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/Telemetry":{"kind":"symbol","abstract":[{"text":"Generates and sets the ","type":"text"},{"code":"Auth0-Client","type":"codeVoice"},{"text":" header.","type":"text"}],"type":"topic","title":"Telemetry","url":"\/documentation\/auth0\/telemetry","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Telemetry"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry","navigatorTitle":[{"kind":"identifier","text":"Telemetry"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"url":"\/documentation\/auth0\/webauth","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"title":"WebAuth","navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/telemetry":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/telemetry","title":"telemetry","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"telemetry","kind":"identifier"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Telemetry","preciseIdentifier":"s:5Auth09TelemetryV"}],"role":"symbol","required":true,"url":"\/documentation\/auth0\/webauth\/telemetry","abstract":[{"text":"The ","type":"text"},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Telemetry"},{"text":" instance.","type":"text"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ 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 53515539e..53411b803 100644 --- a/docs/data/documentation/auth0/webauth/url.json +++ b/docs/data/documentation/auth0/webauth/url.json @@ -1 +1 @@ -{"variants":[{"paths":["\/documentation\/auth0\/webauth\/url"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"schemaVersion":{"minor":3,"major":0,"patch":0},"abstract":[{"type":"text","text":"The Auth0 Domain URL."}],"kind":"symbol","primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"url","kind":"identifier"},{"text":": ","kind":"text"},{"text":"URL","preciseIdentifier":"s:10Foundation3URLV","kind":"typeIdentifier"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}]}],"kind":"declarations"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/url"},"metadata":{"externalID":"s:5Auth07WebAuthP3url10Foundation3URLVvp","required":true,"title":"url","modules":[{"name":"Auth0"}],"role":"symbol","roleHeading":"Instance Property","symbolKind":"property","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"url","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation3URLV","text":"URL","kind":"typeIdentifier"}]},"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"title":"WebAuth","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"url":"\/documentation\/auth0\/webauth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/url":{"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"url"},{"kind":"text","text":": "},{"preciseIdentifier":"s:10Foundation3URLV","kind":"typeIdentifier","text":"URL"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/url","role":"symbol","kind":"symbol","abstract":[{"type":"text","text":"The Auth0 Domain URL."}],"title":"url","url":"\/documentation\/auth0\/webauth\/url","required":true}}} \ No newline at end of file +{"metadata":{"symbolKind":"property","title":"url","externalID":"s:5Auth07WebAuthP3url10Foundation3URLVvp","roleHeading":"Instance Property","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"url"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"URL","preciseIdentifier":"s:10Foundation3URLV"}],"role":"symbol","required":true},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/url"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/url","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"text":"The Auth0 Domain URL.","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"url"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"URL","preciseIdentifier":"s:10Foundation3URLV"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"url":"\/documentation\/auth0\/webauth","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"title":"WebAuth","navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/url":{"type":"topic","title":"url","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/url","kind":"symbol","abstract":[{"text":"The Auth0 Domain URL.","type":"text"}],"url":"\/documentation\/auth0\/webauth\/url","required":true,"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"url"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"URL","preciseIdentifier":"s:10Foundation3URLV"}]}}} \ 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 86ab2a0af..c7ae77f42 100644 --- a/docs/data/documentation/auth0/webauth/useephemeralsession().json +++ b/docs/data/documentation/auth0/webauth/useephemeralsession().json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"useEphemeralSession"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","text":"Self"}]}]},{"content":[{"level":2,"type":"heading","text":"Return Value","anchor":"return-value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The same "},{"type":"codeVoice","code":"WebAuth"},{"type":"text","text":" instance to allow method chaining."}]}],"kind":"content"},{"content":[{"anchor":"discussion","text":"Discussion","type":"heading","level":2},{"name":"Important","type":"aside","style":"important","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"You don’t need to call "},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:callback:)-9yv61"},{"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."}]}]},{"name":"Note","type":"aside","style":"note","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},{"type":"text","text":". Use either one or the other, because this"},{"type":"text","text":" "},{"type":"text","text":"method will only work with the default "},{"type":"codeVoice","code":"ASWebAuthenticationSession"},{"type":"text","text":" implementation."}],"type":"paragraph"}]}],"kind":"content"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()","interfaceLanguage":"swift"},"sections":[],"abstract":[{"text":"Use a private browser session to avoid storing the session cookie in the shared cookie jar.","type":"text"},{"text":" ","type":"text"},{"text":"Using this method will disable single sign-on (SSO).","type":"text"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/useephemeralsession()"]}],"metadata":{"title":"useEphemeralSession()","role":"symbol","required":true,"roleHeading":"Instance Method","symbolKind":"method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"useEphemeralSession"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","text":"Self"}],"modules":[{"name":"Auth0"}],"externalID":"s:5Auth07WebAuthP19useEphemeralSessionxyF"},"seeAlsoSections":[{"title":"Related Documentation","anchor":"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":{"patch":0,"minor":3,"major":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/provider(_:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/provider(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"provider"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"WebAuthProvider","preciseIdentifier":"s:5Auth015WebAuthProvidera"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"kind":"symbol","required":true,"type":"topic","abstract":[{"text":"Specify a custom Web Auth provider to use instead of the default ","type":"text"},{"type":"codeVoice","code":"ASWebAuthenticationSession"},{"text":" implementation.","type":"text"}],"url":"\/documentation\/auth0\/webauth\/provider(_:)","title":"provider(_:)","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/UserAgents":{"title":"ASWebAuthenticationSession vs SFSafariViewController (iOS)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserAgents","abstract":[],"kind":"article","type":"topic","role":"article","url":"\/documentation\/auth0\/useragents"},"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"},{"text":"federated","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"callback","kind":"externalParam"},{"text":": (","kind":"text"},{"preciseIdentifier":"s:5Auth013WebAuthResulta","text":"WebAuthResult","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"text":">) -> ","kind":"text"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"text":")","kind":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:callback:)-9yv61","abstract":[{"text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session.","type":"text"}],"url":"\/documentation\/auth0\/webauth\/clearsession(federated:callback:)-9yv61","type":"topic","kind":"symbol","title":"clearSession(federated:callback:)","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/useEphemeralSession()":{"type":"topic","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)."}],"role":"symbol","url":"\/documentation\/auth0\/webauth\/useephemeralsession()","kind":"symbol","title":"useEphemeralSession()","required":true,"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"useEphemeralSession"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","text":"Self"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"title":"WebAuth","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"url":"\/documentation\/auth0\/webauth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"kind":"symbol"},"https://developer.apple.com/documentation/authenticationservices/aswebauthenticationsession/3237231-prefersephemeralwebbrowsersessio":{"type":"link","url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/aswebauthenticationsession\/3237231-prefersephemeralwebbrowsersessio","titleInlineContent":[{"text":"prefersEphemeralWebBrowserSession","type":"text"}],"title":"prefersEphemeralWebBrowserSession","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/aswebauthenticationsession\/3237231-prefersephemeralwebbrowsersessio"},"https://github.com/auth0/Auth0.swift/blob/master/FAQ.md":{"type":"link","url":"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"}}} \ No newline at end of file +{"schemaVersion":{"minor":3,"patch":0,"major":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"useEphemeralSession","kind":"identifier"},{"text":"() -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"platforms":["iOS"],"languages":["swift"]}]},{"content":[{"anchor":"return-value","text":"Return Value","type":"heading","level":2},{"type":"paragraph","inlineContent":[{"text":"The same ","type":"text"},{"code":"WebAuth","type":"codeVoice"},{"text":" instance to allow method chaining.","type":"text"}]}],"kind":"content"},{"content":[{"anchor":"discussion","text":"Discussion","type":"heading","level":2},{"name":"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"},{"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":"text"}],"type":"paragraph"}],"style":"important","type":"aside"},{"name":"Note","content":[{"inlineContent":[{"text":"Don’t use this method along with ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/provider(_:)","type":"reference"},{"text":". Use either one or the other, because this","type":"text"},{"text":" ","type":"text"},{"text":"method will only work with the default ","type":"text"},{"code":"ASWebAuthenticationSession","type":"codeVoice"},{"text":" implementation.","type":"text"}],"type":"paragraph"}],"style":"note","type":"aside"}],"kind":"content"}],"sections":[],"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"}],"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"],"anchor":"Related-Documentation"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/useephemeralsession()"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()","interfaceLanguage":"swift"},"metadata":{"modules":[{"name":"Auth0"}],"title":"useEphemeralSession()","externalID":"s:5Auth07WebAuthP19useEphemeralSessionxyF","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"useEphemeralSession","kind":"identifier"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","text":"Self"}],"roleHeading":"Instance Method","symbolKind":"method","required":true},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserAgents":{"title":"ASWebAuthenticationSession vs SFSafariViewController (iOS)","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserAgents","role":"article","kind":"article","abstract":[],"url":"\/documentation\/auth0\/useragents"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"url":"\/documentation\/auth0\/webauth","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"title":"WebAuth","navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/useEphemeralSession()":{"url":"\/documentation\/auth0\/webauth\/useephemeralsession()","title":"useEphemeralSession()","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)."}],"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"useEphemeralSession"},{"text":"() -> ","kind":"text"},{"kind":"typeIdentifier","text":"Self"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useEphemeralSession()","required":true,"kind":"symbol","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/clearSession(federated:callback:)-9yv61":{"role":"symbol","title":"clearSession(federated:callback:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"clearSession"},{"kind":"text","text":"("},{"text":"federated","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"callback","kind":"externalParam"},{"text":": (","kind":"text"},{"preciseIdentifier":"s:5Auth013WebAuthResulta","text":"WebAuthResult","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"text":">) -> ","kind":"text"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"text":")","kind":"text"}],"abstract":[{"text":"Removes the Auth0 session and optionally removes the identity provider (IdP) session.","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/webauth\/clearsession(federated:callback:)-9yv61","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/clearSession(federated:callback:)-9yv61","type":"topic"},"https://developer.apple.com/documentation/authenticationservices/aswebauthenticationsession/3237231-prefersephemeralwebbrowsersessio":{"url":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/aswebauthenticationsession\/3237231-prefersephemeralwebbrowsersessio","titleInlineContent":[{"text":"prefersEphemeralWebBrowserSession","type":"text"}],"title":"prefersEphemeralWebBrowserSession","identifier":"https:\/\/developer.apple.com\/documentation\/authenticationservices\/aswebauthenticationsession\/3237231-prefersephemeralwebbrowsersessio","type":"link"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/provider(_:)":{"url":"\/documentation\/auth0\/webauth\/provider(_:)","abstract":[{"text":"Specify a custom Web Auth provider to use instead of the default ","type":"text"},{"code":"ASWebAuthenticationSession","type":"codeVoice"},{"text":" implementation.","type":"text"}],"title":"provider(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"provider"},{"kind":"text","text":"("},{"text":"WebAuthProvider","preciseIdentifier":"s:5Auth015WebAuthProvidera","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/provider(_:)","required":true,"kind":"symbol","role":"symbol","type":"topic"},"https://github.com/auth0/Auth0.swift/blob/master/FAQ.md":{"url":"https:\/\/github.com\/auth0\/Auth0.swift\/blob\/master\/FAQ.md","titleInlineContent":[{"type":"text","text":"FAQ"}],"title":"FAQ","identifier":"https:\/\/github.com\/auth0\/Auth0.swift\/blob\/master\/FAQ.md","type":"link"}}} \ 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 4a39776a6..0d693d780 100644 --- a/docs/data/documentation/auth0/webauth/usehttps().json +++ b/docs/data/documentation/auth0/webauth/usehttps().json @@ -1 +1 @@ -{"metadata":{"modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"useHTTPS"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","text":"Self"}],"required":true,"roleHeading":"Instance Method","externalID":"s:5Auth07WebAuthP8useHTTPSxyF","role":"symbol","title":"useHTTPS()","symbolKind":"method"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useHTTPS()"},"sections":[],"schemaVersion":{"minor":3,"patch":0,"major":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":" "},{"type":"text","text":"macOS, the bundle identifier of the app will be used as a custom scheme."}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"useHTTPS","kind":"identifier"},{"text":"() -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"platforms":["iOS"]}]},{"kind":"content","content":[{"type":"heading","text":"Return Value","level":2,"anchor":"return-value"},{"type":"paragraph","inlineContent":[{"text":"The same ","type":"text"},{"code":"WebAuth","type":"codeVoice"},{"text":" instance to allow method chaining.","type":"text"}]}]},{"kind":"content","content":[{"anchor":"discussion","text":"Discussion","type":"heading","level":2},{"style":"note","type":"aside","name":"Requires","content":[{"inlineContent":[{"text":"An Associated Domain configured with the ","type":"text"},{"type":"codeVoice","code":"webcredentials"},{"text":" service type. For example,","type":"text"},{"text":" ","type":"text"},{"type":"codeVoice","code":"webcredentials:example.com"},{"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":"text"}],"type":"paragraph"}]},{"style":"note","type":"aside","name":"Note","content":[{"inlineContent":[{"text":"Don’t use this method along with ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/provider(_:)","type":"reference","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":"paragraph"}]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/usehttps()"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"title":"WebAuth","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"url":"\/documentation\/auth0\/webauth","navigatorTitle":[{"text":"WebAuth","kind":"identifier"}],"kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/useHTTPS()":{"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":" "},{"type":"text","text":"macOS, the bundle identifier of the app will be used as a custom scheme."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useHTTPS()","title":"useHTTPS()","required":true,"type":"topic","url":"\/documentation\/auth0\/webauth\/usehttps()","kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"useHTTPS"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","text":"Self"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/provider(_:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/provider(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"provider"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"WebAuthProvider","preciseIdentifier":"s:5Auth015WebAuthProvidera"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"kind":"symbol","required":true,"type":"topic","abstract":[{"text":"Specify a custom Web Auth provider to use instead of the default ","type":"text"},{"type":"codeVoice","code":"ASWebAuthenticationSession"},{"text":" implementation.","type":"text"}],"url":"\/documentation\/auth0\/webauth\/provider(_:)","title":"provider(_:)","role":"symbol"}}} \ No newline at end of file +{"sections":[],"kind":"symbol","metadata":{"modules":[{"name":"Auth0"}],"externalID":"s:5Auth07WebAuthP8useHTTPSxyF","title":"useHTTPS()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"useHTTPS"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","text":"Self"}],"roleHeading":"Instance Method","role":"symbol","required":true,"symbolKind":"method"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useHTTPS()","interfaceLanguage":"swift"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauth\/usehttps()"]}],"schemaVersion":{"patch":0,"minor":3,"major":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"useHTTPS","kind":"identifier"},{"text":"() -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"platforms":["iOS"],"languages":["swift"]}]},{"kind":"content","content":[{"type":"heading","level":2,"anchor":"return-value","text":"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":[{"type":"heading","level":2,"anchor":"discussion","text":"Discussion"},{"style":"note","content":[{"inlineContent":[{"type":"text","text":"An Associated Domain configured with the "},{"type":"codeVoice","code":"webcredentials"},{"type":"text","text":" service type. For example,"},{"type":"text","text":" "},{"type":"codeVoice","code":"webcredentials:example.com"},{"type":"text","text":". If you’re using a custom domain on your Auth0 tenant, use this domain as the"},{"type":"text","text":" "},{"type":"text","text":"Associated Domain. Otherwise, use the domain of your Auth0 tenant."}],"type":"paragraph"}],"type":"aside","name":"Requires"},{"style":"note","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},{"type":"text","text":". Use either one or the other, because this"},{"type":"text","text":" "},{"type":"text","text":"method will only work with the default "},{"type":"codeVoice","code":"ASWebAuthenticationSession"},{"type":"text","text":" implementation."}],"type":"paragraph"}],"type":"aside","name":"Note"}]}],"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":" "},{"type":"text","text":"macOS, the bundle identifier of the app will be used as a custom scheme."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/provider(_:)":{"url":"\/documentation\/auth0\/webauth\/provider(_:)","abstract":[{"text":"Specify a custom Web Auth provider to use instead of the default ","type":"text"},{"code":"ASWebAuthenticationSession","type":"codeVoice"},{"text":" implementation.","type":"text"}],"title":"provider(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"provider"},{"kind":"text","text":"("},{"text":"WebAuthProvider","preciseIdentifier":"s:5Auth015WebAuthProvidera","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/provider(_:)","required":true,"kind":"symbol","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth":{"url":"\/documentation\/auth0\/webauth","abstract":[{"type":"text","text":"Web-based authentication using Auth0."}],"title":"WebAuth","navigatorTitle":[{"kind":"identifier","text":"WebAuth"}],"fragments":[{"kind":"keyword","text":"protocol"},{"text":" ","kind":"text"},{"text":"WebAuth","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/useHTTPS()":{"kind":"symbol","title":"useHTTPS()","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"useHTTPS"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","text":"Self"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/useHTTPS()","required":true,"abstract":[{"type":"text","text":"Use "},{"type":"codeVoice","code":"https"},{"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."}],"url":"\/documentation\/auth0\/webauth\/usehttps()"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webauthentication.json b/docs/data/documentation/auth0/webauthentication.json index fab518773..a513f3756 100644 --- a/docs/data/documentation/auth0/webauthentication.json +++ b/docs/data/documentation/auth0/webauthentication.json @@ -1 +1 @@ -{"kind":"symbol","abstract":[{"type":"text","text":"Utility methods needed when using a custom Web Auth provider."}],"topicSections":[{"generated":true,"anchor":"Type-Methods","title":"Type Methods","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication\/cancel()","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication\/resume(with:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication\/safariProvider(style:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication\/webViewProvider(style:)"]}],"seeAlsoSections":[{"anchor":"Related-Documentation","title":"Related Documentation","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/provider(_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication","interfaceLanguage":"swift"},"sections":[],"metadata":{"title":"WebAuthentication","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"WebAuthentication"}],"externalID":"s:5Auth017WebAuthenticationV","symbolKind":"struct","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthentication"}],"roleHeading":"Structure","modules":[{"name":"Auth0"}]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauthentication"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"WebAuthentication","kind":"identifier"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent":{"title":"WebAuthUserAgent","url":"\/documentation\/auth0\/webauthuseragent","navigatorTitle":[{"kind":"identifier","text":"WebAuthUserAgent"}],"abstract":[{"type":"text","text":"The external user agent used to perform a web-based operation."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","kind":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthUserAgent"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthentication/webViewProvider(style:)":{"fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"webViewProvider"},{"kind":"text","text":"("},{"kind":"externalParam","text":"style"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"UIModalPresentationStyle","preciseIdentifier":"c:@E@UIModalPresentationStyle"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"WebAuthProvider","preciseIdentifier":"s:5Auth015WebAuthProvidera"}],"abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication\/webViewProvider(style:)","title":"webViewProvider(style:)","type":"topic","url":"\/documentation\/auth0\/webauthentication\/webviewprovider(style:)","kind":"symbol","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthentication/resume(with:)":{"title":"resume(with:)","role":"symbol","url":"\/documentation\/auth0\/webauthentication\/resume(with:)","kind":"symbol","type":"topic","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"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication\/resume(with:)","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"resume","kind":"identifier"},{"text":"(","kind":"text"},{"text":"with","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation3URLV","text":"URL","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthentication/cancel()":{"role":"symbol","url":"\/documentation\/auth0\/webauthentication\/cancel()","type":"topic","abstract":[{"type":"text","text":"Terminates the ongoing web-based operation and reports back that it was cancelled."},{"type":"text","text":" "},{"type":"text","text":"You need to call this method within your custom Web Auth provider implementation whenever the operation is"},{"type":"text","text":" "},{"type":"text","text":"cancelled by the user."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication\/cancel()","kind":"symbol","title":"cancel()","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cancel","kind":"identifier"},{"text":"()","kind":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthentication":{"title":"WebAuthentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication","role":"symbol","abstract":[{"text":"Utility methods needed when using a custom Web Auth provider.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthentication"}],"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/webauthentication","navigatorTitle":[{"kind":"identifier","text":"WebAuthentication"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthentication/safariProvider(style:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication\/safariProvider(style:)","type":"topic","role":"symbol","kind":"symbol","url":"\/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."}],"title":"safariProvider(style:)","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"safariProvider"},{"kind":"text","text":"("},{"kind":"externalParam","text":"style"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"UIModalPresentationStyle","preciseIdentifier":"c:@E@UIModalPresentationStyle"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"WebAuthProvider","preciseIdentifier":"s:5Auth015WebAuthProvidera"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/provider(_:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/provider(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"provider"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"WebAuthProvider","preciseIdentifier":"s:5Auth015WebAuthProvidera"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Self"}],"kind":"symbol","required":true,"type":"topic","abstract":[{"text":"Specify a custom Web Auth provider to use instead of the default ","type":"text"},{"type":"codeVoice","code":"ASWebAuthenticationSession"},{"text":" implementation.","type":"text"}],"url":"\/documentation\/auth0\/webauth\/provider(_:)","title":"provider(_:)","role":"symbol"}}} \ No newline at end of file +{"abstract":[{"text":"Utility methods needed when using a custom Web Auth provider.","type":"text"}],"seeAlsoSections":[{"anchor":"Related-Documentation","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/provider(_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent"],"title":"Related Documentation"}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthentication"}],"platforms":["iOS"]}],"kind":"declarations"}],"variants":[{"paths":["\/documentation\/auth0\/webauthentication"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"topicSections":[{"generated":true,"anchor":"Type-Methods","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication\/cancel()","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication\/resume(with:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication\/safariProvider(style:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication\/webViewProvider(style:)"],"title":"Type Methods"}],"metadata":{"navigatorTitle":[{"kind":"identifier","text":"WebAuthentication"}],"modules":[{"name":"Auth0"}],"symbolKind":"struct","roleHeading":"Structure","title":"WebAuthentication","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthentication"}],"externalID":"s:5Auth017WebAuthenticationV"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent":{"kind":"symbol","abstract":[{"type":"text","text":"The external user agent used to perform a web-based operation."}],"type":"topic","url":"\/documentation\/auth0\/webauthuseragent","title":"WebAuthUserAgent","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthUserAgent"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","navigatorTitle":[{"kind":"identifier","text":"WebAuthUserAgent"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuth/provider(_:)":{"url":"\/documentation\/auth0\/webauth\/provider(_:)","abstract":[{"text":"Specify a custom Web Auth provider to use instead of the default ","type":"text"},{"code":"ASWebAuthenticationSession","type":"codeVoice"},{"text":" implementation.","type":"text"}],"title":"provider(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"provider"},{"kind":"text","text":"("},{"text":"WebAuthProvider","preciseIdentifier":"s:5Auth015WebAuthProvidera","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Self","kind":"typeIdentifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuth\/provider(_:)","required":true,"kind":"symbol","role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthentication/webViewProvider(style:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication\/webViewProvider(style:)","kind":"symbol","title":"webViewProvider(style:)","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"webViewProvider","kind":"identifier"},{"text":"(","kind":"text"},{"text":"style","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:@E@UIModalPresentationStyle","text":"UIModalPresentationStyle","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"WebAuthProvider","preciseIdentifier":"s:5Auth015WebAuthProvidera","kind":"typeIdentifier"}],"role":"symbol","url":"\/documentation\/auth0\/webauthentication\/webviewprovider(style:)","abstract":[],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthentication/resume(with:)":{"type":"topic","title":"resume(with:)","url":"\/documentation\/auth0\/webauthentication\/resume(with:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication\/resume(with:)","abstract":[{"type":"text","text":"Resumes the web-based operation when the external user agent redirects back to the app using a URL with a"},{"type":"text","text":" "},{"type":"text","text":"custom scheme."}],"role":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"resume"},{"kind":"text","text":"("},{"kind":"externalParam","text":"with"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"URL","preciseIdentifier":"s:10Foundation3URLV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthentication":{"title":"WebAuthentication","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthentication"}],"abstract":[{"text":"Utility methods needed when using a custom Web Auth provider.","type":"text"}],"url":"\/documentation\/auth0\/webauthentication","navigatorTitle":[{"kind":"identifier","text":"WebAuthentication"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthentication/cancel()":{"kind":"symbol","title":"cancel()","role":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"cancel"},{"kind":"text","text":"()"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication\/cancel()","abstract":[{"text":"Terminates the ongoing web-based operation and reports back that it was cancelled.","type":"text"},{"text":" ","type":"text"},{"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"}],"url":"\/documentation\/auth0\/webauthentication\/cancel()"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthentication/safariProvider(style:)":{"url":"\/documentation\/auth0\/webauthentication\/safariprovider(style:)","title":"safariProvider(style:)","abstract":[{"type":"text","text":"Creates a Web Auth provider that uses "},{"code":"SFSafariViewController","type":"codeVoice"},{"type":"text","text":" as the external user agent."}],"fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"safariProvider"},{"kind":"text","text":"("},{"kind":"externalParam","text":"style"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:@E@UIModalPresentationStyle","text":"UIModalPresentationStyle"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015WebAuthProvidera","text":"WebAuthProvider"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication\/safariProvider(style:)","role":"symbol","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 5a696b6d3..d5645b9a7 100644 --- a/docs/data/documentation/auth0/webauthentication/cancel().json +++ b/docs/data/documentation/auth0/webauthentication/cancel().json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication\/cancel()"},"schemaVersion":{"patch":0,"minor":3,"major":0},"abstract":[{"type":"text","text":"Terminates the ongoing web-based operation and reports back that it was cancelled."},{"type":"text","text":" "},{"type":"text","text":"You need to call this method within your custom Web Auth provider implementation whenever the operation is"},{"type":"text","text":" "},{"type":"text","text":"cancelled by the user."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauthentication\/cancel()"]}],"kind":"symbol","metadata":{"externalID":"s:5Auth017WebAuthenticationV6cancelyyFZ","roleHeading":"Type Method","modules":[{"name":"Auth0"}],"role":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"cancel"},{"kind":"text","text":"()"}],"symbolKind":"method","title":"cancel()"},"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"cancel"},{"kind":"text","text":"()"}]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthentication":{"title":"WebAuthentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication","role":"symbol","abstract":[{"text":"Utility methods needed when using a custom Web Auth provider.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthentication"}],"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/webauthentication","navigatorTitle":[{"kind":"identifier","text":"WebAuthentication"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthentication/cancel()":{"role":"symbol","url":"\/documentation\/auth0\/webauthentication\/cancel()","type":"topic","abstract":[{"type":"text","text":"Terminates the ongoing web-based operation and reports back that it was cancelled."},{"type":"text","text":" "},{"type":"text","text":"You need to call this method within your custom Web Auth provider implementation whenever the operation is"},{"type":"text","text":" "},{"type":"text","text":"cancelled by the user."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication\/cancel()","kind":"symbol","title":"cancel()","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cancel","kind":"identifier"},{"text":"()","kind":"text"}]}}} \ No newline at end of file +{"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"cancel"},{"kind":"text","text":"()"}],"languages":["swift"],"platforms":["iOS"]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauthentication\/cancel()"]}],"sections":[],"schemaVersion":{"minor":3,"patch":0,"major":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication\/cancel()"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication"]]},"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"}],"metadata":{"roleHeading":"Type Method","symbolKind":"method","role":"symbol","title":"cancel()","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"cancel"},{"kind":"text","text":"()"}],"externalID":"s:5Auth017WebAuthenticationV6cancelyyFZ","modules":[{"name":"Auth0"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthentication/cancel()":{"kind":"symbol","title":"cancel()","role":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"cancel"},{"kind":"text","text":"()"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication\/cancel()","abstract":[{"text":"Terminates the ongoing web-based operation and reports back that it was cancelled.","type":"text"},{"text":" ","type":"text"},{"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"}],"url":"\/documentation\/auth0\/webauthentication\/cancel()"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthentication":{"title":"WebAuthentication","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthentication"}],"abstract":[{"text":"Utility methods needed when using a custom Web Auth provider.","type":"text"}],"url":"\/documentation\/auth0\/webauthentication","navigatorTitle":[{"kind":"identifier","text":"WebAuthentication"}]}}} \ 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 187a964c0..40a5a3d41 100644 --- a/docs/data/documentation/auth0/webauthentication/resume(with:).json +++ b/docs/data/documentation/auth0/webauthentication/resume(with:).json @@ -1 +1 @@ -{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauthentication\/resume(with:)"]}],"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication"]]},"kind":"symbol","schemaVersion":{"major":0,"patch":0,"minor":3},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication\/resume(with:)","interfaceLanguage":"swift"},"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."}],"primaryContentSections":[{"declarations":[{"tokens":[{"text":"@discardableResult","kind":"attribute"},{"text":" ","kind":"text"},{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"resume","kind":"identifier"},{"text":"(","kind":"text"},{"text":"with","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"url","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"URL","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"},{"parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The URL sent by the external user agent that contains the result of the web-based operation."}]}],"name":"url"}],"kind":"parameters"},{"content":[{"anchor":"return-value","type":"heading","text":"Return Value","level":2},{"type":"paragraph","inlineContent":[{"text":"If the URL was expected and properly formatted.","type":"text"}]}],"kind":"content"},{"content":[{"text":"Usage","anchor":"Usage","type":"heading","level":2},{"text":"For UIKit app lifecycle","anchor":"For-UIKit-app-lifecycle","type":"heading","level":3},{"inlineContent":[{"text":"In your ","type":"text"},{"code":"AppDelegate.swift","type":"codeVoice"},{"text":":","type":"text"}],"type":"paragraph"},{"syntax":"swift","code":["func application(_ app: UIApplication,"," open url: URL,"," options: [UIApplication.OpenURLOptionsKey: Any]) -> Bool {"," return WebAuthentication.resume(with: url)","}"],"type":"codeListing"},{"text":"For UIKit app lifecycle with Scenes","anchor":"For-UIKit-app-lifecycle-with-Scenes","type":"heading","level":3},{"inlineContent":[{"type":"text","text":"In your "},{"code":"SceneDelegate.swift","type":"codeVoice"},{"type":"text","text":":"}],"type":"paragraph"},{"syntax":"swift","code":["func scene(_ scene: UIScene, openURLContexts URLContexts: Set) {"," guard let url = URLContexts.first?.url else { return }"," WebAuthentication.resume(with: url)","}"],"type":"codeListing"},{"text":"For SwiftUI app lifecycle","anchor":"For-SwiftUI-app-lifecycle","type":"heading","level":3},{"syntax":"swift","code":["SomeView()"," .onOpenURL { url in"," WebAuthentication.resume(with: url)"," }"],"type":"codeListing"}],"kind":"content"}],"metadata":{"symbolKind":"method","roleHeading":"Type Method","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"resume","kind":"identifier"},{"text":"(","kind":"text"},{"text":"with","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"URL","preciseIdentifier":"s:10Foundation3URLV","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"title":"resume(with:)","modules":[{"name":"Auth0"}],"role":"symbol","externalID":"s:5Auth017WebAuthenticationV6resume4withSb10Foundation3URLV_tFZ"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthentication":{"title":"WebAuthentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication","role":"symbol","abstract":[{"text":"Utility methods needed when using a custom Web Auth provider.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthentication"}],"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/webauthentication","navigatorTitle":[{"kind":"identifier","text":"WebAuthentication"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthentication/resume(with:)":{"title":"resume(with:)","role":"symbol","url":"\/documentation\/auth0\/webauthentication\/resume(with:)","kind":"symbol","type":"topic","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"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication\/resume(with:)","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"resume","kind":"identifier"},{"text":"(","kind":"text"},{"text":"with","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation3URLV","text":"URL","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}]}}} \ No newline at end of file +{"metadata":{"symbolKind":"method","title":"resume(with:)","roleHeading":"Type Method","externalID":"s:5Auth017WebAuthenticationV6resume4withSb10Foundation3URLV_tFZ","modules":[{"name":"Auth0"}],"fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"resume","kind":"identifier"},{"text":"(","kind":"text"},{"text":"with","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation3URLV","text":"URL","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"role":"symbol"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauthentication\/resume(with:)"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication\/resume(with:)","interfaceLanguage":"swift"},"kind":"symbol","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."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"@discardableResult","kind":"attribute"},{"text":" ","kind":"text"},{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"resume","kind":"identifier"},{"text":"(","kind":"text"},{"text":"with","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"url","kind":"internalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation3URLV","text":"URL","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}]}]},{"kind":"parameters","parameters":[{"name":"url","content":[{"type":"paragraph","inlineContent":[{"text":"The URL sent by the external user agent that contains the result of the web-based operation.","type":"text"}]}]}]},{"content":[{"anchor":"return-value","type":"heading","level":2,"text":"Return Value"},{"inlineContent":[{"type":"text","text":"If the URL was expected and properly formatted."}],"type":"paragraph"}],"kind":"content"},{"content":[{"anchor":"Usage","type":"heading","level":2,"text":"Usage"},{"anchor":"For-UIKit-app-lifecycle","type":"heading","level":3,"text":"For UIKit app lifecycle"},{"inlineContent":[{"type":"text","text":"In your "},{"type":"codeVoice","code":"AppDelegate.swift"},{"type":"text","text":":"}],"type":"paragraph"},{"type":"codeListing","code":["func application(_ app: UIApplication,"," open url: URL,"," options: [UIApplication.OpenURLOptionsKey: Any]) -> Bool {"," return WebAuthentication.resume(with: url)","}"],"syntax":"swift"},{"anchor":"For-UIKit-app-lifecycle-with-Scenes","type":"heading","level":3,"text":"For UIKit app lifecycle with Scenes"},{"inlineContent":[{"type":"text","text":"In your "},{"type":"codeVoice","code":"SceneDelegate.swift"},{"type":"text","text":":"}],"type":"paragraph"},{"type":"codeListing","code":["func scene(_ scene: UIScene, openURLContexts URLContexts: Set) {"," guard let url = URLContexts.first?.url else { return }"," WebAuthentication.resume(with: url)","}"],"syntax":"swift"},{"anchor":"For-SwiftUI-app-lifecycle","type":"heading","level":3,"text":"For SwiftUI app lifecycle"},{"type":"codeListing","code":["SomeView()"," .onOpenURL { url in"," WebAuthentication.resume(with: url)"," }"],"syntax":"swift"}],"kind":"content"}],"schemaVersion":{"patch":0,"minor":3,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthentication":{"title":"WebAuthentication","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthentication"}],"abstract":[{"text":"Utility methods needed when using a custom Web Auth provider.","type":"text"}],"url":"\/documentation\/auth0\/webauthentication","navigatorTitle":[{"kind":"identifier","text":"WebAuthentication"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthentication/resume(with:)":{"type":"topic","title":"resume(with:)","url":"\/documentation\/auth0\/webauthentication\/resume(with:)","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication\/resume(with:)","abstract":[{"type":"text","text":"Resumes the web-based operation when the external user agent redirects back to the app using a URL with a"},{"type":"text","text":" "},{"type":"text","text":"custom scheme."}],"role":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"resume"},{"kind":"text","text":"("},{"kind":"externalParam","text":"with"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"URL","preciseIdentifier":"s:10Foundation3URLV"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ 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 c5bd40903..83ebd8318 100644 --- a/docs/data/documentation/auth0/webauthentication/safariprovider(style:).json +++ b/docs/data/documentation/auth0/webauthentication/safariprovider(style:).json @@ -1 +1 @@ -{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication\/safariProvider(style:)"},"sections":[],"schemaVersion":{"patch":0,"major":0,"minor":3},"metadata":{"symbolKind":"method","role":"symbol","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"safariProvider"},{"kind":"text","text":"("},{"kind":"externalParam","text":"style"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:@E@UIModalPresentationStyle","text":"UIModalPresentationStyle"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015WebAuthProvidera","text":"WebAuthProvider"}],"title":"safariProvider(style:)","externalID":"s:5Auth017WebAuthenticationV14safariProvider5styleAA0B13AuthUserAgent_p10Foundation3URLV_ys6ResultOyytAA0bG5ErrorVGctcSo24UIModalPresentationStyleV_tFZ","roleHeading":"Type Method","extendedModule":"Auth0"},"abstract":[{"type":"text","text":"Creates a Web Auth provider that uses "},{"type":"codeVoice","code":"SFSafariViewController"},{"type":"text","text":" as the external user agent."}],"seeAlsoSections":[{"anchor":"Related-Documentation","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserAgents"],"title":"Related Documentation"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication"]]},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"safariProvider","kind":"identifier"},{"text":"(","kind":"text"},{"text":"style","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"UIModalPresentationStyle","kind":"typeIdentifier","preciseIdentifier":"c:@E@UIModalPresentationStyle"},{"text":" = .fullScreen) -> ","kind":"text"},{"text":"WebAuthProvider","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProvider","kind":"typeIdentifier","preciseIdentifier":"s:5Auth015WebAuthProvidera"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"},{"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":"parameters"},{"content":[{"type":"heading","level":2,"text":"Return Value","anchor":"return-value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProvider","isActive":true},{"type":"text","text":" instance."}]}],"kind":"content"},{"content":[{"anchor":"Usage","level":2,"type":"heading","text":"Usage"},{"syntax":"swift","code":["Auth0"," .webAuth()"," .provider(WebAuthentication.safariProvider())"," .start { result in"," \/\/ ...","}"],"type":"codeListing"},{"inlineContent":[{"text":"If you need to specify a custom ","type":"text"},{"code":"UIModalPresentationStyle","type":"codeVoice"},{"text":":","type":"text"}],"type":"paragraph"},{"syntax":"swift","code":["Auth0"," .webAuth()"," .provider(WebAuthentication.safariProvider(style: .formSheet))"," .start { result in"," \/\/ ...","}"],"type":"codeListing"},{"style":"important","type":"aside","name":"Important","content":[{"inlineContent":[{"text":"Unlike ","type":"text"},{"type":"codeVoice","code":"ASWebAuthenticationSession"},{"text":", ","type":"text"},{"code":"SFSafariViewController","type":"codeVoice"},{"text":" will not automatically capture the","type":"text"},{"text":" ","type":"text"},{"text":"callback URL when Auth0 redirects back to your app, so it is necessary to manually resume the Web Auth operation.","type":"text"},{"text":" ","type":"text"},{"text":"See ","type":"text"},{"identifier":"https:\/\/github.com\/auth0\/Auth0.swift\/blob\/master\/EXAMPLES.md#use-sfsafariviewcontroller-instead-of-aswebauthenticationsession","isActive":true,"type":"reference"},{"text":" ","type":"text"},{"type":"text","text":"for the complete setup instructions."}],"type":"paragraph"}]},{"style":"note","type":"aside","name":"Note","content":[{"inlineContent":[{"text":"","type":"text"},{"code":"SFSafariViewController","type":"codeVoice"},{"text":" does not support using Universal Links as callback URLs.","type":"text"}],"type":"paragraph"}]}],"kind":"content"}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauthentication\/safariprovider(style:)"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthentication/safariProvider(style:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication\/safariProvider(style:)","type":"topic","role":"symbol","kind":"symbol","url":"\/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."}],"title":"safariProvider(style:)","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"safariProvider"},{"kind":"text","text":"("},{"kind":"externalParam","text":"style"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"UIModalPresentationStyle","preciseIdentifier":"c:@E@UIModalPresentationStyle"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"WebAuthProvider","preciseIdentifier":"s:5Auth015WebAuthProvidera"}]},"doc://com.auth0.Auth0/documentation/Auth0/UserAgents":{"title":"ASWebAuthenticationSession vs SFSafariViewController (iOS)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserAgents","abstract":[],"kind":"article","type":"topic","role":"article","url":"\/documentation\/auth0\/useragents"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent":{"title":"WebAuthUserAgent","url":"\/documentation\/auth0\/webauthuseragent","navigatorTitle":[{"kind":"identifier","text":"WebAuthUserAgent"}],"abstract":[{"type":"text","text":"The external user agent used to perform a web-based operation."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","kind":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthUserAgent"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthProvider":{"type":"topic","navigatorTitle":[{"kind":"identifier","text":"WebAuthProvider"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProvider","kind":"symbol","title":"WebAuthProvider","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"},{"text":" to perform a web-based operation.","type":"text"},{"text":" ","type":"text"},{"text":"The ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","isActive":true,"type":"reference"},{"text":" opens the URL in an external user agent and then invokes the callback when done.","type":"text"}],"fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthProvider"}],"url":"\/documentation\/auth0\/webauthprovider"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthentication":{"title":"WebAuthentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication","role":"symbol","abstract":[{"text":"Utility methods needed when using a custom Web Auth provider.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthentication"}],"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/webauthentication","navigatorTitle":[{"kind":"identifier","text":"WebAuthentication"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"https://github.com/auth0/Auth0.swift/blob/master/EXAMPLES.md#use-sfsafariviewcontroller-instead-of-aswebauthenticationsession":{"titleInlineContent":[{"type":"text","text":"Use "},{"code":"SFSafariViewController","type":"codeVoice"},{"type":"text","text":" instead of "},{"code":"ASWebAuthenticationSession","type":"codeVoice"}],"identifier":"https:\/\/github.com\/auth0\/Auth0.swift\/blob\/master\/EXAMPLES.md#use-sfsafariviewcontroller-instead-of-aswebauthenticationsession","url":"https:\/\/github.com\/auth0\/Auth0.swift\/blob\/master\/EXAMPLES.md#use-sfsafariviewcontroller-instead-of-aswebauthenticationsession","title":"Use SFSafariViewController instead of ASWebAuthenticationSession","type":"link"}}} \ No newline at end of file +{"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication\/safariProvider(style:)","interfaceLanguage":"swift"},"kind":"symbol","metadata":{"externalID":"s:5Auth017WebAuthenticationV14safariProvider5styleAA0B13AuthUserAgent_p10Foundation3URLV_ys6ResultOyytAA0bG5ErrorVGctcSo24UIModalPresentationStyleV_tFZ","modules":[{"name":"Auth0"}],"title":"safariProvider(style:)","extendedModule":"Auth0","roleHeading":"Type Method","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"safariProvider","kind":"identifier"},{"text":"(","kind":"text"},{"text":"style","kind":"externalParam"},{"kind":"text","text":": "},{"text":"UIModalPresentationStyle","kind":"typeIdentifier","preciseIdentifier":"c:@E@UIModalPresentationStyle"},{"kind":"text","text":") -> "},{"text":"WebAuthProvider","kind":"typeIdentifier","preciseIdentifier":"s:5Auth015WebAuthProvidera"}],"role":"symbol","symbolKind":"method"},"seeAlsoSections":[{"title":"Related Documentation","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserAgents"],"anchor":"Related-Documentation"}],"variants":[{"paths":["\/documentation\/auth0\/webauthentication\/safariprovider(style:)"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication"]]},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"safariProvider"},{"kind":"text","text":"("},{"kind":"externalParam","text":"style"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:@E@UIModalPresentationStyle","text":"UIModalPresentationStyle"},{"kind":"text","text":" = .fullScreen) -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015WebAuthProvidera","text":"WebAuthProvider","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProvider"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"type":"text","text":""},{"code":"UIModalPresentationStyle","type":"codeVoice"},{"type":"text","text":" to be used. Defaults to "},{"code":".fullScreen","type":"codeVoice"},{"type":"text","text":"."}],"type":"paragraph"}],"name":"style"}]},{"content":[{"type":"heading","level":2,"text":"Return Value","anchor":"return-value"},{"inlineContent":[{"text":"A ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProvider","type":"reference","isActive":true},{"text":" instance.","type":"text"}],"type":"paragraph"}],"kind":"content"},{"content":[{"level":2,"type":"heading","anchor":"Usage","text":"Usage"},{"code":["Auth0"," .webAuth()"," .provider(WebAuthentication.safariProvider())"," .start { result in"," \/\/ ...","}"],"syntax":"swift","type":"codeListing"},{"inlineContent":[{"type":"text","text":"If you need to specify a custom "},{"type":"codeVoice","code":"UIModalPresentationStyle"},{"type":"text","text":":"}],"type":"paragraph"},{"code":["Auth0"," .webAuth()"," .provider(WebAuthentication.safariProvider(style: .formSheet))"," .start { result in"," \/\/ ...","}"],"type":"codeListing","syntax":"swift"},{"content":[{"inlineContent":[{"type":"text","text":"Unlike "},{"type":"codeVoice","code":"ASWebAuthenticationSession"},{"type":"text","text":", "},{"type":"codeVoice","code":"SFSafariViewController"},{"type":"text","text":" will not automatically capture the"},{"type":"text","text":" "},{"type":"text","text":"callback URL when Auth0 redirects back to your app, so it is necessary to manually resume the Web Auth operation."},{"type":"text","text":" "},{"type":"text","text":"See "},{"isActive":true,"type":"reference","identifier":"https:\/\/github.com\/auth0\/Auth0.swift\/blob\/master\/EXAMPLES.md#use-sfsafariviewcontroller-instead-of-aswebauthenticationsession"},{"type":"text","text":" "},{"type":"text","text":"for the complete setup instructions."}],"type":"paragraph"}],"type":"aside","name":"Important","style":"important"},{"style":"note","content":[{"inlineContent":[{"type":"text","text":""},{"type":"codeVoice","code":"SFSafariViewController"},{"type":"text","text":" does not support using Universal Links as callback URLs."}],"type":"paragraph"}],"type":"aside","name":"Note"}],"kind":"content"}],"abstract":[{"type":"text","text":"Creates a Web Auth provider that uses "},{"code":"SFSafariViewController","type":"codeVoice"},{"type":"text","text":" as the external user agent."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthentication":{"title":"WebAuthentication","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthentication"}],"abstract":[{"text":"Utility methods needed when using a custom Web Auth provider.","type":"text"}],"url":"\/documentation\/auth0\/webauthentication","navigatorTitle":[{"kind":"identifier","text":"WebAuthentication"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent":{"kind":"symbol","abstract":[{"type":"text","text":"The external user agent used to perform a web-based operation."}],"type":"topic","url":"\/documentation\/auth0\/webauthuseragent","title":"WebAuthUserAgent","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthUserAgent"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","navigatorTitle":[{"kind":"identifier","text":"WebAuthUserAgent"}]},"https://github.com/auth0/Auth0.swift/blob/master/EXAMPLES.md#use-sfsafariviewcontroller-instead-of-aswebauthenticationsession":{"title":"Use SFSafariViewController instead of ASWebAuthenticationSession","type":"link","titleInlineContent":[{"type":"text","text":"Use "},{"code":"SFSafariViewController","type":"codeVoice"},{"type":"text","text":" instead of "},{"code":"ASWebAuthenticationSession","type":"codeVoice"}],"identifier":"https:\/\/github.com\/auth0\/Auth0.swift\/blob\/master\/EXAMPLES.md#use-sfsafariviewcontroller-instead-of-aswebauthenticationsession","url":"https:\/\/github.com\/auth0\/Auth0.swift\/blob\/master\/EXAMPLES.md#use-sfsafariviewcontroller-instead-of-aswebauthenticationsession"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthProvider":{"role":"symbol","title":"WebAuthProvider","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthProvider"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuthProvider"}],"abstract":[{"type":"text","text":"Thunk that returns a function that creates and returns a "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","isActive":true,"type":"reference"},{"text":" to perform a web-based operation.","type":"text"},{"type":"text","text":" "},{"type":"text","text":"The "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","isActive":true},{"text":" opens the URL in an external user agent and then invokes the callback when done.","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/webauthprovider","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProvider","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthentication/safariProvider(style:)":{"url":"\/documentation\/auth0\/webauthentication\/safariprovider(style:)","title":"safariProvider(style:)","abstract":[{"type":"text","text":"Creates a Web Auth provider that uses "},{"code":"SFSafariViewController","type":"codeVoice"},{"type":"text","text":" as the external user agent."}],"fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"safariProvider"},{"kind":"text","text":"("},{"kind":"externalParam","text":"style"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"c:@E@UIModalPresentationStyle","text":"UIModalPresentationStyle"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth015WebAuthProvidera","text":"WebAuthProvider"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication\/safariProvider(style:)","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/UserAgents":{"title":"ASWebAuthenticationSession vs SFSafariViewController (iOS)","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/UserAgents","role":"article","kind":"article","abstract":[],"url":"\/documentation\/auth0\/useragents"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webauthentication/webviewprovider(style:).json b/docs/data/documentation/auth0/webauthentication/webviewprovider(style:).json index a26cb34b3..3683b8339 100644 --- a/docs/data/documentation/auth0/webauthentication/webviewprovider(style:).json +++ b/docs/data/documentation/auth0/webauthentication/webviewprovider(style:).json @@ -1 +1 @@ -{"sections":[],"kind":"symbol","primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"webViewProvider","kind":"identifier"},{"text":"(","kind":"text"},{"text":"style","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"UIModalPresentationStyle","kind":"typeIdentifier","preciseIdentifier":"c:@E@UIModalPresentationStyle"},{"text":" = .fullScreen) -> ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProvider","text":"WebAuthProvider","kind":"typeIdentifier","preciseIdentifier":"s:5Auth015WebAuthProvidera"}],"platforms":["iOS"]}],"kind":"declarations"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication\/webViewProvider(style:)"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication"]]},"metadata":{"externalID":"s:5Auth017WebAuthenticationV15webViewProvider5styleAA0B13AuthUserAgent_p10Foundation3URLV_ys6ResultOyytAA0bH5ErrorVGctcSo24UIModalPresentationStyleV_tFZ","modules":[{"name":"Auth0"}],"roleHeading":"Type Method","extendedModule":"Auth0","symbolKind":"method","title":"webViewProvider(style:)","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"webViewProvider","kind":"identifier"},{"text":"(","kind":"text"},{"text":"style","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:@E@UIModalPresentationStyle","text":"UIModalPresentationStyle","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth015WebAuthProvidera","text":"WebAuthProvider","kind":"typeIdentifier"}],"role":"symbol"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauthentication\/webviewprovider(style:)"]}],"schemaVersion":{"major":0,"patch":0,"minor":3},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthentication/webViewProvider(style:)":{"fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"webViewProvider"},{"kind":"text","text":"("},{"kind":"externalParam","text":"style"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"UIModalPresentationStyle","preciseIdentifier":"c:@E@UIModalPresentationStyle"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"WebAuthProvider","preciseIdentifier":"s:5Auth015WebAuthProvidera"}],"abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication\/webViewProvider(style:)","title":"webViewProvider(style:)","type":"topic","url":"\/documentation\/auth0\/webauthentication\/webviewprovider(style:)","kind":"symbol","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthentication":{"title":"WebAuthentication","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication","role":"symbol","abstract":[{"text":"Utility methods needed when using a custom Web Auth provider.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthentication"}],"kind":"symbol","type":"topic","url":"\/documentation\/auth0\/webauthentication","navigatorTitle":[{"kind":"identifier","text":"WebAuthentication"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent":{"title":"WebAuthUserAgent","url":"\/documentation\/auth0\/webauthuseragent","navigatorTitle":[{"kind":"identifier","text":"WebAuthUserAgent"}],"abstract":[{"type":"text","text":"The external user agent used to perform a web-based operation."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","kind":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthUserAgent"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthProvider":{"type":"topic","navigatorTitle":[{"kind":"identifier","text":"WebAuthProvider"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProvider","kind":"symbol","title":"WebAuthProvider","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"},{"text":" to perform a web-based operation.","type":"text"},{"text":" ","type":"text"},{"text":"The ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","isActive":true,"type":"reference"},{"text":" opens the URL in an external user agent and then invokes the callback when done.","type":"text"}],"fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthProvider"}],"url":"\/documentation\/auth0\/webauthprovider"}}} \ No newline at end of file +{"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"webViewProvider","kind":"identifier"},{"text":"(","kind":"text"},{"text":"style","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"UIModalPresentationStyle","preciseIdentifier":"c:@E@UIModalPresentationStyle","kind":"typeIdentifier"},{"text":" = .fullScreen) -> ","kind":"text"},{"text":"WebAuthProvider","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProvider","kind":"typeIdentifier","preciseIdentifier":"s:5Auth015WebAuthProvidera"}],"platforms":["iOS"]}],"kind":"declarations"}],"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauthentication\/webviewprovider(style:)"]}],"kind":"symbol","identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication\/webViewProvider(style:)","interfaceLanguage":"swift"},"metadata":{"roleHeading":"Type Method","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"webViewProvider"},{"kind":"text","text":"("},{"kind":"externalParam","text":"style"},{"kind":"text","text":": "},{"text":"UIModalPresentationStyle","preciseIdentifier":"c:@E@UIModalPresentationStyle","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"WebAuthProvider","preciseIdentifier":"s:5Auth015WebAuthProvidera","kind":"typeIdentifier"}],"title":"webViewProvider(style:)","role":"symbol","modules":[{"name":"Auth0"}],"externalID":"s:5Auth017WebAuthenticationV15webViewProvider5styleAA0B13AuthUserAgent_p10Foundation3URLV_ys6ResultOyytAA0bH5ErrorVGctcSo24UIModalPresentationStyleV_tFZ","extendedModule":"Auth0","symbolKind":"method"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthProvider":{"role":"symbol","title":"WebAuthProvider","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthProvider"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuthProvider"}],"abstract":[{"type":"text","text":"Thunk that returns a function that creates and returns a "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","isActive":true,"type":"reference"},{"text":" to perform a web-based operation.","type":"text"},{"type":"text","text":" "},{"type":"text","text":"The "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","isActive":true},{"text":" opens the URL in an external user agent and then invokes the callback when done.","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/webauthprovider","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProvider","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthentication":{"title":"WebAuthentication","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthentication"}],"abstract":[{"text":"Utility methods needed when using a custom Web Auth provider.","type":"text"}],"url":"\/documentation\/auth0\/webauthentication","navigatorTitle":[{"kind":"identifier","text":"WebAuthentication"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent":{"kind":"symbol","abstract":[{"type":"text","text":"The external user agent used to perform a web-based operation."}],"type":"topic","url":"\/documentation\/auth0\/webauthuseragent","title":"WebAuthUserAgent","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthUserAgent"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","navigatorTitle":[{"kind":"identifier","text":"WebAuthUserAgent"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthentication/webViewProvider(style:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthentication\/webViewProvider(style:)","kind":"symbol","title":"webViewProvider(style:)","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"webViewProvider","kind":"identifier"},{"text":"(","kind":"text"},{"text":"style","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"c:@E@UIModalPresentationStyle","text":"UIModalPresentationStyle","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"WebAuthProvider","preciseIdentifier":"s:5Auth015WebAuthProvidera","kind":"typeIdentifier"}],"role":"symbol","url":"\/documentation\/auth0\/webauthentication\/webviewprovider(style:)","abstract":[],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"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 54bfa03c4..9272eaab6 100644 --- a/docs/data/documentation/auth0/webautherror.json +++ b/docs/data/documentation/auth0/webautherror.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"relationshipsSections":[{"kind":"relationships","title":"Conforms To","type":"conformsTo","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","doc:\/\/com.auth0.Auth0\/10Foundation14LocalizedErrorP","doc:\/\/com.auth0.Auth0\/s8CopyableP","doc:\/\/com.auth0.Auth0\/s28CustomDebugStringConvertibleP","doc:\/\/com.auth0.Auth0\/SQ","doc:\/\/com.auth0.Auth0\/s5ErrorP","doc:\/\/com.auth0.Auth0\/s8SendableP","doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP"]}],"abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthError"}]}],"kind":"declarations"}],"schemaVersion":{"major":0,"patch":0,"minor":3},"variants":[{"paths":["\/documentation\/auth0\/webautherror"],"traits":[{"interfaceLanguage":"swift"}]}],"topicSections":[{"anchor":"Operators","title":"Operators","generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/~=(_:_:)-3690","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/~=(_:_:)-6ibkd"]},{"anchor":"Instance-Properties","title":"Instance Properties","generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/cause","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/debugDescription"]},{"anchor":"Type-Properties","title":"Type Properties","generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/idTokenValidationFailed","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/invalidInvitationURL","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/noAuthorizationCode","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/noBundleIdentifier","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/other","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/pkceNotAllowed","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/transactionActiveAlready","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/unknown","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/userCancelled"]},{"anchor":"Default-Implementations","title":"Default Implementations","generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/Auth0Error-Implementations","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/Equatable-Implementations","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/LocalizedError-Implementations"]}],"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","interfaceLanguage":"swift"},"metadata":{"externalID":"s:5Auth012WebAuthErrorV","roleHeading":"Structure","symbolKind":"struct","navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"role":"symbol","title":"WebAuthError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthError"}],"modules":[{"name":"Auth0"}]},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/invalidInvitationURL":{"url":"\/documentation\/auth0\/webautherror\/invalidinvitationurl","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"invalidInvitationURL"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV"}],"type":"topic","title":"invalidInvitationURL","abstract":[{"text":"The invitation URL is missing the ","type":"text"},{"code":"invitation","type":"codeVoice"},{"text":" and\/or the ","type":"text"},{"code":"organization","type":"codeVoice"},{"text":" query parameters.","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"},{"text":".","type":"text"}],"kind":"symbol","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/invalidInvitationURL"},"doc://com.auth0.Auth0/10Foundation14LocalizedErrorP":{"title":"Foundation.LocalizedError","identifier":"doc:\/\/com.auth0.Auth0\/10Foundation14LocalizedErrorP","type":"unresolvable"},"doc://com.auth0.Auth0/s28CustomDebugStringConvertibleP":{"title":"Swift.CustomDebugStringConvertible","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s28CustomDebugStringConvertibleP"},"doc://com.auth0.Auth0/s8CopyableP":{"title":"Swift.Copyable","identifier":"doc:\/\/com.auth0.Auth0\/s8CopyableP","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/other":{"url":"\/documentation\/auth0\/webautherror\/other","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/other","kind":"symbol","title":"other","role":"symbol","abstract":[{"type":"text","text":"An unexpected error occurred, and an "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value is available."},{"type":"text","text":" "},{"type":"text","text":"The underlying "},{"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"},{"type":"text","text":" property."}],"fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"other","kind":"identifier"},{"text":": ","kind":"text"},{"text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier"}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"title":"cause","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","kind":"symbol","abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":"?"}],"role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/cause":{"kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP","text":"Error"},{"kind":"text","text":"?"}],"type":"topic","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/cause","title":"cause","url":"\/documentation\/auth0\/webautherror\/cause","abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/debugDescription":{"abstract":[{"type":"text","text":"Description of the error."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/debugDescription","role":"symbol","title":"debugDescription","type":"topic","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"debugDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"url":"\/documentation\/auth0\/webautherror\/debugdescription","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/~=(_:_:)-6ibkd":{"url":"\/documentation\/auth0\/webautherror\/~=(_:_:)-6ibkd","role":"symbol","abstract":[{"text":"Matches ","type":"text"},{"code":"Error","type":"codeVoice"},{"text":" values in a switch statement.","type":"text"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/~=(_:_:)-6ibkd","title":"~=(_:_:)","type":"topic","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"~=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"WebAuthError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV"},{"text":", ","kind":"text"},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}]},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error":{"url":"\/documentation\/auth0\/auth0error","title":"Auth0Error","kind":"symbol","type":"topic","abstract":[{"type":"text","text":"Generic representation of Auth0 errors."}],"role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Auth0Error"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","navigatorTitle":[{"kind":"identifier","text":"Auth0Error"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/pkceNotAllowed":{"title":"pkceNotAllowed","type":"topic","url":"\/documentation\/auth0\/webautherror\/pkcenotallowed","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/pkceNotAllowed","role":"symbol","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"pkceNotAllowed","kind":"identifier"},{"text":": ","kind":"text"},{"text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier"}],"abstract":[{"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 ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/manage.auth0.com\/#\/applications\/"},{"text":",","type":"text"},{"text":" ","type":"text"},{"text":"by setting the ","type":"text"},{"inlineContent":[{"type":"text","text":"Application Type"}],"type":"strong"},{"text":" to ‘Native’.","type":"text"},{"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"},{"text":".","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/Auth0Error-Implementations":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/Auth0Error-Implementations","type":"topic","kind":"article","title":"Auth0Error Implementations","url":"\/documentation\/auth0\/webautherror\/auth0error-implementations","role":"collectionGroup","abstract":[]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"abstract":[{"text":"Represents an error during a Web Auth operation.","type":"text"}],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"type":"topic","role":"symbol","navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","title":"WebAuthError","url":"\/documentation\/auth0\/webautherror"},"doc://com.auth0.Auth0/SQ":{"title":"Swift.Equatable","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/SQ"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/~=(_:_:)-3690":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/~=(_:_:)-3690","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"~=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"role":"symbol","url":"\/documentation\/auth0\/webautherror\/~=(_:_:)-3690","abstract":[{"text":"Matches ","type":"text"},{"type":"codeVoice","code":"WebAuthError"},{"text":" values in a switch statement.","type":"text"}],"title":"~=(_:_:)","type":"topic"},"doc://com.auth0.Auth0/s8SendableP":{"title":"Swift.Sendable","identifier":"doc:\/\/com.auth0.Auth0\/s8SendableP","type":"unresolvable"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/s5ErrorP":{"title":"Swift.Error","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s5ErrorP"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/transactionActiveAlready":{"role":"symbol","title":"transactionActiveAlready","url":"\/documentation\/auth0\/webautherror\/transactionactivealready","kind":"symbol","abstract":[{"type":"text","text":"There is already an active transaction at the moment; therefore, this newly initiated transaction is canceled."},{"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},{"type":"text","text":"."}],"fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"transactionActiveAlready","kind":"identifier"},{"text":": ","kind":"text"},{"text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/transactionActiveAlready"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/noAuthorizationCode":{"fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"noAuthorizationCode","kind":"identifier"},{"text":": ","kind":"text"},{"text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/noAuthorizationCode","url":"\/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"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference"},{"text":".","type":"text"}],"type":"topic","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/Equatable-Implementations":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/Equatable-Implementations","type":"topic","kind":"article","title":"Equatable Implementations","url":"\/documentation\/auth0\/webautherror\/equatable-implementations","role":"collectionGroup","abstract":[]},"https://manage.auth0.com/#/applications/":{"title":"Auth0 application","type":"link","identifier":"https:\/\/manage.auth0.com\/#\/applications\/","titleInlineContent":[{"type":"text","text":"Auth0 application"}],"url":"https:\/\/manage.auth0.com\/#\/applications\/"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/userCancelled":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/userCancelled","kind":"symbol","role":"symbol","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","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/webautherror\/usercancelled","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"userCancelled"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"}],"title":"userCancelled","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/LocalizedError-Implementations":{"url":"\/documentation\/auth0\/webautherror\/localizederror-implementations","title":"LocalizedError Implementations","type":"topic","abstract":[],"role":"collectionGroup","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/LocalizedError-Implementations","kind":"article"},"doc://com.auth0.Auth0/s16SendableMetatypeP":{"title":"Swift.SendableMetatype","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/unknown":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/unknown","title":"unknown","abstract":[{"text":"An unexpected error occurred, but an ","type":"text"},{"type":"codeVoice","code":"Error"},{"text":" value is not available.","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"}],"role":"symbol","url":"\/documentation\/auth0\/webautherror\/unknown","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"unknown","kind":"identifier"},{"text":": ","kind":"text"},{"text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/noBundleIdentifier":{"abstract":[{"text":"The bundle identifier could not be retrieved from ","type":"text"},{"code":"Bundle.main.bundleIdentifier","type":"codeVoice"},{"text":", or it could not be used to","type":"text"},{"text":" ","type":"text"},{"text":"build a valid URL.","type":"text"},{"text":" ","type":"text"},{"text":"This error does not include a ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true,"type":"reference"},{"text":".","type":"text"}],"type":"topic","title":"noBundleIdentifier","role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"noBundleIdentifier","kind":"identifier"},{"text":": ","kind":"text"},{"text":"WebAuthError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/noBundleIdentifier","url":"\/documentation\/auth0\/webautherror\/nobundleidentifier"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/idTokenValidationFailed":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/idTokenValidationFailed","kind":"symbol","abstract":[{"type":"text","text":"The ID token validation performed after authentication failed."},{"type":"text","text":" "},{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value can be accessed via the "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true},{"type":"text","text":" property."}],"fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"idTokenValidationFailed","kind":"identifier"},{"text":": ","kind":"text"},{"text":"WebAuthError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV"}],"type":"topic","title":"idTokenValidationFailed","url":"\/documentation\/auth0\/webautherror\/idtokenvalidationfailed"}}} \ No newline at end of file +{"metadata":{"symbolKind":"struct","title":"WebAuthError","roleHeading":"Structure","externalID":"s:5Auth012WebAuthErrorV","modules":[{"name":"Auth0"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"WebAuthError"}]},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webautherror"]}],"relationshipsSections":[{"kind":"relationships","title":"Conforms To","type":"conformsTo","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","doc:\/\/com.auth0.Auth0\/10Foundation14LocalizedErrorP","doc:\/\/com.auth0.Auth0\/s8CopyableP","doc:\/\/com.auth0.Auth0\/s28CustomDebugStringConvertibleP","doc:\/\/com.auth0.Auth0\/SQ","doc:\/\/com.auth0.Auth0\/s5ErrorP","doc:\/\/com.auth0.Auth0\/s8SendableP","doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP"]}],"topicSections":[{"title":"Operators","generated":true,"anchor":"Operators","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/~=(_:_:)-3690","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/~=(_:_:)-6ibkd"]},{"title":"Instance Properties","generated":true,"anchor":"Instance-Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/cause","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/debugDescription","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/message"]},{"title":"Type Properties","generated":true,"anchor":"Type-Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/idTokenValidationFailed","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/invalidInvitationURL","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/noAuthorizationCode","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/noBundleIdentifier","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/other","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/pkceNotAllowed","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/transactionActiveAlready","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/unknown","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/userCancelled"]},{"title":"Default Implementations","generated":true,"anchor":"Default-Implementations","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/Auth0Error-Implementations","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/Equatable-Implementations","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/LocalizedError-Implementations"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"https://manage.auth0.com/#/applications/":{"title":"Auth0 application","type":"link","titleInlineContent":[{"type":"text","text":"Auth0 application"}],"identifier":"https:\/\/manage.auth0.com\/#\/applications\/","url":"https:\/\/manage.auth0.com\/#\/applications\/"},"doc://com.auth0.Auth0/s5ErrorP":{"title":"Swift.Error","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s5ErrorP"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/message":{"type":"topic","title":"message","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/message","kind":"symbol","abstract":[],"url":"\/documentation\/auth0\/webautherror\/message","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"message"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}]},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"kind":"symbol","title":"cause","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier","text":"Error"},{"kind":"text","text":"?"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","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":"."}],"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/invalidInvitationURL":{"type":"topic","title":"invalidInvitationURL","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"},{"type":"text","text":" query parameters."},{"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},{"type":"text","text":"."}],"url":"\/documentation\/auth0\/webautherror\/invalidinvitationurl","role":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"invalidInvitationURL"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/debugDescription":{"type":"topic","title":"debugDescription","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/debugDescription","kind":"symbol","abstract":[{"type":"text","text":"Description of the error."}],"url":"\/documentation\/auth0\/webautherror\/debugdescription","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"debugDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}]},"doc://com.auth0.Auth0/SQ":{"title":"Swift.Equatable","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/SQ"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/~=(_:_:)-6ibkd":{"type":"topic","title":"~=(_:_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/~=(_:_:)-6ibkd","kind":"symbol","abstract":[{"type":"text","text":"Matches "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" values in a switch statement."}],"url":"\/documentation\/auth0\/webautherror\/~=(_:_:)-6ibkd","role":"symbol","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:5Auth012WebAuthErrorV","text":"WebAuthError"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP","text":"Error"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/cause":{"type":"topic","title":"cause","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/cause","kind":"symbol","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":"."}],"url":"\/documentation\/auth0\/webautherror\/cause","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP","text":"Error"},{"kind":"text","text":"?"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/LocalizedError-Implementations":{"type":"topic","title":"LocalizedError Implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/LocalizedError-Implementations","kind":"article","abstract":[],"url":"\/documentation\/auth0\/webautherror\/localizederror-implementations","role":"collectionGroup"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/unknown":{"type":"topic","title":"unknown","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/unknown","kind":"symbol","abstract":[{"type":"text","text":"An unexpected error occurred, but an "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value is not available."},{"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},{"type":"text","text":"."}],"url":"\/documentation\/auth0\/webautherror\/unknown","role":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"unknown"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"}]},"doc://com.auth0.Auth0/s28CustomDebugStringConvertibleP":{"title":"Swift.CustomDebugStringConvertible","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s28CustomDebugStringConvertibleP"},"doc://com.auth0.Auth0/10Foundation14LocalizedErrorP":{"title":"Foundation.LocalizedError","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/10Foundation14LocalizedErrorP"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/Equatable-Implementations":{"type":"topic","title":"Equatable Implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/Equatable-Implementations","kind":"article","abstract":[],"url":"\/documentation\/auth0\/webautherror\/equatable-implementations","role":"collectionGroup"},"doc://com.auth0.Auth0/s16SendableMetatypeP":{"title":"Swift.SendableMetatype","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s16SendableMetatypeP"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/noAuthorizationCode":{"type":"topic","title":"noAuthorizationCode","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/noAuthorizationCode","kind":"symbol","abstract":[{"type":"text","text":"The callback URL is missing the "},{"code":"code","type":"codeVoice"},{"type":"text","text":" query parameter."},{"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},{"type":"text","text":"."}],"url":"\/documentation\/auth0\/webautherror\/noauthorizationcode","role":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"noAuthorizationCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/transactionActiveAlready":{"type":"topic","title":"transactionActiveAlready","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/transactionActiveAlready","kind":"symbol","abstract":[{"type":"text","text":"There is already an active transaction at the moment; therefore, this newly initiated transaction is canceled."},{"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},{"type":"text","text":"."}],"url":"\/documentation\/auth0\/webautherror\/transactionactivealready","role":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"transactionActiveAlready"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/noBundleIdentifier":{"title":"noBundleIdentifier","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/noBundleIdentifier","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"noBundleIdentifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"}],"abstract":[{"type":"text","text":"The bundle identifier could not be retrieved from "},{"code":"Bundle.main.bundleIdentifier","type":"codeVoice"},{"type":"text","text":", or it could not be used to"},{"type":"text","text":" "},{"type":"text","text":"build a valid URL."},{"type":"text","text":" "},{"type":"text","text":"This error does not include a "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference","isActive":true},{"type":"text","text":"."}],"url":"\/documentation\/auth0\/webautherror\/nobundleidentifier"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/other":{"type":"topic","title":"other","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/other","kind":"symbol","abstract":[{"type":"text","text":"An unexpected error occurred, and an "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value is available."},{"type":"text","text":" "},{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value can be accessed via the "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference","isActive":true},{"type":"text","text":" property."}],"url":"\/documentation\/auth0\/webautherror\/other","role":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"other"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"}]},"doc://com.auth0.Auth0/s8CopyableP":{"title":"Swift.Copyable","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s8CopyableP"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/idTokenValidationFailed":{"type":"topic","title":"idTokenValidationFailed","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/idTokenValidationFailed","kind":"symbol","abstract":[{"type":"text","text":"The ID token validation performed after authentication failed."},{"type":"text","text":" "},{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value can be accessed via the "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference","isActive":true},{"type":"text","text":" property."}],"url":"\/documentation\/auth0\/webautherror\/idtokenvalidationfailed","role":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"idTokenValidationFailed"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"}]},"doc://com.auth0.Auth0/s8SendableP":{"title":"Swift.Sendable","type":"unresolvable","identifier":"doc:\/\/com.auth0.Auth0\/s8SendableP"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"url":"\/documentation\/auth0\/webautherror","abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"title":"WebAuthError","navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/Auth0Error-Implementations":{"type":"topic","title":"Auth0Error Implementations","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/Auth0Error-Implementations","kind":"article","abstract":[],"url":"\/documentation\/auth0\/webautherror\/auth0error-implementations","role":"collectionGroup"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/pkceNotAllowed":{"type":"topic","title":"pkceNotAllowed","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/pkceNotAllowed","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},{"type":"text","text":","},{"type":"text","text":" "},{"type":"text","text":"by setting the "},{"inlineContent":[{"text":"Application Type","type":"text"}],"type":"strong"},{"type":"text","text":" to ‘Native’."},{"type":"text","text":" "},{"type":"text","text":"This error does not include a "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference","isActive":true},{"type":"text","text":"."}],"url":"\/documentation\/auth0\/webautherror\/pkcenotallowed","role":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"pkceNotAllowed"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/~=(_:_:)-3690":{"url":"\/documentation\/auth0\/webautherror\/~=(_:_:)-3690","abstract":[{"type":"text","text":"Matches "},{"type":"codeVoice","code":"WebAuthError"},{"type":"text","text":" values in a switch statement."}],"title":"~=(_:_:)","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:5Auth012WebAuthErrorV","text":"WebAuthError"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/~=(_:_:)-3690","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error":{"url":"\/documentation\/auth0\/auth0error","title":"Auth0Error","abstract":[{"type":"text","text":"Generic representation of Auth0 errors."}],"navigatorTitle":[{"kind":"identifier","text":"Auth0Error"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Auth0Error"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/userCancelled":{"kind":"symbol","title":"userCancelled","role":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"userCancelled"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/userCancelled","abstract":[{"type":"text","text":"The user cancelled the Web Auth operation."},{"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\/webautherror\/usercancelled"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webautherror/!=(_:_:).json b/docs/data/documentation/auth0/webautherror/!=(_:_:).json index f6ce3f4bf..6a30f9a02 100644 --- a/docs/data/documentation/auth0/webautherror/!=(_:_:).json +++ b/docs/data/documentation/auth0/webautherror/!=(_:_:).json @@ -1 +1 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/!=(_:_:)","interfaceLanguage":"swift"},"sections":[],"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"text":"Inherited from ","type":"text"},{"code":"Equatable.!=(_:_:)","type":"codeVoice"},{"text":".","type":"text"}],"metadata":{"externalID":"s:SQsE2neoiySbx_xtFZ::SYNTHESIZED::s:5Auth012WebAuthErrorV","roleHeading":"Operator","modules":[{"name":"Auth0","relatedModules":["Swift"]}],"symbolKind":"op","role":"symbol","extendedModule":"Swift","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"title":"!=(_:_:)"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webautherror\/!=(_:_:)"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"!="},{"kind":"text","text":" "},{"kind":"text","text":"("},{"kind":"internalParam","text":"lhs"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":", "},{"text":"rhs","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"platforms":["iOS"]}],"kind":"declarations"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/!=(_:_:)":{"type":"topic","role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"kind":"symbol","url":"\/documentation\/auth0\/webautherror\/!=(_:_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/!=(_:_:)","title":"!=(_:_:)","abstract":[]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"abstract":[{"text":"Represents an error during a Web Auth operation.","type":"text"}],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"type":"topic","role":"symbol","navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","title":"WebAuthError","url":"\/documentation\/auth0\/webautherror"}}} \ No newline at end of file +{"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/!=(_:_:)","interfaceLanguage":"swift"},"kind":"symbol","metadata":{"externalID":"s:SQsE2neoiySbx_xtFZ::SYNTHESIZED::s:5Auth012WebAuthErrorV","modules":[{"name":"Auth0","relatedModules":["Swift"]}],"title":"!=(_:_:)","extendedModule":"Swift","roleHeading":"Operator","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","text":"Self"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"role":"symbol","symbolKind":"op"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webautherror\/!=(_:_:)"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"!="},{"kind":"text","text":" "},{"kind":"text","text":"("},{"kind":"internalParam","text":"lhs"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":", "},{"kind":"internalParam","text":"rhs"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}]}],"kind":"declarations"}],"abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"Equatable.!=(_:_:)"},{"type":"text","text":"."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"url":"\/documentation\/auth0\/webautherror","abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"title":"WebAuthError","navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/!=(_:_:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/!=(_:_:)","kind":"symbol","title":"!=(_:_:)","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","text":"Self"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"role":"symbol","url":"\/documentation\/auth0\/webautherror\/!=(_:_:)","abstract":[],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"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 2610cd481..02cb0753a 100644 --- a/docs/data/documentation/auth0/webautherror/==(_:_:).json +++ b/docs/data/documentation/auth0/webautherror/==(_:_:).json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"kind":"symbol","sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"==","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"lhs","kind":"internalParam"},{"text":": ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"rhs","kind":"internalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}]}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/==(_:_:)"},"schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"text":"Conformance to ","type":"text"},{"code":"Equatable","type":"codeVoice"},{"text":".","type":"text"}],"metadata":{"role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"==","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"modules":[{"name":"Auth0"}],"roleHeading":"Operator","title":"==(_:_:)","symbolKind":"op","externalID":"s:5Auth012WebAuthErrorV2eeoiySbAC_ACtFZ","extendedModule":"Auth0"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webautherror\/==(_:_:)"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/==(_:_:)":{"kind":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/==(_:_:)","title":"==(_:_:)","url":"\/documentation\/auth0\/webautherror\/==(_:_:)","abstract":[{"type":"text","text":"Conformance to "},{"type":"codeVoice","code":"Equatable"},{"text":".","type":"text"}],"role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"==","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"WebAuthError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV"},{"text":", ","kind":"text"},{"text":"WebAuthError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"abstract":[{"text":"Represents an error during a Web Auth operation.","type":"text"}],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"type":"topic","role":"symbol","navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","title":"WebAuthError","url":"\/documentation\/auth0\/webautherror"}}} \ No newline at end of file +{"abstract":[{"text":"Conformance to ","type":"text"},{"code":"Equatable","type":"codeVoice"},{"text":".","type":"text"}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"==","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"lhs","kind":"internalParam"},{"text":": ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"rhs","kind":"internalParam"},{"text":": ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"platforms":["iOS"]}],"kind":"declarations"}],"variants":[{"paths":["\/documentation\/auth0\/webautherror\/==(_:_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"metadata":{"modules":[{"name":"Auth0"}],"title":"==(_:_:)","roleHeading":"Operator","symbolKind":"op","role":"symbol","extendedModule":"Auth0","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"==","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"externalID":"s:5Auth012WebAuthErrorV2eeoiySbAC_ACtFZ"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/==(_:_:)","interfaceLanguage":"swift"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/==(_:_:)":{"url":"\/documentation\/auth0\/webautherror\/==(_:_:)","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"==","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"title":"==(_:_:)","type":"topic","role":"symbol","abstract":[{"text":"Conformance to ","type":"text"},{"code":"Equatable","type":"codeVoice"},{"text":".","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/==(_:_:)","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"url":"\/documentation\/auth0\/webautherror","abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"title":"WebAuthError","navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","kind":"symbol","type":"topic"}}} \ 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 e2968825c..cc983c8be 100644 --- a/docs/data/documentation/auth0/webautherror/auth0error-implementations.json +++ b/docs/data/documentation/auth0/webautherror/auth0error-implementations.json @@ -1 +1 @@ -{"kind":"article","metadata":{"modules":[{"name":"Auth0"}],"role":"collectionGroup","roleHeading":"API Collection","title":"Auth0Error Implementations"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webautherror\/auth0error-implementations"]}],"topicSections":[{"generated":true,"anchor":"Instance-Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/errorDescription","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/localizedDescription"],"title":"Instance Properties"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/Auth0Error-Implementations"},"schemaVersion":{"major":0,"patch":0,"minor":3},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/localizedDescription":{"fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"localizedDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"title":"localizedDescription","url":"\/documentation\/auth0\/webautherror\/localizeddescription","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/localizedDescription","role":"symbol","type":"topic","kind":"symbol","abstract":[{"text":"Description of the error.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"abstract":[{"text":"Represents an error during a Web Auth operation.","type":"text"}],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"type":"topic","role":"symbol","navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","title":"WebAuthError","url":"\/documentation\/auth0\/webautherror"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/errorDescription":{"role":"symbol","title":"errorDescription","url":"\/documentation\/auth0\/webautherror\/errordescription","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"errorDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"Description of the error."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/errorDescription","type":"topic","kind":"symbol"}}} \ No newline at end of file +{"topicSections":[{"title":"Instance Properties","generated":true,"anchor":"Instance-Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/errorDescription","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/localizedDescription"]}],"schemaVersion":{"patch":0,"minor":3,"major":0},"sections":[],"variants":[{"paths":["\/documentation\/auth0\/webautherror\/auth0error-implementations"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"article","metadata":{"title":"Auth0Error Implementations","modules":[{"name":"Auth0"}],"roleHeading":"API Collection","role":"collectionGroup"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/Auth0Error-Implementations"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/localizedDescription":{"kind":"symbol","title":"localizedDescription","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"localizedDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/localizedDescription","abstract":[{"type":"text","text":"Description of the error."}],"url":"\/documentation\/auth0\/webautherror\/localizeddescription"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/errorDescription":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/errorDescription","type":"topic","title":"errorDescription","role":"symbol","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"errorDescription","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"abstract":[{"type":"text","text":"Description of the error."}],"url":"\/documentation\/auth0\/webautherror\/errordescription"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"url":"\/documentation\/auth0\/webautherror","abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"title":"WebAuthError","navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","kind":"symbol","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 d580b755b..5fa1746db 100644 --- a/docs/data/documentation/auth0/webautherror/cause.json +++ b/docs/data/documentation/auth0/webautherror/cause.json @@ -1 +1 @@ -{"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/cause","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"variants":[{"paths":["\/documentation\/auth0\/webautherror\/cause"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","schemaVersion":{"minor":3,"patch":0,"major":0},"metadata":{"symbolKind":"property","role":"symbol","roleHeading":"Instance Property","externalID":"s:5Auth012WebAuthErrorV5causes0D0_pSgvp","title":"cause","modules":[{"name":"Auth0"}],"fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:s5ErrorP","text":"Error","kind":"typeIdentifier"},{"text":"?","kind":"text"}]},"abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP","text":"Error"},{"kind":"text","text":"?"}],"languages":["swift"]}],"kind":"declarations"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/cause":{"kind":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP","text":"Error"},{"kind":"text","text":"?"}],"type":"topic","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/cause","title":"cause","url":"\/documentation\/auth0\/webautherror\/cause","abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"abstract":[{"text":"Represents an error during a Web Auth operation.","type":"text"}],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"type":"topic","role":"symbol","navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","title":"WebAuthError","url":"\/documentation\/auth0\/webautherror"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"kind":"symbol","primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Error","preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier"},{"text":"?","kind":"text"}]}],"kind":"declarations"}],"variants":[{"paths":["\/documentation\/auth0\/webautherror\/cause"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/cause","interfaceLanguage":"swift"},"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":"."}],"metadata":{"externalID":"s:5Auth012WebAuthErrorV5causes0D0_pSgvp","symbolKind":"property","title":"cause","roleHeading":"Instance Property","role":"symbol","fragments":[{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"cause","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Error","preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"modules":[{"name":"Auth0"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"url":"\/documentation\/auth0\/webautherror","abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"title":"WebAuthError","navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/cause":{"type":"topic","title":"cause","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/cause","kind":"symbol","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":"."}],"url":"\/documentation\/auth0\/webautherror\/cause","role":"symbol","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP","text":"Error"},{"kind":"text","text":"?"}]}}} \ 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 e2221e890..8c8813dd0 100644 --- a/docs/data/documentation/auth0/webautherror/debugdescription.json +++ b/docs/data/documentation/auth0/webautherror/debugdescription.json @@ -1 +1 @@ -{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webautherror\/debugdescription"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/debugDescription","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"debugDescription","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"languages":["swift"]}]},{"kind":"content","content":[{"anchor":"discussion","text":"Discussion","type":"heading","level":2},{"content":[{"type":"paragraph","inlineContent":[{"text":"You should avoid displaying the error description to the user, it’s meant for ","type":"text"},{"inlineContent":[{"text":"debugging","type":"text"}],"type":"strong"},{"text":" only.","type":"text"}]}],"name":"Important","style":"important","type":"aside"}]}],"kind":"symbol","metadata":{"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"debugDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"role":"symbol","externalID":"s:5Auth012WebAuthErrorV16debugDescriptionSSvp","roleHeading":"Instance Property","title":"debugDescription","symbolKind":"property","modules":[{"name":"Auth0"}]},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"sections":[],"abstract":[{"type":"text","text":"Description of the error."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"abstract":[{"text":"Represents an error during a Web Auth operation.","type":"text"}],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"type":"topic","role":"symbol","navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","title":"WebAuthError","url":"\/documentation\/auth0\/webautherror"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/debugDescription":{"abstract":[{"type":"text","text":"Description of the error."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/debugDescription","role":"symbol","title":"debugDescription","type":"topic","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"debugDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"url":"\/documentation\/auth0\/webautherror\/debugdescription","kind":"symbol"}}} \ No newline at end of file +{"metadata":{"symbolKind":"property","roleHeading":"Instance Property","externalID":"s:5Auth012WebAuthErrorV16debugDescriptionSSvp","title":"debugDescription","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"debugDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"role":"symbol"},"sections":[],"variants":[{"paths":["\/documentation\/auth0\/webautherror\/debugdescription"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/debugDescription"},"kind":"symbol","abstract":[{"type":"text","text":"Description of the error."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"debugDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}]}],"kind":"declarations"},{"content":[{"type":"heading","text":"Discussion","anchor":"discussion","level":2},{"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."}]}],"name":"Important"}],"kind":"content"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"url":"\/documentation\/auth0\/webautherror","abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"title":"WebAuthError","navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/debugDescription":{"type":"topic","title":"debugDescription","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/debugDescription","kind":"symbol","abstract":[{"type":"text","text":"Description of the error."}],"url":"\/documentation\/auth0\/webautherror\/debugdescription","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"debugDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"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 3d29a19c8..ff20d2f83 100644 --- a/docs/data/documentation/auth0/webautherror/equatable-implementations.json +++ b/docs/data/documentation/auth0/webautherror/equatable-implementations.json @@ -1 +1 @@ -{"topicSections":[{"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/!=(_:_:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/==(_:_:)"],"title":"Operators","anchor":"Operators","generated":true}],"schemaVersion":{"major":0,"patch":0,"minor":3},"sections":[],"variants":[{"paths":["\/documentation\/auth0\/webautherror\/equatable-implementations"],"traits":[{"interfaceLanguage":"swift"}]}],"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\/Equatable-Implementations"},"kind":"article","metadata":{"modules":[{"name":"Auth0"}],"role":"collectionGroup","title":"Equatable Implementations","roleHeading":"API Collection"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/==(_:_:)":{"kind":"symbol","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/==(_:_:)","title":"==(_:_:)","url":"\/documentation\/auth0\/webautherror\/==(_:_:)","abstract":[{"type":"text","text":"Conformance to "},{"type":"codeVoice","code":"Equatable"},{"text":".","type":"text"}],"role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"==","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"WebAuthError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV"},{"text":", ","kind":"text"},{"text":"WebAuthError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/!=(_:_:)":{"type":"topic","role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"kind":"symbol","url":"\/documentation\/auth0\/webautherror\/!=(_:_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/!=(_:_:)","title":"!=(_:_:)","abstract":[]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"abstract":[{"text":"Represents an error during a Web Auth operation.","type":"text"}],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"type":"topic","role":"symbol","navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","title":"WebAuthError","url":"\/documentation\/auth0\/webautherror"}}} \ No newline at end of file +{"metadata":{"modules":[{"name":"Auth0"}],"role":"collectionGroup","title":"Equatable Implementations","roleHeading":"API Collection"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/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\/==(_:_:)"],"anchor":"Operators"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/Equatable-Implementations"},"kind":"article","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"schemaVersion":{"patch":0,"minor":3,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"url":"\/documentation\/auth0\/webautherror","abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"title":"WebAuthError","navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/!=(_:_:)":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/!=(_:_:)","kind":"symbol","title":"!=(_:_:)","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","text":"Self"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"role":"symbol","url":"\/documentation\/auth0\/webautherror\/!=(_:_:)","abstract":[],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/==(_:_:)":{"url":"\/documentation\/auth0\/webautherror\/==(_:_:)","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"==","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"title":"==(_:_:)","type":"topic","role":"symbol","abstract":[{"text":"Conformance to ","type":"text"},{"code":"Equatable","type":"codeVoice"},{"text":".","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/==(_:_:)","kind":"symbol"}}} \ 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 23f5fc1ca..29196be9b 100644 --- a/docs/data/documentation/auth0/webautherror/errordescription.json +++ b/docs/data/documentation/auth0/webautherror/errordescription.json @@ -1 +1 @@ -{"sections":[],"schemaVersion":{"minor":3,"patch":0,"major":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/errorDescription"},"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"errorDescription"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"? { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"languages":["swift"]}]},{"content":[{"anchor":"discussion","type":"heading","text":"Discussion","level":2},{"name":"Important","content":[{"inlineContent":[{"type":"text","text":"You should avoid displaying the error description to the user, it’s meant for "},{"type":"strong","inlineContent":[{"type":"text","text":"debugging"}]},{"type":"text","text":" only."}],"type":"paragraph"}],"type":"aside","style":"important"}],"kind":"content"}],"variants":[{"paths":["\/documentation\/auth0\/webautherror\/errordescription"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"abstract":[{"text":"Description of the error.","type":"text"}],"metadata":{"extendedModule":"Auth0","title":"errorDescription","modules":[{"name":"Auth0"}],"role":"symbol","roleHeading":"Instance Property","symbolKind":"property","externalID":"s:5Auth00A5ErrorPAAE16errorDescriptionSSSgvp::SYNTHESIZED::s:5Auth012WebAuthErrorV","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"errorDescription"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"abstract":[{"text":"Represents an error during a Web Auth operation.","type":"text"}],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"type":"topic","role":"symbol","navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","title":"WebAuthError","url":"\/documentation\/auth0\/webautherror"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/errorDescription":{"role":"symbol","title":"errorDescription","url":"\/documentation\/auth0\/webautherror\/errordescription","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"errorDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"Description of the error."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/errorDescription","type":"topic","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/errorDescription","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"errorDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"? { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}]}]},{"kind":"content","content":[{"level":2,"type":"heading","anchor":"discussion","text":"Discussion"},{"type":"aside","content":[{"inlineContent":[{"text":"You should avoid displaying the error description to the user, it’s meant for ","type":"text"},{"inlineContent":[{"type":"text","text":"debugging"}],"type":"strong"},{"text":" only.","type":"text"}],"type":"paragraph"}],"name":"Important","style":"important"}]}],"variants":[{"paths":["\/documentation\/auth0\/webautherror\/errordescription"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","metadata":{"modules":[{"name":"Auth0"}],"title":"errorDescription","externalID":"s:5Auth00A5ErrorPAAE16errorDescriptionSSSgvp::SYNTHESIZED::s:5Auth012WebAuthErrorV","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"errorDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"roleHeading":"Instance Property","extendedModule":"Auth0","symbolKind":"property"},"schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"type":"text","text":"Description of the error."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/errorDescription":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/errorDescription","type":"topic","title":"errorDescription","role":"symbol","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"errorDescription","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"abstract":[{"type":"text","text":"Description of the error."}],"url":"\/documentation\/auth0\/webautherror\/errordescription"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"url":"\/documentation\/auth0\/webautherror","abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"title":"WebAuthError","navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ 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 2d646d2f8..c66ad7d12 100644 --- a/docs/data/documentation/auth0/webautherror/failurereason.json +++ b/docs/data/documentation/auth0/webautherror/failurereason.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/failureReason"},"sections":[],"abstract":[{"text":"Inherited from ","type":"text"},{"code":"LocalizedError.failureReason","type":"codeVoice"},{"text":".","type":"text"}],"kind":"symbol","primaryContentSections":[{"declarations":[{"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"failureReason","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"? { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"metadata":{"extendedModule":"Foundation","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"failureReason","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"title":"failureReason","modules":[{"relatedModules":["Foundation"],"name":"Auth0"}],"externalID":"s:10Foundation14LocalizedErrorPAAE13failureReasonSSSgvp::SYNTHESIZED::s:5Auth012WebAuthErrorV","roleHeading":"Instance Property","role":"symbol","symbolKind":"property","platforms":[{"beta":false,"introducedAt":"8.0","deprecated":false,"unavailable":false,"name":"iOS"},{"beta":false,"introducedAt":"8.0","deprecated":false,"unavailable":false,"name":"iPadOS"},{"beta":false,"introducedAt":"8.0","deprecated":false,"unavailable":false,"name":"Mac Catalyst"},{"beta":false,"introducedAt":"10.10","deprecated":false,"unavailable":false,"name":"macOS"},{"beta":false,"introducedAt":"9.0","deprecated":false,"unavailable":false,"name":"tvOS"},{"beta":false,"introducedAt":"2.0","deprecated":false,"unavailable":false,"name":"watchOS"}]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webautherror\/failurereason"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"abstract":[{"text":"Represents an error during a Web Auth operation.","type":"text"}],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"type":"topic","role":"symbol","navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","title":"WebAuthError","url":"\/documentation\/auth0\/webautherror"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/failureReason":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/failureReason","url":"\/documentation\/auth0\/webautherror\/failurereason","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"failureReason"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"role":"symbol","title":"failureReason","kind":"symbol","type":"topic","abstract":[]}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webautherror\/failurereason"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"abstract":[{"text":"Inherited from ","type":"text"},{"code":"LocalizedError.failureReason","type":"codeVoice"},{"text":".","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"failureReason"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"? { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"platforms":["iOS"]}]}],"kind":"symbol","schemaVersion":{"minor":3,"patch":0,"major":0},"sections":[],"metadata":{"externalID":"s:10Foundation14LocalizedErrorPAAE13failureReasonSSSgvp::SYNTHESIZED::s:5Auth012WebAuthErrorV","extendedModule":"Foundation","platforms":[{"name":"iOS","deprecated":false,"introducedAt":"8.0","beta":false,"unavailable":false},{"name":"iPadOS","deprecated":false,"introducedAt":"8.0","beta":false,"unavailable":false},{"name":"Mac Catalyst","deprecated":false,"introducedAt":"8.0","beta":false,"unavailable":false},{"name":"macOS","deprecated":false,"introducedAt":"10.10","beta":false,"unavailable":false},{"name":"tvOS","deprecated":false,"introducedAt":"9.0","beta":false,"unavailable":false},{"name":"watchOS","deprecated":false,"introducedAt":"2.0","beta":false,"unavailable":false}],"symbolKind":"property","title":"failureReason","roleHeading":"Instance Property","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"failureReason","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"modules":[{"name":"Auth0","relatedModules":["Foundation"]}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/failureReason","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/failureReason":{"type":"topic","abstract":[],"title":"failureReason","kind":"symbol","url":"\/documentation\/auth0\/webautherror\/failurereason","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"failureReason"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/failureReason"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"url":"\/documentation\/auth0\/webautherror","abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"title":"WebAuthError","navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","kind":"symbol","type":"topic"}}} \ 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 d61941c8b..887f7f864 100644 --- a/docs/data/documentation/auth0/webautherror/helpanchor.json +++ b/docs/data/documentation/auth0/webautherror/helpanchor.json @@ -1 +1 @@ -{"kind":"symbol","schemaVersion":{"patch":0,"major":0,"minor":3},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"helpAnchor","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"? { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}]}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/helpAnchor"},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"LocalizedError.helpAnchor"},{"type":"text","text":"."}],"metadata":{"roleHeading":"Instance Property","externalID":"s:10Foundation14LocalizedErrorPAAE10helpAnchorSSSgvp::SYNTHESIZED::s:5Auth012WebAuthErrorV","role":"symbol","title":"helpAnchor","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"helpAnchor"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}],"modules":[{"name":"Auth0","relatedModules":["Foundation"]}],"extendedModule":"Foundation","platforms":[{"name":"iOS","introducedAt":"8.0","beta":false,"deprecated":false,"unavailable":false},{"name":"iPadOS","introducedAt":"8.0","beta":false,"deprecated":false,"unavailable":false},{"name":"Mac Catalyst","introducedAt":"8.0","beta":false,"deprecated":false,"unavailable":false},{"name":"macOS","introducedAt":"10.10","beta":false,"deprecated":false,"unavailable":false},{"name":"tvOS","introducedAt":"9.0","beta":false,"deprecated":false,"unavailable":false},{"name":"watchOS","introducedAt":"2.0","beta":false,"deprecated":false,"unavailable":false}],"symbolKind":"property"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webautherror\/helpanchor"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/helpAnchor":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/helpAnchor","url":"\/documentation\/auth0\/webautherror\/helpanchor","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"helpAnchor"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"role":"symbol","title":"helpAnchor","kind":"symbol","type":"topic","abstract":[]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"abstract":[{"text":"Represents an error during a Web Auth operation.","type":"text"}],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"type":"topic","role":"symbol","navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","title":"WebAuthError","url":"\/documentation\/auth0\/webautherror"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"LocalizedError.helpAnchor"},{"type":"text","text":"."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"helpAnchor"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"? { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webautherror\/helpanchor"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"metadata":{"modules":[{"name":"Auth0","relatedModules":["Foundation"]}],"title":"helpAnchor","roleHeading":"Instance Property","symbolKind":"property","role":"symbol","platforms":[{"name":"iOS","beta":false,"deprecated":false,"unavailable":false,"introducedAt":"8.0"},{"name":"iPadOS","beta":false,"deprecated":false,"unavailable":false,"introducedAt":"8.0"},{"name":"Mac Catalyst","beta":false,"deprecated":false,"unavailable":false,"introducedAt":"8.0"},{"name":"macOS","beta":false,"deprecated":false,"unavailable":false,"introducedAt":"10.10"},{"name":"tvOS","beta":false,"deprecated":false,"unavailable":false,"introducedAt":"9.0"},{"name":"watchOS","beta":false,"deprecated":false,"unavailable":false,"introducedAt":"2.0"}],"extendedModule":"Foundation","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"helpAnchor"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"externalID":"s:10Foundation14LocalizedErrorPAAE10helpAnchorSSSgvp::SYNTHESIZED::s:5Auth012WebAuthErrorV"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/helpAnchor"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/helpAnchor":{"url":"\/documentation\/auth0\/webautherror\/helpanchor","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"helpAnchor"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}],"title":"helpAnchor","type":"topic","role":"symbol","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/helpAnchor","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"url":"\/documentation\/auth0\/webautherror","abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"title":"WebAuthError","navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","kind":"symbol","type":"topic"}}} \ 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 5f3f7e7cb..f4333ec36 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},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/idTokenValidationFailed"},"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"},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true},{"text":" property.","type":"text"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webautherror\/idtokenvalidationfailed"]}],"kind":"symbol","sections":[],"metadata":{"role":"symbol","externalID":"s:5Auth012WebAuthErrorV23idTokenValidationFailedACvpZ","modules":[{"name":"Auth0"}],"title":"idTokenValidationFailed","roleHeading":"Type Property","symbolKind":"property","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"idTokenValidationFailed"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier","text":"WebAuthError"}]},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"idTokenValidationFailed","kind":"identifier"},{"text":": ","kind":"text"},{"text":"WebAuthError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier"}]}],"kind":"declarations"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/idTokenValidationFailed":{"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/idTokenValidationFailed","kind":"symbol","abstract":[{"type":"text","text":"The ID token validation performed after authentication failed."},{"type":"text","text":" "},{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value can be accessed via the "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true},{"type":"text","text":" property."}],"fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"idTokenValidationFailed","kind":"identifier"},{"text":": ","kind":"text"},{"text":"WebAuthError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV"}],"type":"topic","title":"idTokenValidationFailed","url":"\/documentation\/auth0\/webautherror\/idtokenvalidationfailed"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"title":"cause","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","kind":"symbol","abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":"?"}],"role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"abstract":[{"text":"Represents an error during a Web Auth operation.","type":"text"}],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"type":"topic","role":"symbol","navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","title":"WebAuthError","url":"\/documentation\/auth0\/webautherror"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"idTokenValidationFailed"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","text":"WebAuthError"}]}]}],"sections":[],"abstract":[{"type":"text","text":"The ID token validation performed after authentication failed."},{"type":"text","text":" "},{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value can be accessed via the "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference","isActive":true},{"type":"text","text":" property."}],"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/webautherror\/idtokenvalidationfailed"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"role":"symbol","title":"idTokenValidationFailed","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"idTokenValidationFailed"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"}],"externalID":"s:5Auth012WebAuthErrorV23idTokenValidationFailedACvpZ","roleHeading":"Type Property","symbolKind":"property"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/idTokenValidationFailed","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"url":"\/documentation\/auth0\/webautherror","abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"title":"WebAuthError","navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"kind":"symbol","title":"cause","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier","text":"Error"},{"kind":"text","text":"?"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","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":"."}],"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/idTokenValidationFailed":{"type":"topic","title":"idTokenValidationFailed","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/idTokenValidationFailed","kind":"symbol","abstract":[{"type":"text","text":"The ID token validation performed after authentication failed."},{"type":"text","text":" "},{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value can be accessed via the "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference","isActive":true},{"type":"text","text":" property."}],"url":"\/documentation\/auth0\/webautherror\/idtokenvalidationfailed","role":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"idTokenValidationFailed"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"}]}}} \ 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 e3466ac12..7c586184b 100644 --- a/docs/data/documentation/auth0/webautherror/invalidinvitationurl.json +++ b/docs/data/documentation/auth0/webautherror/invalidinvitationurl.json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"declarations","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":": "},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","text":"WebAuthError"}]}]}],"metadata":{"symbolKind":"property","modules":[{"name":"Auth0"}],"roleHeading":"Type Property","title":"invalidInvitationURL","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"invalidInvitationURL","kind":"identifier"},{"text":": ","kind":"text"},{"text":"WebAuthError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV"}],"role":"symbol","externalID":"s:5Auth012WebAuthErrorV20invalidInvitationURLACvpZ"},"schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/invalidInvitationURL","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"text":"The invitation URL is missing the ","type":"text"},{"code":"invitation","type":"codeVoice"},{"text":" and\/or the ","type":"text"},{"code":"organization","type":"codeVoice"},{"text":" query parameters.","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"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webautherror\/invalidinvitationurl"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"abstract":[{"text":"Represents an error during a Web Auth operation.","type":"text"}],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"type":"topic","role":"symbol","navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","title":"WebAuthError","url":"\/documentation\/auth0\/webautherror"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"title":"cause","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","kind":"symbol","abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":"?"}],"role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/invalidInvitationURL":{"url":"\/documentation\/auth0\/webautherror\/invalidinvitationurl","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"invalidInvitationURL"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV"}],"type":"topic","title":"invalidInvitationURL","abstract":[{"text":"The invitation URL is missing the ","type":"text"},{"code":"invitation","type":"codeVoice"},{"text":" and\/or the ","type":"text"},{"code":"organization","type":"codeVoice"},{"text":" query parameters.","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"},{"text":".","type":"text"}],"kind":"symbol","role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/invalidInvitationURL"}}} \ No newline at end of file +{"metadata":{"symbolKind":"property","title":"invalidInvitationURL","externalID":"s:5Auth012WebAuthErrorV20invalidInvitationURLACvpZ","roleHeading":"Type Property","modules":[{"name":"Auth0"}],"fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"invalidInvitationURL","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError","kind":"typeIdentifier"}],"role":"symbol"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webautherror\/invalidinvitationurl"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/invalidInvitationURL"},"kind":"symbol","abstract":[{"text":"The invitation URL is missing the ","type":"text"},{"code":"invitation","type":"codeVoice"},{"text":" and\/or the ","type":"text"},{"code":"organization","type":"codeVoice"},{"text":" query parameters.","type":"text"},{"text":" ","type":"text"},{"text":"This error does not include a ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference"},{"text":".","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"invalidInvitationURL","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"}],"platforms":["iOS"]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"url":"\/documentation\/auth0\/webautherror","abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"title":"WebAuthError","navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/invalidInvitationURL":{"type":"topic","title":"invalidInvitationURL","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"},{"type":"text","text":" query parameters."},{"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},{"type":"text","text":"."}],"url":"\/documentation\/auth0\/webautherror\/invalidinvitationurl","role":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"invalidInvitationURL"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"}]},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"kind":"symbol","title":"cause","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier","text":"Error"},{"kind":"text","text":"?"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","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":"."}],"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi"}}} \ 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 5db7c8480..4037334ac 100644 --- a/docs/data/documentation/auth0/webautherror/localizeddescription.json +++ b/docs/data/documentation/auth0/webautherror/localizeddescription.json @@ -1 +1 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/localizedDescription","interfaceLanguage":"swift"},"schemaVersion":{"major":0,"patch":0,"minor":3},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"localizedDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}]}]},{"kind":"content","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"}]}],"name":"Important","type":"aside"}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webautherror\/localizeddescription"]}],"sections":[],"metadata":{"extendedModule":"Auth0","symbolKind":"property","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"localizedDescription","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"modules":[{"name":"Auth0"}],"roleHeading":"Instance Property","title":"localizedDescription","role":"symbol","externalID":"s:5Auth00A5ErrorPAAE20localizedDescriptionSSvp::SYNTHESIZED::s:5Auth012WebAuthErrorV"},"abstract":[{"type":"text","text":"Description of the error."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/localizedDescription":{"fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"localizedDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"title":"localizedDescription","url":"\/documentation\/auth0\/webautherror\/localizeddescription","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/localizedDescription","role":"symbol","type":"topic","kind":"symbol","abstract":[{"text":"Description of the error.","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"abstract":[{"text":"Represents an error during a Web Auth operation.","type":"text"}],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"type":"topic","role":"symbol","navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","title":"WebAuthError","url":"\/documentation\/auth0\/webautherror"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"localizedDescription","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}]}]},{"kind":"content","content":[{"level":2,"anchor":"discussion","type":"heading","text":"Discussion"},{"name":"Important","content":[{"inlineContent":[{"type":"text","text":"You should avoid displaying the error description to the user, it’s meant for "},{"type":"strong","inlineContent":[{"type":"text","text":"debugging"}]},{"type":"text","text":" only."}],"type":"paragraph"}],"type":"aside","style":"important"}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webautherror\/localizeddescription"]}],"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/localizedDescription","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Description of the error."}],"metadata":{"roleHeading":"Instance Property","extendedModule":"Auth0","title":"localizedDescription","role":"symbol","symbolKind":"property","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"localizedDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"externalID":"s:5Auth00A5ErrorPAAE20localizedDescriptionSSvp::SYNTHESIZED::s:5Auth012WebAuthErrorV","modules":[{"name":"Auth0"}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"url":"\/documentation\/auth0\/webautherror","abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"title":"WebAuthError","navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/localizedDescription":{"kind":"symbol","title":"localizedDescription","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"localizedDescription"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/localizedDescription","abstract":[{"type":"text","text":"Description of the error."}],"url":"\/documentation\/auth0\/webautherror\/localizeddescription"}}} \ 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 1e7685ed5..1f41eebf8 100644 --- a/docs/data/documentation/auth0/webautherror/localizederror-implementations.json +++ b/docs/data/documentation/auth0/webautherror/localizederror-implementations.json @@ -1 +1 @@ -{"schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/LocalizedError-Implementations","interfaceLanguage":"swift"},"topicSections":[{"anchor":"Instance-Properties","title":"Instance Properties","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/failureReason","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/helpAnchor","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/recoverySuggestion"],"generated":true}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webautherror\/localizederror-implementations"]}],"metadata":{"role":"collectionGroup","modules":[{"name":"Auth0"}],"roleHeading":"API Collection","title":"LocalizedError Implementations"},"kind":"article","sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/helpAnchor":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/helpAnchor","url":"\/documentation\/auth0\/webautherror\/helpanchor","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"helpAnchor"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"role":"symbol","title":"helpAnchor","kind":"symbol","type":"topic","abstract":[]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"abstract":[{"text":"Represents an error during a Web Auth operation.","type":"text"}],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"type":"topic","role":"symbol","navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","title":"WebAuthError","url":"\/documentation\/auth0\/webautherror"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/failureReason":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/failureReason","url":"\/documentation\/auth0\/webautherror\/failurereason","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"failureReason"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"role":"symbol","title":"failureReason","kind":"symbol","type":"topic","abstract":[]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/recoverySuggestion":{"url":"\/documentation\/auth0\/webautherror\/recoverysuggestion","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"recoverySuggestion"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"title":"recoverySuggestion","role":"symbol","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/recoverySuggestion","abstract":[],"type":"topic"}}} \ No newline at end of file +{"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"],"anchor":"Instance-Properties"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webautherror\/localizederror-implementations"]}],"kind":"article","metadata":{"title":"LocalizedError Implementations","role":"collectionGroup","modules":[{"name":"Auth0"}],"roleHeading":"API Collection"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/LocalizedError-Implementations","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"url":"\/documentation\/auth0\/webautherror","abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"title":"WebAuthError","navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/recoverySuggestion":{"kind":"symbol","title":"recoverySuggestion","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"recoverySuggestion"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/recoverySuggestion","abstract":[],"url":"\/documentation\/auth0\/webautherror\/recoverysuggestion"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/failureReason":{"type":"topic","abstract":[],"title":"failureReason","kind":"symbol","url":"\/documentation\/auth0\/webautherror\/failurereason","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"failureReason"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/failureReason"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/helpAnchor":{"url":"\/documentation\/auth0\/webautherror\/helpanchor","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"helpAnchor"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?"}],"title":"helpAnchor","type":"topic","role":"symbol","abstract":[],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/helpAnchor","kind":"symbol"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webautherror/message.json b/docs/data/documentation/auth0/webautherror/message.json new file mode 100644 index 000000000..2a9d1f444 --- /dev/null +++ b/docs/data/documentation/auth0/webautherror/message.json @@ -0,0 +1 @@ +{"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"message"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"platforms":["iOS"]}],"kind":"declarations"}],"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webautherror\/message"]}],"kind":"symbol","metadata":{"role":"symbol","title":"message","modules":[{"name":"Auth0"}],"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"message","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"}],"externalID":"s:5Auth012WebAuthErrorV7messageSSvp","extendedModule":"Auth0","roleHeading":"Instance Property","symbolKind":"property"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/message","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/message":{"type":"topic","title":"message","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/message","kind":"symbol","abstract":[],"url":"\/documentation\/auth0\/webautherror\/message","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"message"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"url":"\/documentation\/auth0\/webautherror","abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"title":"WebAuthError","navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","kind":"symbol","type":"topic"}}} \ 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 7d4ec4bb5..70ae10c46 100644 --- a/docs/data/documentation/auth0/webautherror/noauthorizationcode.json +++ b/docs/data/documentation/auth0/webautherror/noauthorizationcode.json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/noAuthorizationCode"},"kind":"symbol","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"},{"text":".","type":"text"}],"metadata":{"externalID":"s:5Auth012WebAuthErrorV19noAuthorizationCodeACvpZ","symbolKind":"property","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"noAuthorizationCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV"}],"role":"symbol","roleHeading":"Type Property","title":"noAuthorizationCode","modules":[{"name":"Auth0"}]},"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"noAuthorizationCode","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","kind":"typeIdentifier"}],"platforms":["iOS"],"languages":["swift"]}]}],"variants":[{"paths":["\/documentation\/auth0\/webautherror\/noauthorizationcode"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"url":"\/documentation\/auth0","kind":"symbol","abstract":[{"text":"SDK for Apple platforms.","type":"text"}],"type":"topic","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"abstract":[{"text":"Represents an error during a Web Auth operation.","type":"text"}],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"type":"topic","role":"symbol","navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","title":"WebAuthError","url":"\/documentation\/auth0\/webautherror"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/noAuthorizationCode":{"fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"noAuthorizationCode","kind":"identifier"},{"text":": ","kind":"text"},{"text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/noAuthorizationCode","url":"\/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"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference"},{"text":".","type":"text"}],"type":"topic","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"title":"cause","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","kind":"symbol","abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":"?"}],"role":"symbol","type":"topic"}}} \ No newline at end of file +{"schemaVersion":{"patch":0,"major":0,"minor":3},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"noAuthorizationCode"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","kind":"typeIdentifier","text":"WebAuthError"}],"platforms":["iOS"]}]}],"sections":[],"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"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference"},{"text":".","type":"text"}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webautherror\/noauthorizationcode"]}],"metadata":{"role":"symbol","modules":[{"name":"Auth0"}],"title":"noAuthorizationCode","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"noAuthorizationCode"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV"}],"externalID":"s:5Auth012WebAuthErrorV19noAuthorizationCodeACvpZ","roleHeading":"Type Property","symbolKind":"property"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/noAuthorizationCode","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/noAuthorizationCode":{"type":"topic","title":"noAuthorizationCode","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/noAuthorizationCode","kind":"symbol","abstract":[{"type":"text","text":"The callback URL is missing the "},{"code":"code","type":"codeVoice"},{"type":"text","text":" query parameter."},{"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},{"type":"text","text":"."}],"url":"\/documentation\/auth0\/webautherror\/noauthorizationcode","role":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"noAuthorizationCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"url":"\/documentation\/auth0\/webautherror","abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"title":"WebAuthError","navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"kind":"symbol","title":"cause","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier","text":"Error"},{"kind":"text","text":"?"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","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":"."}],"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi"}}} \ 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 2733ef386..139d2214a 100644 --- a/docs/data/documentation/auth0/webautherror/nobundleidentifier.json +++ b/docs/data/documentation/auth0/webautherror/nobundleidentifier.json @@ -1 +1 @@ -{"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/noBundleIdentifier"},"sections":[],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"noBundleIdentifier","kind":"identifier"},{"text":": ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","text":"WebAuthError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV"}]}],"kind":"declarations"}],"schemaVersion":{"minor":3,"major":0,"patch":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webautherror\/nobundleidentifier"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"metadata":{"externalID":"s:5Auth012WebAuthErrorV18noBundleIdentifierACvpZ","title":"noBundleIdentifier","roleHeading":"Type Property","symbolKind":"property","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"noBundleIdentifier","kind":"identifier"},{"text":": ","kind":"text"},{"text":"WebAuthError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV"}],"role":"symbol","modules":[{"name":"Auth0"}]},"abstract":[{"text":"The bundle identifier could not be retrieved from ","type":"text"},{"code":"Bundle.main.bundleIdentifier","type":"codeVoice"},{"text":", or it could not be used to","type":"text"},{"text":" ","type":"text"},{"text":"build a valid URL.","type":"text"},{"text":" ","type":"text"},{"text":"This error does not include a ","type":"text"},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},{"text":".","type":"text"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"abstract":[{"text":"Represents an error during a Web Auth operation.","type":"text"}],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"type":"topic","role":"symbol","navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","title":"WebAuthError","url":"\/documentation\/auth0\/webautherror"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"title":"cause","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","kind":"symbol","abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":"?"}],"role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/noBundleIdentifier":{"abstract":[{"text":"The bundle identifier could not be retrieved from ","type":"text"},{"code":"Bundle.main.bundleIdentifier","type":"codeVoice"},{"text":", or it could not be used to","type":"text"},{"text":" ","type":"text"},{"text":"build a valid URL.","type":"text"},{"text":" ","type":"text"},{"text":"This error does not include a ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true,"type":"reference"},{"text":".","type":"text"}],"type":"topic","title":"noBundleIdentifier","role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"noBundleIdentifier","kind":"identifier"},{"text":": ","kind":"text"},{"text":"WebAuthError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/noBundleIdentifier","url":"\/documentation\/auth0\/webautherror\/nobundleidentifier"}}} \ No newline at end of file +{"sections":[],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/noBundleIdentifier","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"noBundleIdentifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","kind":"typeIdentifier","text":"WebAuthError"}]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webautherror\/nobundleidentifier"]}],"kind":"symbol","metadata":{"modules":[{"name":"Auth0"}],"title":"noBundleIdentifier","externalID":"s:5Auth012WebAuthErrorV18noBundleIdentifierACvpZ","role":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"noBundleIdentifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier","text":"WebAuthError"}],"symbolKind":"property","roleHeading":"Type Property"},"schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"type":"text","text":"The bundle identifier could not be retrieved from "},{"code":"Bundle.main.bundleIdentifier","type":"codeVoice"},{"type":"text","text":", or it could not be used to"},{"type":"text","text":" "},{"type":"text","text":"build a valid URL."},{"type":"text","text":" "},{"type":"text","text":"This error does not include a "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference","isActive":true},{"type":"text","text":"."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/noBundleIdentifier":{"title":"noBundleIdentifier","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/noBundleIdentifier","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"noBundleIdentifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"}],"abstract":[{"type":"text","text":"The bundle identifier could not be retrieved from "},{"code":"Bundle.main.bundleIdentifier","type":"codeVoice"},{"type":"text","text":", or it could not be used to"},{"type":"text","text":" "},{"type":"text","text":"build a valid URL."},{"type":"text","text":" "},{"type":"text","text":"This error does not include a "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference","isActive":true},{"type":"text","text":"."}],"url":"\/documentation\/auth0\/webautherror\/nobundleidentifier"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"url":"\/documentation\/auth0\/webautherror","abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"title":"WebAuthError","navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"kind":"symbol","title":"cause","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier","text":"Error"},{"kind":"text","text":"?"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","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":"."}],"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ 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 cc5ada51e..3616d5c8b 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"},"metadata":{"modules":[{"name":"Auth0"}],"externalID":"s:5Auth012WebAuthErrorV5otherACvpZ","role":"symbol","symbolKind":"property","title":"other","roleHeading":"Type Property","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"other","kind":"identifier"},{"text":": ","kind":"text"},{"text":"WebAuthError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV"}]},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"schemaVersion":{"minor":3,"patch":0,"major":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"other","kind":"identifier"},{"text":": ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError","kind":"typeIdentifier"}],"languages":["swift"]}]}],"abstract":[{"text":"An unexpected error occurred, and an ","type":"text"},{"code":"Error","type":"codeVoice"},{"text":" value is available.","type":"text"},{"text":" ","type":"text"},{"text":"The underlying ","type":"text"},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value can be accessed via the "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","isActive":true},{"type":"text","text":" property."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webautherror\/other"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"title":"cause","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","kind":"symbol","abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":"?"}],"role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"abstract":[{"text":"Represents an error during a Web Auth operation.","type":"text"}],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"type":"topic","role":"symbol","navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","title":"WebAuthError","url":"\/documentation\/auth0\/webautherror"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/other":{"url":"\/documentation\/auth0\/webautherror\/other","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/other","kind":"symbol","title":"other","role":"symbol","abstract":[{"type":"text","text":"An unexpected error occurred, and an "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value is available."},{"type":"text","text":" "},{"type":"text","text":"The underlying "},{"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"},{"type":"text","text":" property."}],"fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"other","kind":"identifier"},{"text":": ","kind":"text"},{"text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier"}],"type":"topic"}}} \ No newline at end of file +{"metadata":{"symbolKind":"property","title":"other","externalID":"s:5Auth012WebAuthErrorV5otherACvpZ","roleHeading":"Type Property","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"other"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV"}],"role":"symbol"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webautherror\/other"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/other"},"kind":"symbol","abstract":[{"text":"An unexpected error occurred, and an ","type":"text"},{"code":"Error","type":"codeVoice"},{"text":" value is available.","type":"text"},{"text":" ","type":"text"},{"text":"The underlying ","type":"text"},{"code":"Error","type":"codeVoice"},{"text":" value can be accessed via the ","type":"text"},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},{"text":" property.","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"other"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"WebAuthError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV"}],"languages":["swift"],"platforms":["iOS"]}]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"url":"\/documentation\/auth0\/webautherror","abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"title":"WebAuthError","navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"kind":"symbol","title":"cause","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier","text":"Error"},{"kind":"text","text":"?"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","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":"."}],"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/other":{"type":"topic","title":"other","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/other","kind":"symbol","abstract":[{"type":"text","text":"An unexpected error occurred, and an "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value is available."},{"type":"text","text":" "},{"type":"text","text":"The underlying "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value can be accessed via the "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference","isActive":true},{"type":"text","text":" property."}],"url":"\/documentation\/auth0\/webautherror\/other","role":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"other"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"}]}}} \ 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 b0dfee91d..c41348b62 100644 --- a/docs/data/documentation/auth0/webautherror/pkcenotallowed.json +++ b/docs/data/documentation/auth0/webautherror/pkcenotallowed.json @@ -1 +1 @@ -{"schemaVersion":{"patch":0,"major":0,"minor":3},"sections":[],"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/pkceNotAllowed"},"abstract":[{"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 ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/manage.auth0.com\/#\/applications\/"},{"text":",","type":"text"},{"text":" ","type":"text"},{"text":"by setting the ","type":"text"},{"inlineContent":[{"type":"text","text":"Application Type"}],"type":"strong"},{"text":" to ‘Native’.","type":"text"},{"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"},{"text":".","type":"text"}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"pkceNotAllowed"},{"kind":"text","text":": "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier","text":"WebAuthError"}]}],"kind":"declarations"}],"metadata":{"modules":[{"name":"Auth0"}],"symbolKind":"property","roleHeading":"Type Property","role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"pkceNotAllowed","kind":"identifier"},{"text":": ","kind":"text"},{"text":"WebAuthError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV"}],"externalID":"s:5Auth012WebAuthErrorV14pkceNotAllowedACvpZ","title":"pkceNotAllowed"},"variants":[{"paths":["\/documentation\/auth0\/webautherror\/pkcenotallowed"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/pkceNotAllowed":{"title":"pkceNotAllowed","type":"topic","url":"\/documentation\/auth0\/webautherror\/pkcenotallowed","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/pkceNotAllowed","role":"symbol","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"pkceNotAllowed","kind":"identifier"},{"text":": ","kind":"text"},{"text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier"}],"abstract":[{"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 ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/manage.auth0.com\/#\/applications\/"},{"text":",","type":"text"},{"text":" ","type":"text"},{"text":"by setting the ","type":"text"},{"inlineContent":[{"type":"text","text":"Application Type"}],"type":"strong"},{"text":" to ‘Native’.","type":"text"},{"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"},{"text":".","type":"text"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"abstract":[{"text":"Represents an error during a Web Auth operation.","type":"text"}],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"type":"topic","role":"symbol","navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","title":"WebAuthError","url":"\/documentation\/auth0\/webautherror"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"title":"cause","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","kind":"symbol","abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":"?"}],"role":"symbol","type":"topic"},"https://manage.auth0.com/#/applications/":{"title":"Auth0 application","titleInlineContent":[{"text":"Auth0 application","type":"text"}],"type":"link","url":"https:\/\/manage.auth0.com\/#\/applications\/","identifier":"https:\/\/manage.auth0.com\/#\/applications\/"}}} \ No newline at end of file +{"metadata":{"symbolKind":"property","title":"pkceNotAllowed","externalID":"s:5Auth012WebAuthErrorV14pkceNotAllowedACvpZ","roleHeading":"Type Property","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"pkceNotAllowed"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV"}],"role":"symbol"},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webautherror\/pkcenotallowed"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/pkceNotAllowed","interfaceLanguage":"swift"},"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 "},{"type":"reference","isActive":true,"identifier":"https:\/\/manage.auth0.com\/#\/applications\/"},{"type":"text","text":","},{"type":"text","text":" "},{"type":"text","text":"by setting the "},{"type":"strong","inlineContent":[{"text":"Application Type","type":"text"}]},{"type":"text","text":" to ‘Native’."},{"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":"."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"pkceNotAllowed"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"WebAuthError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV"}]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"kind":"symbol","title":"cause","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier","text":"Error"},{"kind":"text","text":"?"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","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":"."}],"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"url":"\/documentation\/auth0\/webautherror","abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"title":"WebAuthError","navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","kind":"symbol","type":"topic"},"https://manage.auth0.com/#/applications/":{"type":"link","titleInlineContent":[{"type":"text","text":"Auth0 application"}],"identifier":"https:\/\/manage.auth0.com\/#\/applications\/","title":"Auth0 application","url":"https:\/\/manage.auth0.com\/#\/applications\/"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/pkceNotAllowed":{"type":"topic","title":"pkceNotAllowed","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/pkceNotAllowed","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},{"type":"text","text":","},{"type":"text","text":" "},{"type":"text","text":"by setting the "},{"inlineContent":[{"text":"Application Type","type":"text"}],"type":"strong"},{"type":"text","text":" to ‘Native’."},{"type":"text","text":" "},{"type":"text","text":"This error does not include a "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference","isActive":true},{"type":"text","text":"."}],"url":"\/documentation\/auth0\/webautherror\/pkcenotallowed","role":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"pkceNotAllowed"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"}]}}} \ 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 0bf013781..c6f38376d 100644 --- a/docs/data/documentation/auth0/webautherror/recoverysuggestion.json +++ b/docs/data/documentation/auth0/webautherror/recoverysuggestion.json @@ -1 +1 @@ -{"variants":[{"paths":["\/documentation\/auth0\/webautherror\/recoverysuggestion"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"type":"text","text":"Inherited from "},{"type":"codeVoice","code":"LocalizedError.recoverySuggestion"},{"type":"text","text":"."}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"recoverySuggestion","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"? { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}]}],"kind":"declarations"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/recoverySuggestion"},"schemaVersion":{"patch":0,"major":0,"minor":3},"metadata":{"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"recoverySuggestion","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"extendedModule":"Foundation","modules":[{"relatedModules":["Foundation"],"name":"Auth0"}],"role":"symbol","platforms":[{"beta":false,"name":"iOS","introducedAt":"8.0","deprecated":false,"unavailable":false},{"beta":false,"name":"iPadOS","introducedAt":"8.0","deprecated":false,"unavailable":false},{"beta":false,"name":"Mac Catalyst","introducedAt":"8.0","deprecated":false,"unavailable":false},{"beta":false,"name":"macOS","introducedAt":"10.10","deprecated":false,"unavailable":false},{"beta":false,"name":"tvOS","introducedAt":"9.0","deprecated":false,"unavailable":false},{"beta":false,"name":"watchOS","introducedAt":"2.0","deprecated":false,"unavailable":false}],"title":"recoverySuggestion","externalID":"s:10Foundation14LocalizedErrorPAAE18recoverySuggestionSSSgvp::SYNTHESIZED::s:5Auth012WebAuthErrorV","roleHeading":"Instance Property","symbolKind":"property"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"sections":[],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"abstract":[{"text":"Represents an error during a Web Auth operation.","type":"text"}],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"type":"topic","role":"symbol","navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","title":"WebAuthError","url":"\/documentation\/auth0\/webautherror"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/recoverySuggestion":{"url":"\/documentation\/auth0\/webautherror\/recoverysuggestion","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"recoverySuggestion"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"title":"recoverySuggestion","role":"symbol","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/recoverySuggestion","abstract":[],"type":"topic"}}} \ No newline at end of file +{"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"recoverySuggestion","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":"? { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webautherror\/recoverysuggestion"]}],"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/recoverySuggestion","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Inherited from "},{"code":"LocalizedError.recoverySuggestion","type":"codeVoice"},{"type":"text","text":"."}],"metadata":{"roleHeading":"Instance Property","extendedModule":"Foundation","title":"recoverySuggestion","role":"symbol","symbolKind":"property","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"recoverySuggestion"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"externalID":"s:10Foundation14LocalizedErrorPAAE18recoverySuggestionSSSgvp::SYNTHESIZED::s:5Auth012WebAuthErrorV","platforms":[{"beta":false,"introducedAt":"8.0","deprecated":false,"name":"iOS","unavailable":false},{"beta":false,"introducedAt":"8.0","deprecated":false,"name":"iPadOS","unavailable":false},{"beta":false,"introducedAt":"8.0","deprecated":false,"name":"Mac Catalyst","unavailable":false},{"beta":false,"introducedAt":"10.10","deprecated":false,"name":"macOS","unavailable":false},{"beta":false,"introducedAt":"9.0","deprecated":false,"name":"tvOS","unavailable":false},{"beta":false,"introducedAt":"2.0","deprecated":false,"name":"watchOS","unavailable":false}],"modules":[{"name":"Auth0","relatedModules":["Foundation"]}]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/recoverySuggestion":{"kind":"symbol","title":"recoverySuggestion","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"recoverySuggestion"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/recoverySuggestion","abstract":[],"url":"\/documentation\/auth0\/webautherror\/recoverysuggestion"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"url":"\/documentation\/auth0\/webautherror","abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"title":"WebAuthError","navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webautherror/transactionactivealready.json b/docs/data/documentation/auth0/webautherror/transactionactivealready.json index ce4800b9b..2e3d2aa0d 100644 --- a/docs/data/documentation/auth0/webautherror/transactionactivealready.json +++ b/docs/data/documentation/auth0/webautherror/transactionactivealready.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\/transactionActiveAlready","interfaceLanguage":"swift"},"metadata":{"roleHeading":"Type Property","modules":[{"name":"Auth0"}],"symbolKind":"property","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"transactionActiveAlready"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier","text":"WebAuthError"}],"role":"symbol","externalID":"s:5Auth012WebAuthErrorV24transactionActiveAlreadyACvpZ","title":"transactionActiveAlready"},"kind":"symbol","abstract":[{"text":"There is already an active transaction at the moment; therefore, this newly initiated transaction is canceled.","type":"text"},{"text":" ","type":"text"},{"text":"This error does not include a ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference"},{"text":".","type":"text"}],"variants":[{"paths":["\/documentation\/auth0\/webautherror\/transactionactivealready"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"transactionActiveAlready"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"WebAuthError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"sections":[],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/transactionActiveAlready":{"role":"symbol","title":"transactionActiveAlready","url":"\/documentation\/auth0\/webautherror\/transactionactivealready","kind":"symbol","abstract":[{"type":"text","text":"There is already an active transaction at the moment; therefore, this newly initiated transaction is canceled."},{"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},{"type":"text","text":"."}],"fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"transactionActiveAlready","kind":"identifier"},{"text":": ","kind":"text"},{"text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/transactionActiveAlready"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"title":"cause","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","kind":"symbol","abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":"?"}],"role":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"abstract":[{"text":"Represents an error during a Web Auth operation.","type":"text"}],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"type":"topic","role":"symbol","navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","title":"WebAuthError","url":"\/documentation\/auth0\/webautherror"}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webautherror\/transactionactivealready"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"abstract":[{"text":"There is already an active transaction at the moment; therefore, this newly initiated transaction is canceled.","type":"text"},{"text":" ","type":"text"},{"text":"This error does not include a ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference","isActive":true},{"text":".","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"transactionActiveAlready","kind":"identifier"},{"text":": ","kind":"text"},{"text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","kind":"typeIdentifier"}],"platforms":["iOS"]}]}],"kind":"symbol","schemaVersion":{"minor":3,"major":0,"patch":0},"sections":[],"metadata":{"externalID":"s:5Auth012WebAuthErrorV24transactionActiveAlreadyACvpZ","symbolKind":"property","title":"transactionActiveAlready","role":"symbol","roleHeading":"Type Property","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"transactionActiveAlready","kind":"identifier"},{"text":": ","kind":"text"},{"text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier"}],"modules":[{"name":"Auth0"}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/transactionActiveAlready"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"url":"\/documentation\/auth0\/webautherror","abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"title":"WebAuthError","navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/transactionActiveAlready":{"type":"topic","title":"transactionActiveAlready","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/transactionActiveAlready","kind":"symbol","abstract":[{"type":"text","text":"There is already an active transaction at the moment; therefore, this newly initiated transaction is canceled."},{"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},{"type":"text","text":"."}],"url":"\/documentation\/auth0\/webautherror\/transactionactivealready","role":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"transactionActiveAlready"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"}]},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"kind":"symbol","title":"cause","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier","text":"Error"},{"kind":"text","text":"?"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","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":"."}],"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ 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 2cc819583..d0731d322 100644 --- a/docs/data/documentation/auth0/webautherror/unknown.json +++ b/docs/data/documentation/auth0/webautherror/unknown.json @@ -1 +1 @@ -{"abstract":[{"text":"An unexpected error occurred, but an ","type":"text"},{"code":"Error","type":"codeVoice"},{"text":" value is not available.","type":"text"},{"text":" ","type":"text"},{"text":"This error does not include a ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference"},{"text":".","type":"text"}],"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"kind":"symbol","primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"unknown"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"}],"platforms":["iOS"]}],"kind":"declarations"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/unknown"},"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"role":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"unknown"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"}],"symbolKind":"property","title":"unknown","roleHeading":"Type Property","externalID":"s:5Auth012WebAuthErrorV7unknownACvpZ","modules":[{"name":"Auth0"}]},"variants":[{"paths":["\/documentation\/auth0\/webautherror\/unknown"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"abstract":[{"text":"Represents an error during a Web Auth operation.","type":"text"}],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"type":"topic","role":"symbol","navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","title":"WebAuthError","url":"\/documentation\/auth0\/webautherror"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/unknown":{"type":"topic","kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/unknown","title":"unknown","abstract":[{"text":"An unexpected error occurred, but an ","type":"text"},{"type":"codeVoice","code":"Error"},{"text":" value is not available.","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"}],"role":"symbol","url":"\/documentation\/auth0\/webautherror\/unknown","fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"unknown","kind":"identifier"},{"text":": ","kind":"text"},{"text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"title":"cause","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","kind":"symbol","abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":"?"}],"role":"symbol","type":"topic"}}} \ No newline at end of file +{"sections":[],"metadata":{"externalID":"s:5Auth012WebAuthErrorV7unknownACvpZ","modules":[{"name":"Auth0"}],"title":"unknown","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"unknown"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier","text":"WebAuthError"}],"roleHeading":"Type Property","role":"symbol","symbolKind":"property"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/unknown","interfaceLanguage":"swift"},"kind":"symbol","variants":[{"paths":["\/documentation\/auth0\/webautherror\/unknown"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"unknown"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","kind":"typeIdentifier","text":"WebAuthError"}]}]}],"abstract":[{"type":"text","text":"An unexpected error occurred, but an "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value is not available."},{"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},{"type":"text","text":"."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"url":"\/documentation\/auth0\/webautherror","abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"title":"WebAuthError","navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"kind":"symbol","title":"cause","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier","text":"Error"},{"kind":"text","text":"?"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","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":"."}],"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/unknown":{"type":"topic","title":"unknown","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/unknown","kind":"symbol","abstract":[{"type":"text","text":"An unexpected error occurred, but an "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" value is not available."},{"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},{"type":"text","text":"."}],"url":"\/documentation\/auth0\/webautherror\/unknown","role":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"unknown"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"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 47585af10..85d63c1bc 100644 --- a/docs/data/documentation/auth0/webautherror/usercancelled.json +++ b/docs/data/documentation/auth0/webautherror/usercancelled.json @@ -1 +1 @@ -{"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"}],"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\/userCancelled"},"sections":[],"metadata":{"externalID":"s:5Auth012WebAuthErrorV13userCancelledACvpZ","title":"userCancelled","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"userCancelled","kind":"identifier"},{"text":": ","kind":"text"},{"text":"WebAuthError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV"}],"roleHeading":"Type Property","symbolKind":"property","role":"symbol","modules":[{"name":"Auth0"}]},"schemaVersion":{"minor":3,"patch":0,"major":0},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"userCancelled","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","text":"WebAuthError","kind":"typeIdentifier"}]}],"kind":"declarations"}],"variants":[{"paths":["\/documentation\/auth0\/webautherror\/usercancelled"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/userCancelled":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/userCancelled","kind":"symbol","role":"symbol","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","isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi"},{"text":".","type":"text"}],"url":"\/documentation\/auth0\/webautherror\/usercancelled","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"userCancelled"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"}],"title":"userCancelled","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"abstract":[{"text":"Represents an error during a Web Auth operation.","type":"text"}],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"type":"topic","role":"symbol","navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","title":"WebAuthError","url":"\/documentation\/auth0\/webautherror"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"title":"cause","url":"\/documentation\/auth0\/auth0error\/cause-9wuyi","kind":"symbol","abstract":[{"type":"text","text":"The underlying "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" value, if any. Defaults to "},{"type":"codeVoice","code":"nil"},{"type":"text","text":"."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":"?"}],"role":"symbol","type":"topic"}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webautherror\/usercancelled"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"abstract":[{"text":"The user cancelled the Web Auth operation.","type":"text"},{"text":" ","type":"text"},{"text":"This error does not include a ","type":"text"},{"isActive":true,"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","type":"reference"},{"text":".","type":"text"}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"userCancelled"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","kind":"typeIdentifier","text":"WebAuthError"}],"platforms":["iOS"]}],"kind":"declarations"}],"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","metadata":{"externalID":"s:5Auth012WebAuthErrorV13userCancelledACvpZ","symbolKind":"property","title":"userCancelled","role":"symbol","roleHeading":"Type Property","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"userCancelled","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError","kind":"typeIdentifier"}],"modules":[{"name":"Auth0"}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/userCancelled"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"url":"\/documentation\/auth0\/webautherror","abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"title":"WebAuthError","navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/Auth0Error/cause-9wuyi":{"kind":"symbol","title":"cause","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"cause"},{"kind":"text","text":": "},{"preciseIdentifier":"s:s5ErrorP","kind":"typeIdentifier","text":"Error"},{"kind":"text","text":"?"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/Auth0Error\/cause-9wuyi","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":"."}],"url":"\/documentation\/auth0\/auth0error\/cause-9wuyi"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/userCancelled":{"kind":"symbol","title":"userCancelled","role":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"userCancelled"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV"}],"type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/userCancelled","abstract":[{"type":"text","text":"The user cancelled the Web Auth operation."},{"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\/webautherror\/usercancelled"}}} \ 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 7f2f24453..2a2ca4398 100644 --- a/docs/data/documentation/auth0/webautherror/~=(_:_:)-3690.json +++ b/docs/data/documentation/auth0/webautherror/~=(_:_:)-3690.json @@ -1 +1 @@ -{"schemaVersion":{"major":0,"patch":0,"minor":3},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"~=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"lhs","kind":"internalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"internalParam","text":"rhs"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","text":"WebAuthError"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"languages":["swift"],"platforms":["iOS"]}]}],"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"metadata":{"fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"~="},{"kind":"text","text":" "},{"kind":"text","text":"("},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier","text":"WebAuthError"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier","text":"WebAuthError"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"extendedModule":"Auth0","externalID":"s:5Auth012WebAuthErrorV2teoiySbAC_ACtFZ","title":"~=(_:_:)","role":"symbol","symbolKind":"op","modules":[{"name":"Auth0"}],"roleHeading":"Operator"},"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webautherror\/~=(_:_:)-3690"]}],"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."}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/~=(_:_:)-3690":{"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/~=(_:_:)-3690","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"~=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"role":"symbol","url":"\/documentation\/auth0\/webautherror\/~=(_:_:)-3690","abstract":[{"text":"Matches ","type":"text"},{"type":"codeVoice","code":"WebAuthError"},{"text":" values in a switch statement.","type":"text"}],"title":"~=(_:_:)","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"abstract":[{"text":"Represents an error during a Web Auth operation.","type":"text"}],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"type":"topic","role":"symbol","navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","title":"WebAuthError","url":"\/documentation\/auth0\/webautherror"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"metadata":{"modules":[{"name":"Auth0"}],"title":"~=(_:_:)","externalID":"s:5Auth012WebAuthErrorV2teoiySbAC_ACtFZ","role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"~=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"roleHeading":"Operator","extendedModule":"Auth0","symbolKind":"op"},"sections":[],"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"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/~=(_:_:)-3690","interfaceLanguage":"swift"},"kind":"symbol","schemaVersion":{"patch":0,"minor":3,"major":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"~="},{"kind":"text","text":" "},{"kind":"text","text":"("},{"kind":"internalParam","text":"lhs"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","kind":"typeIdentifier","text":"WebAuthError"},{"kind":"text","text":", "},{"text":"rhs","kind":"internalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","text":"WebAuthError","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"languages":["swift"],"platforms":["iOS"]}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"url":"\/documentation\/auth0\/webautherror","abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"title":"WebAuthError","navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/~=(_:_:)-3690":{"url":"\/documentation\/auth0\/webautherror\/~=(_:_:)-3690","abstract":[{"type":"text","text":"Matches "},{"type":"codeVoice","code":"WebAuthError"},{"type":"text","text":" values in a switch statement."}],"title":"~=(_:_:)","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:5Auth012WebAuthErrorV","text":"WebAuthError"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/~=(_:_:)-3690","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ 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 835700abb..835868899 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"]]},"kind":"symbol","abstract":[{"type":"text","text":"Matches "},{"type":"codeVoice","code":"Error"},{"type":"text","text":" values in a switch statement."}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"~="},{"kind":"text","text":" "},{"kind":"text","text":"("},{"kind":"internalParam","text":"lhs"},{"kind":"text","text":": "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","kind":"typeIdentifier","text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV"},{"kind":"text","text":", "},{"kind":"internalParam","text":"rhs"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"languages":["swift"],"platforms":["iOS"]}]}],"sections":[],"schemaVersion":{"minor":3,"patch":0,"major":0},"metadata":{"role":"symbol","extendedModule":"Auth0","roleHeading":"Operator","title":"~=(_:_:)","externalID":"s:5Auth012WebAuthErrorV2teoiySbAC_s0D0_ptFZ","modules":[{"name":"Auth0"}],"symbolKind":"op","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"~=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"preciseIdentifier":"s:s5ErrorP","text":"Error","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}]},"variants":[{"paths":["\/documentation\/auth0\/webautherror\/~=(_:_:)-6ibkd"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/~=(_:_:)-6ibkd"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/~=(_:_:)-6ibkd":{"url":"\/documentation\/auth0\/webautherror\/~=(_:_:)-6ibkd","role":"symbol","abstract":[{"text":"Matches ","type":"text"},{"code":"Error","type":"codeVoice"},{"text":" values in a switch statement.","type":"text"}],"kind":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/~=(_:_:)-6ibkd","title":"~=(_:_:)","type":"topic","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"~=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"WebAuthError","kind":"typeIdentifier","preciseIdentifier":"s:5Auth012WebAuthErrorV"},{"text":", ","kind":"text"},{"text":"Error","kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"abstract":[{"text":"Represents an error during a Web Auth operation.","type":"text"}],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"type":"topic","role":"symbol","navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","title":"WebAuthError","url":"\/documentation\/auth0\/webautherror"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"}}} \ No newline at end of file +{"abstract":[{"text":"Matches ","type":"text"},{"code":"Error","type":"codeVoice"},{"text":" values in a switch statement.","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"~=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"lhs","kind":"internalParam"},{"text":": ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","text":"WebAuthError","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"rhs","kind":"internalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:s5ErrorP","text":"Error","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"platforms":["iOS"]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webautherror\/~=(_:_:)-6ibkd"]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError"]]},"metadata":{"modules":[{"name":"Auth0"}],"title":"~=(_:_:)","roleHeading":"Operator","symbolKind":"op","role":"symbol","extendedModule":"Auth0","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","text":"WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"Error","preciseIdentifier":"s:s5ErrorP"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"externalID":"s:5Auth012WebAuthErrorV2teoiySbAC_s0D0_ptFZ"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/~=(_:_:)-6ibkd","interfaceLanguage":"swift"},"kind":"symbol","references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError/~=(_:_:)-6ibkd":{"type":"topic","title":"~=(_:_:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError\/~=(_:_:)-6ibkd","kind":"symbol","abstract":[{"type":"text","text":"Matches "},{"code":"Error","type":"codeVoice"},{"type":"text","text":" values in a switch statement."}],"url":"\/documentation\/auth0\/webautherror\/~=(_:_:)-6ibkd","role":"symbol","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:5Auth012WebAuthErrorV","text":"WebAuthError"},{"kind":"text","text":", "},{"kind":"typeIdentifier","preciseIdentifier":"s:s5ErrorP","text":"Error"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sb","text":"Bool"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"url":"\/documentation\/auth0\/webautherror","abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"title":"WebAuthError","navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","kind":"symbol","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 9b94184f1..bf99abb3d 100644 --- a/docs/data/documentation/auth0/webauthprovider.json +++ b/docs/data/documentation/auth0/webauthprovider.json @@ -1 +1 @@ -{"sections":[],"primaryContentSections":[{"declarations":[{"tokens":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthProvider","kind":"identifier"},{"text":" = (","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"url","kind":"internalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation3URLV","text":"URL","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"callback","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"@escaping","kind":"attribute"},{"text":" ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProviderCallback","preciseIdentifier":"s:5Auth023WebAuthProviderCallbacka","text":"WebAuthProviderCallback","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","preciseIdentifier":"s:5Auth016WebAuthUserAgentP","text":"WebAuthUserAgent","kind":"typeIdentifier"}],"languages":["swift"],"platforms":["iOS"]}],"kind":"declarations"}],"seeAlsoSections":[{"identifiers":["https:\/\/github.com\/auth0\/Auth0.swift\/blob\/master\/Auth0\/SafariProvider.swift"],"anchor":"Related-Documentation","title":"Related Documentation"}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProvider","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"variants":[{"paths":["\/documentation\/auth0\/webauthprovider"],"traits":[{"interfaceLanguage":"swift"}]}],"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"},{"text":" to perform a web-based operation.","type":"text"},{"text":" ","type":"text"},{"text":"The ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","isActive":true,"type":"reference"},{"text":" opens the URL in an external user agent and then invokes the callback when done.","type":"text"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"symbolKind":"typealias","modules":[{"name":"Auth0"}],"roleHeading":"Type Alias","navigatorTitle":[{"text":"WebAuthProvider","kind":"identifier"}],"externalID":"s:5Auth015WebAuthProvidera","role":"symbol","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthProvider"}],"title":"WebAuthProvider"},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthProviderCallback":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProviderCallback","url":"\/documentation\/auth0\/webauthprovidercallback","role":"symbol","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthProviderCallback"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuthProviderCallback"}],"type":"topic","abstract":[{"type":"text","text":"Callback invoked by the "},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent"},{"type":"text","text":" when the web-based operation concludes."}],"title":"WebAuthProviderCallback","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"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":{"title":"WebAuthUserAgent","url":"\/documentation\/auth0\/webauthuseragent","navigatorTitle":[{"kind":"identifier","text":"WebAuthUserAgent"}],"abstract":[{"type":"text","text":"The external user agent used to perform a web-based operation."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","kind":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthUserAgent"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthProvider":{"type":"topic","navigatorTitle":[{"kind":"identifier","text":"WebAuthProvider"}],"role":"symbol","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProvider","kind":"symbol","title":"WebAuthProvider","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"},{"text":" to perform a web-based operation.","type":"text"},{"text":" ","type":"text"},{"text":"The ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","isActive":true,"type":"reference"},{"text":" opens the URL in an external user agent and then invokes the callback when done.","type":"text"}],"fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthProvider"}],"url":"\/documentation\/auth0\/webauthprovider"}}} \ No newline at end of file +{"sections":[],"kind":"symbol","metadata":{"externalID":"s:5Auth015WebAuthProvidera","modules":[{"name":"Auth0"}],"title":"WebAuthProvider","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthProvider","kind":"identifier"}],"roleHeading":"Type Alias","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"WebAuthProvider"}],"symbolKind":"typealias"},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProvider","interfaceLanguage":"swift"},"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/github.com\/auth0\/Auth0.swift\/blob\/master\/Auth0\/SafariProvider.swift"],"anchor":"Related-Documentation"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauthprovider"]}],"schemaVersion":{"major":0,"patch":0,"minor":3},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthProvider","kind":"identifier"},{"text":" = (","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"url","kind":"internalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation3URLV","text":"URL","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"callback","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"@escaping","kind":"attribute"},{"text":" ","kind":"text"},{"preciseIdentifier":"s:5Auth023WebAuthProviderCallbacka","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProviderCallback","text":"WebAuthProviderCallback","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:5Auth016WebAuthUserAgentP","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","text":"WebAuthUserAgent","kind":"typeIdentifier"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"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"},{"text":" to perform a web-based operation.","type":"text"},{"text":" ","type":"text"},{"text":"The ","type":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","isActive":true,"type":"reference"},{"text":" opens the URL in an external user agent and then invokes the callback when done.","type":"text"}],"references":{"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","title":"Example","titleInlineContent":[{"text":"Example","type":"text"}],"identifier":"https:\/\/github.com\/auth0\/Auth0.swift\/blob\/master\/Auth0\/SafariProvider.swift"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthProvider":{"role":"symbol","title":"WebAuthProvider","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthProvider"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuthProvider"}],"abstract":[{"type":"text","text":"Thunk that returns a function that creates and returns a "},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","isActive":true,"type":"reference"},{"text":" to perform a web-based operation.","type":"text"},{"type":"text","text":" "},{"type":"text","text":"The "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","isActive":true},{"text":" opens the URL in an external user agent and then invokes the callback when done.","type":"text"}],"kind":"symbol","url":"\/documentation\/auth0\/webauthprovider","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProvider","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent":{"kind":"symbol","abstract":[{"type":"text","text":"The external user agent used to perform a web-based operation."}],"type":"topic","url":"\/documentation\/auth0\/webauthuseragent","title":"WebAuthUserAgent","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthUserAgent"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","navigatorTitle":[{"kind":"identifier","text":"WebAuthUserAgent"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthProviderCallback":{"title":"WebAuthProviderCallback","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProviderCallback","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthProviderCallback"}],"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"}],"url":"\/documentation\/auth0\/webauthprovidercallback","navigatorTitle":[{"kind":"identifier","text":"WebAuthProviderCallback"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"}}} \ No newline at end of file diff --git a/docs/data/documentation/auth0/webauthprovidercallback.json b/docs/data/documentation/auth0/webauthprovidercallback.json index ad78eb198..ecad921fe 100644 --- a/docs/data/documentation/auth0/webauthprovidercallback.json +++ b/docs/data/documentation/auth0/webauthprovidercallback.json @@ -1 +1 @@ -{"abstract":[{"type":"text","text":"Callback invoked by the "},{"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","isActive":true},{"type":"text","text":" when the web-based operation concludes."}],"variants":[{"paths":["\/documentation\/auth0\/webauthprovidercallback"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthProviderCallback","kind":"identifier"},{"text":" = (","kind":"text"},{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult","text":"WebAuthResult","kind":"typeIdentifier","preciseIdentifier":"s:5Auth013WebAuthResulta"},{"text":"<","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"},{"text":">) -> ","kind":"text"},{"text":"Void","kind":"typeIdentifier","preciseIdentifier":"s:s4Voida"}],"platforms":["iOS"],"languages":["swift"]}],"kind":"declarations"}],"sections":[],"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProviderCallback"},"schemaVersion":{"major":0,"patch":0,"minor":3},"metadata":{"fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthProviderCallback","kind":"identifier"}],"title":"WebAuthProviderCallback","externalID":"s:5Auth023WebAuthProviderCallbacka","symbolKind":"typealias","role":"symbol","navigatorTitle":[{"text":"WebAuthProviderCallback","kind":"identifier"}],"modules":[{"name":"Auth0"}],"roleHeading":"Type Alias"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthProviderCallback":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProviderCallback","url":"\/documentation\/auth0\/webauthprovidercallback","role":"symbol","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthProviderCallback"}],"navigatorTitle":[{"kind":"identifier","text":"WebAuthProviderCallback"}],"type":"topic","abstract":[{"type":"text","text":"Callback invoked by the "},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent"},{"type":"text","text":" when the web-based operation concludes."}],"title":"WebAuthProviderCallback","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthResult":{"url":"\/documentation\/auth0\/webauthresult","navigatorTitle":[{"text":"WebAuthResult","kind":"identifier"}],"title":"WebAuthResult","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult","abstract":[{"code":"Result","type":"codeVoice"},{"text":" wrapper for Web Auth operations.","type":"text"}],"type":"topic","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthResult","kind":"identifier"}],"kind":"symbol","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent":{"title":"WebAuthUserAgent","url":"\/documentation\/auth0\/webauthuseragent","navigatorTitle":[{"kind":"identifier","text":"WebAuthUserAgent"}],"abstract":[{"type":"text","text":"The external user agent used to perform a web-based operation."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","kind":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthUserAgent"}],"role":"symbol"}}} \ No newline at end of file +{"metadata":{"symbolKind":"typealias","roleHeading":"Type Alias","externalID":"s:5Auth023WebAuthProviderCallbacka","title":"WebAuthProviderCallback","modules":[{"name":"Auth0"}],"fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthProviderCallback","kind":"identifier"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"WebAuthProviderCallback"}]},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauthprovidercallback"]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProviderCallback","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"type":"text","text":"Callback invoked by the "},{"isActive":true,"type":"reference","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent"},{"type":"text","text":" when the web-based operation concludes."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthProviderCallback","kind":"identifier"},{"text":" = (","kind":"text"},{"text":"WebAuthResult","preciseIdentifier":"s:5Auth013WebAuthResulta","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"Void","preciseIdentifier":"s:s4Voida","kind":"typeIdentifier"},{"text":">) -> ","kind":"text"},{"text":"Void","preciseIdentifier":"s:s4Voida","kind":"typeIdentifier"}],"platforms":["iOS"],"languages":["swift"]}]}],"schemaVersion":{"patch":0,"minor":3,"major":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent":{"kind":"symbol","abstract":[{"type":"text","text":"The external user agent used to perform a web-based operation."}],"type":"topic","url":"\/documentation\/auth0\/webauthuseragent","title":"WebAuthUserAgent","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthUserAgent"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","navigatorTitle":[{"kind":"identifier","text":"WebAuthUserAgent"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthResult":{"url":"\/documentation\/auth0\/webauthresult","title":"WebAuthResult","abstract":[{"code":"Result","type":"codeVoice"},{"type":"text","text":" wrapper for Web Auth operations."}],"navigatorTitle":[{"text":"WebAuthResult","kind":"identifier"}],"fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthResult","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthProviderCallback":{"title":"WebAuthProviderCallback","type":"topic","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthProviderCallback","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthProviderCallback"}],"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"}],"url":"\/documentation\/auth0\/webauthprovidercallback","navigatorTitle":[{"kind":"identifier","text":"WebAuthProviderCallback"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"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 cc28df2e1..13da6ae6b 100644 --- a/docs/data/documentation/auth0/webauthresult.json +++ b/docs/data/documentation/auth0/webauthresult.json @@ -1 +1 @@ -{"metadata":{"externalID":"s:5Auth013WebAuthResulta","symbolKind":"typealias","role":"symbol","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthResult","kind":"identifier"}],"modules":[{"name":"Auth0"}],"navigatorTitle":[{"text":"WebAuthResult","kind":"identifier"}],"roleHeading":"Type Alias","title":"WebAuthResult"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult"},"sections":[],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"schemaVersion":{"minor":3,"patch":0,"major":0},"kind":"symbol","abstract":[{"type":"codeVoice","code":"Result"},{"type":"text","text":" wrapper for Web Auth operations."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauthresult"]}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthResult","kind":"identifier"},{"text":"<","kind":"text"},{"text":"T","kind":"genericParameter"},{"text":"> = ","kind":"text"},{"text":"Result","preciseIdentifier":"s:s6ResultO","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"T","preciseIdentifier":"s:5Auth013WebAuthResulta1Txmfp","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"WebAuthError","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","preciseIdentifier":"s:5Auth012WebAuthErrorV","kind":"typeIdentifier"},{"text":">","kind":"text"}],"languages":["swift"]}],"kind":"declarations"}],"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthResult":{"url":"\/documentation\/auth0\/webauthresult","navigatorTitle":[{"text":"WebAuthResult","kind":"identifier"}],"title":"WebAuthResult","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult","abstract":[{"code":"Result","type":"codeVoice"},{"text":" wrapper for Web Auth operations.","type":"text"}],"type":"topic","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthResult","kind":"identifier"}],"kind":"symbol","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"abstract":[{"text":"Represents an error during a Web Auth operation.","type":"text"}],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthError","kind":"identifier"}],"type":"topic","role":"symbol","navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","title":"WebAuthError","url":"\/documentation\/auth0\/webautherror"}}} \ No newline at end of file +{"metadata":{"symbolKind":"typealias","title":"WebAuthResult","externalID":"s:5Auth013WebAuthResulta","roleHeading":"Type Alias","modules":[{"name":"Auth0"}],"fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthResult"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"WebAuthResult"}]},"sections":[],"variants":[{"paths":["\/documentation\/auth0\/webauthresult"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult","interfaceLanguage":"swift"},"kind":"symbol","abstract":[{"type":"codeVoice","code":"Result"},{"type":"text","text":" wrapper for Web Auth operations."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthResult"},{"kind":"text","text":"<"},{"kind":"genericParameter","text":"T"},{"kind":"text","text":"> = "},{"preciseIdentifier":"s:s6ResultO","kind":"typeIdentifier","text":"Result"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:5Auth013WebAuthResulta1Txmfp","kind":"typeIdentifier","text":"T"},{"kind":"text","text":", "},{"preciseIdentifier":"s:5Auth012WebAuthErrorV","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","kind":"typeIdentifier","text":"WebAuthError"},{"kind":"text","text":">"}]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthResult":{"url":"\/documentation\/auth0\/webauthresult","title":"WebAuthResult","abstract":[{"code":"Result","type":"codeVoice"},{"type":"text","text":" wrapper for Web Auth operations."}],"navigatorTitle":[{"text":"WebAuthResult","kind":"identifier"}],"fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthResult","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthError":{"url":"\/documentation\/auth0\/webautherror","abstract":[{"type":"text","text":"Represents an error during a Web Auth operation."}],"title":"WebAuthError","navigatorTitle":[{"text":"WebAuthError","kind":"identifier"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthError"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthError","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"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 f1bcdc996..bacd3c0da 100644 --- a/docs/data/documentation/auth0/webauthuseragent.json +++ b/docs/data/documentation/auth0/webauthuseragent.json @@ -1 +1 @@ -{"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","interfaceLanguage":"swift"},"sections":[],"abstract":[{"type":"text","text":"The external user agent used to perform a web-based operation."}],"kind":"symbol","schemaVersion":{"patch":0,"minor":3,"major":0},"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"metadata":{"role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthUserAgent"}],"modules":[{"name":"Auth0"}],"title":"WebAuthUserAgent","symbolKind":"protocol","roleHeading":"Protocol","navigatorTitle":[{"kind":"identifier","text":"WebAuthUserAgent"}],"externalID":"s:5Auth016WebAuthUserAgentP"},"topicSections":[{"anchor":"Instance-Methods","generated":true,"identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent\/finish(with:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent\/start()"],"title":"Instance Methods"}],"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthUserAgent"}]}],"kind":"declarations"}],"seeAlsoSections":[{"anchor":"Related-Documentation","identifiers":["https:\/\/github.com\/auth0\/Auth0.swift\/blob\/master\/Auth0\/SafariProvider.swift"],"title":"Related Documentation"}],"variants":[{"paths":["\/documentation\/auth0\/webauthuseragent"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent/finish(with:)":{"role":"symbol","url":"\/documentation\/auth0\/webauthuseragent\/finish(with:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent\/finish(with:)","title":"finish(with:)","kind":"symbol","type":"topic","abstract":[{"type":"text","text":"Tears down the external user agent after the web-based operation completed, if needed."},{"type":"text","text":" "},{"type":"text","text":"Auth0.swift will call this method after the callback URL was received and processed, or after the user"},{"type":"text","text":" "},{"type":"text","text":"cancelled the operation, or after any other error occurred."}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"finish","kind":"identifier"},{"text":"(","kind":"text"},{"text":"with","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"WebAuthResult","preciseIdentifier":"s:5Auth013WebAuthResulta","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"Void","preciseIdentifier":"s:s4Voida","kind":"typeIdentifier"},{"text":">)","kind":"text"}],"required":true},"https://github.com/auth0/Auth0.swift/blob/master/Auth0/SafariProvider.swift":{"identifier":"https:\/\/github.com\/auth0\/Auth0.swift\/blob\/master\/Auth0\/SafariProvider.swift","type":"link","title":"Example","url":"https:\/\/github.com\/auth0\/Auth0.swift\/blob\/master\/Auth0\/SafariProvider.swift","titleInlineContent":[{"type":"text","text":"Example"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent/start()":{"title":"start()","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent\/start()","type":"topic","role":"symbol","url":"\/documentation\/auth0\/webauthuseragent\/start()","kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"start"},{"kind":"text","text":"()"}],"abstract":[{"type":"text","text":"Starts the external user agent."}],"required":true},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent":{"title":"WebAuthUserAgent","url":"\/documentation\/auth0\/webauthuseragent","navigatorTitle":[{"kind":"identifier","text":"WebAuthUserAgent"}],"abstract":[{"type":"text","text":"The external user agent used to perform a web-based operation."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","kind":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthUserAgent"}],"role":"symbol"}}} \ No newline at end of file +{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauthuseragent"]}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0"]]},"abstract":[{"text":"The external user agent used to perform a web-based operation.","type":"text"}],"topicSections":[{"title":"Instance Methods","identifiers":["doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent\/finish(with:)","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent\/start()"],"anchor":"Instance-Methods","generated":true}],"kind":"symbol","schemaVersion":{"minor":3,"major":0,"patch":0},"sections":[],"seeAlsoSections":[{"title":"Related Documentation","identifiers":["https:\/\/github.com\/auth0\/Auth0.swift\/blob\/master\/Auth0\/SafariProvider.swift"],"anchor":"Related-Documentation"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthUserAgent","kind":"identifier"}],"platforms":["iOS"],"languages":["swift"]}]}],"metadata":{"externalID":"s:5Auth016WebAuthUserAgentP","symbolKind":"protocol","title":"WebAuthUserAgent","roleHeading":"Protocol","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthUserAgent","kind":"identifier"}],"navigatorTitle":[{"text":"WebAuthUserAgent","kind":"identifier"}],"modules":[{"name":"Auth0"}]},"identifier":{"url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","interfaceLanguage":"swift"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"https://github.com/auth0/Auth0.swift/blob/master/Auth0/SafariProvider.swift":{"title":"Example","type":"link","identifier":"https:\/\/github.com\/auth0\/Auth0.swift\/blob\/master\/Auth0\/SafariProvider.swift","titleInlineContent":[{"text":"Example","type":"text"}],"url":"https:\/\/github.com\/auth0\/Auth0.swift\/blob\/master\/Auth0\/SafariProvider.swift"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent":{"kind":"symbol","abstract":[{"type":"text","text":"The external user agent used to perform a web-based operation."}],"type":"topic","url":"\/documentation\/auth0\/webauthuseragent","title":"WebAuthUserAgent","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthUserAgent"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","navigatorTitle":[{"kind":"identifier","text":"WebAuthUserAgent"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent/start()":{"type":"topic","title":"start()","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent\/start()","kind":"symbol","abstract":[{"type":"text","text":"Starts the external user agent."}],"url":"\/documentation\/auth0\/webauthuseragent\/start()","required":true,"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"start"},{"kind":"text","text":"()"}]},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent/finish(with:)":{"url":"\/documentation\/auth0\/webauthuseragent\/finish(with:)","required":true,"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"finish"},{"kind":"text","text":"("},{"kind":"externalParam","text":"with"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth013WebAuthResulta","kind":"typeIdentifier","text":"WebAuthResult"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:s4Voida","kind":"typeIdentifier","text":"Void"},{"kind":"text","text":">)"}],"title":"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"},{"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.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent\/finish(with:)","kind":"symbol"}}} \ 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 c45de1e91..a856e8ced 100644 --- a/docs/data/documentation/auth0/webauthuseragent/finish(with:).json +++ b/docs/data/documentation/auth0/webauthuseragent/finish(with:).json @@ -1 +1 @@ -{"abstract":[{"text":"Tears down the external user agent after the web-based operation completed, if needed.","type":"text"},{"text":" ","type":"text"},{"text":"Auth0.swift will call this method after the callback URL was received and processed, or after the user","type":"text"},{"text":" ","type":"text"},{"text":"cancelled the operation, or after any other error occurred.","type":"text"}],"metadata":{"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","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":"<"},{"kind":"typeIdentifier","preciseIdentifier":"s:s4Voida","text":"Void"},{"kind":"text","text":">)"}],"roleHeading":"Instance Method","symbolKind":"method","modules":[{"name":"Auth0"}],"title":"finish(with:)","role":"symbol","required":true,"externalID":"s:5Auth016WebAuthUserAgentP6finish4withys6ResultOyytAA0bC5ErrorVG_tF"},"primaryContentSections":[{"declarations":[{"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"finish","kind":"identifier"},{"text":"(","kind":"text"},{"text":"with","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"result","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"WebAuthResult","preciseIdentifier":"s:5Auth013WebAuthResulta","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"Void","preciseIdentifier":"s:s4Voida","kind":"typeIdentifier"},{"text":">)","kind":"text"}],"languages":["swift"]}],"kind":"declarations"},{"parameters":[{"name":"result","content":[{"type":"paragraph","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."}]}]}],"kind":"parameters"}],"variants":[{"paths":["\/documentation\/auth0\/webauthuseragent\/finish(with:)"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"schemaVersion":{"minor":3,"major":0,"patch":0},"kind":"symbol","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"]]},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthResult":{"url":"\/documentation\/auth0\/webauthresult","navigatorTitle":[{"text":"WebAuthResult","kind":"identifier"}],"title":"WebAuthResult","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult","abstract":[{"code":"Result","type":"codeVoice"},{"text":" wrapper for Web Auth operations.","type":"text"}],"type":"topic","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthResult","kind":"identifier"}],"kind":"symbol","role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent":{"title":"WebAuthUserAgent","url":"\/documentation\/auth0\/webauthuseragent","navigatorTitle":[{"kind":"identifier","text":"WebAuthUserAgent"}],"abstract":[{"type":"text","text":"The external user agent used to perform a web-based operation."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","kind":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthUserAgent"}],"role":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent/finish(with:)":{"role":"symbol","url":"\/documentation\/auth0\/webauthuseragent\/finish(with:)","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent\/finish(with:)","title":"finish(with:)","kind":"symbol","type":"topic","abstract":[{"type":"text","text":"Tears down the external user agent after the web-based operation completed, if needed."},{"type":"text","text":" "},{"type":"text","text":"Auth0.swift will call this method after the callback URL was received and processed, or after the user"},{"type":"text","text":" "},{"type":"text","text":"cancelled the operation, or after any other error occurred."}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"finish","kind":"identifier"},{"text":"(","kind":"text"},{"text":"with","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"WebAuthResult","preciseIdentifier":"s:5Auth013WebAuthResulta","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"text":"Void","preciseIdentifier":"s:s4Voida","kind":"typeIdentifier"},{"text":">)","kind":"text"}],"required":true}}} \ No newline at end of file +{"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"finish","kind":"identifier"},{"text":"(","kind":"text"},{"text":"with","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"result","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"WebAuthResult","preciseIdentifier":"s:5Auth013WebAuthResulta","kind":"typeIdentifier","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult"},{"text":"<","kind":"text"},{"text":"Void","preciseIdentifier":"s:s4Voida","kind":"typeIdentifier"},{"text":">)","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]},{"parameters":[{"name":"result","content":[{"inlineContent":[{"text":"The outcome of the web-based operation, containing either an empty success case or an","type":"text"},{"text":" ","type":"text"},{"text":"error.","type":"text"}],"type":"paragraph"}]}],"kind":"parameters"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauthuseragent\/finish(with:)"]}],"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"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\/finish(with:)"},"abstract":[{"type":"text","text":"Tears down the external user agent after the web-based operation completed, if needed."},{"type":"text","text":" "},{"type":"text","text":"Auth0.swift will call this method after the callback URL was received and processed, or after the user"},{"type":"text","text":" "},{"type":"text","text":"cancelled the operation, or after any other error occurred."}],"metadata":{"externalID":"s:5Auth016WebAuthUserAgentP6finish4withys6ResultOyytAA0bC5ErrorVG_tF","modules":[{"name":"Auth0"}],"title":"finish(with:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"finish","kind":"identifier"},{"text":"(","kind":"text"},{"text":"with","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:5Auth013WebAuthResulta","text":"WebAuthResult","kind":"typeIdentifier"},{"text":"<","kind":"text"},{"preciseIdentifier":"s:s4Voida","text":"Void","kind":"typeIdentifier"},{"text":">)","kind":"text"}],"roleHeading":"Instance Method","role":"symbol","required":true,"symbolKind":"method"},"references":{"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent/finish(with:)":{"url":"\/documentation\/auth0\/webauthuseragent\/finish(with:)","required":true,"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"finish"},{"kind":"text","text":"("},{"kind":"externalParam","text":"with"},{"kind":"text","text":": "},{"preciseIdentifier":"s:5Auth013WebAuthResulta","kind":"typeIdentifier","text":"WebAuthResult"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:s4Voida","kind":"typeIdentifier","text":"Void"},{"kind":"text","text":">)"}],"title":"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"},{"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.","type":"text"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent\/finish(with:)","kind":"symbol"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthResult":{"url":"\/documentation\/auth0\/webauthresult","title":"WebAuthResult","abstract":[{"code":"Result","type":"codeVoice"},{"type":"text","text":" wrapper for Web Auth operations."}],"navigatorTitle":[{"text":"WebAuthResult","kind":"identifier"}],"fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"WebAuthResult","kind":"identifier"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthResult","role":"symbol","kind":"symbol","type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent":{"kind":"symbol","abstract":[{"type":"text","text":"The external user agent used to perform a web-based operation."}],"type":"topic","url":"\/documentation\/auth0\/webauthuseragent","title":"WebAuthUserAgent","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthUserAgent"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","navigatorTitle":[{"kind":"identifier","text":"WebAuthUserAgent"}]}}} \ 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 2479e81eb..2fdd6647a 100644 --- a/docs/data/documentation/auth0/webauthuseragent/start().json +++ b/docs/data/documentation/auth0/webauthuseragent/start().json @@ -1 +1 @@ -{"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent"]]},"abstract":[{"type":"text","text":"Starts the external user agent."}],"kind":"symbol","sections":[],"schemaVersion":{"patch":0,"minor":3,"major":0},"metadata":{"modules":[{"name":"Auth0"}],"required":true,"title":"start()","roleHeading":"Instance Method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"start","kind":"identifier"},{"text":"()","kind":"text"}],"role":"symbol","externalID":"s:5Auth016WebAuthUserAgentP5startyyF","symbolKind":"method"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent\/start()"},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["iOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"start","kind":"identifier"},{"text":"()","kind":"text"}]}],"kind":"declarations"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauthuseragent\/start()"]}],"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent/start()":{"title":"start()","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent\/start()","type":"topic","role":"symbol","url":"\/documentation\/auth0\/webauthuseragent\/start()","kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"start"},{"kind":"text","text":"()"}],"abstract":[{"type":"text","text":"Starts the external user agent."}],"required":true},"doc://com.auth0.Auth0/documentation/Auth0":{"kind":"symbol","url":"\/documentation\/auth0","role":"collection","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic","title":"Auth0"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent":{"title":"WebAuthUserAgent","url":"\/documentation\/auth0\/webauthuseragent","navigatorTitle":[{"kind":"identifier","text":"WebAuthUserAgent"}],"abstract":[{"type":"text","text":"The external user agent used to perform a web-based operation."}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","kind":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthUserAgent"}],"role":"symbol"}}} \ No newline at end of file +{"metadata":{"symbolKind":"method","roleHeading":"Instance Method","externalID":"s:5Auth016WebAuthUserAgentP5startyyF","title":"start()","modules":[{"name":"Auth0"}],"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"start","kind":"identifier"},{"text":"()","kind":"text"}],"role":"symbol","required":true},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/auth0\/webauthuseragent\/start()"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent\/start()"},"kind":"symbol","abstract":[{"type":"text","text":"Starts the external user agent."}],"hierarchy":{"paths":[["doc:\/\/com.auth0.Auth0\/documentation\/Auth0","doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"start","kind":"identifier"},{"text":"()","kind":"text"}],"languages":["swift"],"platforms":["iOS"]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"references":{"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent/start()":{"type":"topic","title":"start()","identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent\/start()","kind":"symbol","abstract":[{"type":"text","text":"Starts the external user agent."}],"url":"\/documentation\/auth0\/webauthuseragent\/start()","required":true,"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"start"},{"kind":"text","text":"()"}]},"doc://com.auth0.Auth0/documentation/Auth0":{"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0","kind":"symbol","title":"Auth0","role":"collection","url":"\/documentation\/auth0","abstract":[{"type":"text","text":"SDK for Apple platforms."}],"type":"topic"},"doc://com.auth0.Auth0/documentation/Auth0/WebAuthUserAgent":{"kind":"symbol","abstract":[{"type":"text","text":"The external user agent used to perform a web-based operation."}],"type":"topic","url":"\/documentation\/auth0\/webauthuseragent","title":"WebAuthUserAgent","role":"symbol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"WebAuthUserAgent"}],"identifier":"doc:\/\/com.auth0.Auth0\/documentation\/Auth0\/WebAuthUserAgent","navigatorTitle":[{"kind":"identifier","text":"WebAuthUserAgent"}]}}} \ No newline at end of file diff --git a/docs/documentation/auth0/apicredentials/init(from:)/index.html b/docs/documentation/auth0/apicredentials/init(from:)-5sa91/index.html similarity index 100% rename from docs/documentation/auth0/apicredentials/init(from:)/index.html rename to docs/documentation/auth0/apicredentials/init(from:)-5sa91/index.html diff --git a/docs/documentation/auth0/authentication/customtokenexchange(subjecttoken:subjecttokentype:audience:scope:)-10iff/index.html b/docs/documentation/auth0/apicredentials/init(from:)-8e5ds/index.html similarity index 100% rename from docs/documentation/auth0/authentication/customtokenexchange(subjecttoken:subjecttokentype:audience:scope:)-10iff/index.html rename to docs/documentation/auth0/apicredentials/init(from:)-8e5ds/index.html diff --git a/docs/documentation/auth0/authentication/customtokenexchange(subjecttoken:subjecttokentype:audience:scope:)/index.html b/docs/documentation/auth0/authentication/customtokenexchange(subjecttoken:subjecttokentype:audience:scope:organization:)-5dzwp/index.html similarity index 100% rename from docs/documentation/auth0/authentication/customtokenexchange(subjecttoken:subjecttokentype:audience:scope:)/index.html rename to docs/documentation/auth0/authentication/customtokenexchange(subjecttoken:subjecttokentype:audience:scope:organization:)-5dzwp/index.html diff --git a/docs/documentation/auth0/credentialsmanager/clear(foraudience:)/index.html b/docs/documentation/auth0/authentication/customtokenexchange(subjecttoken:subjecttokentype:audience:scope:organization:)/index.html similarity index 100% rename from docs/documentation/auth0/credentialsmanager/clear(foraudience:)/index.html rename to docs/documentation/auth0/authentication/customtokenexchange(subjecttoken:subjecttokentype:audience:scope:organization:)/index.html diff --git a/docs/documentation/auth0/credentialsmanager/enablebiometrics(withtitle:canceltitle:fallbacktitle:evaluationpolicy:)/index.html b/docs/documentation/auth0/authenticationerror/message/index.html similarity index 100% rename from docs/documentation/auth0/credentialsmanager/enablebiometrics(withtitle:canceltitle:fallbacktitle:evaluationpolicy:)/index.html rename to docs/documentation/auth0/authenticationerror/message/index.html diff --git a/docs/documentation/auth0/biometricpolicy/always/index.html b/docs/documentation/auth0/biometricpolicy/always/index.html new file mode 100644 index 000000000..2a1a940a2 --- /dev/null +++ b/docs/documentation/auth0/biometricpolicy/always/index.html @@ -0,0 +1 @@ +Documentation
\ No newline at end of file diff --git a/docs/documentation/auth0/biometricpolicy/applifecycle(timeoutinseconds:)/index.html b/docs/documentation/auth0/biometricpolicy/applifecycle(timeoutinseconds:)/index.html new file mode 100644 index 000000000..2a1a940a2 --- /dev/null +++ b/docs/documentation/auth0/biometricpolicy/applifecycle(timeoutinseconds:)/index.html @@ -0,0 +1 @@ +Documentation
\ No newline at end of file diff --git a/docs/documentation/auth0/biometricpolicy/default/index.html b/docs/documentation/auth0/biometricpolicy/default/index.html new file mode 100644 index 000000000..2a1a940a2 --- /dev/null +++ b/docs/documentation/auth0/biometricpolicy/default/index.html @@ -0,0 +1 @@ +Documentation
\ No newline at end of file diff --git a/docs/documentation/auth0/biometricpolicy/index.html b/docs/documentation/auth0/biometricpolicy/index.html new file mode 100644 index 000000000..2a1a940a2 --- /dev/null +++ b/docs/documentation/auth0/biometricpolicy/index.html @@ -0,0 +1 @@ +Documentation
\ No newline at end of file diff --git a/docs/documentation/auth0/biometricpolicy/session(timeoutinseconds:)/index.html b/docs/documentation/auth0/biometricpolicy/session(timeoutinseconds:)/index.html new file mode 100644 index 000000000..2a1a940a2 --- /dev/null +++ b/docs/documentation/auth0/biometricpolicy/session(timeoutinseconds:)/index.html @@ -0,0 +1 @@ +Documentation
\ No newline at end of file diff --git a/docs/documentation/auth0/credentialsmanager/clear(foraudience:scope:)/index.html b/docs/documentation/auth0/credentialsmanager/clear(foraudience:scope:)/index.html new file mode 100644 index 000000000..2a1a940a2 --- /dev/null +++ b/docs/documentation/auth0/credentialsmanager/clear(foraudience:scope:)/index.html @@ -0,0 +1 @@ +Documentation
\ No newline at end of file diff --git a/docs/documentation/auth0/credentialsmanager/clearbiometricsession()/index.html b/docs/documentation/auth0/credentialsmanager/clearbiometricsession()/index.html new file mode 100644 index 000000000..2a1a940a2 --- /dev/null +++ b/docs/documentation/auth0/credentialsmanager/clearbiometricsession()/index.html @@ -0,0 +1 @@ +Documentation
\ No newline at end of file diff --git a/docs/documentation/auth0/credentialsmanager/enablebiometrics(withtitle:canceltitle:fallbacktitle:evaluationpolicy:policy:)/index.html b/docs/documentation/auth0/credentialsmanager/enablebiometrics(withtitle:canceltitle:fallbacktitle:evaluationpolicy:policy:)/index.html new file mode 100644 index 000000000..2a1a940a2 --- /dev/null +++ b/docs/documentation/auth0/credentialsmanager/enablebiometrics(withtitle:canceltitle:fallbacktitle:evaluationpolicy:policy:)/index.html @@ -0,0 +1 @@ +Documentation
\ No newline at end of file diff --git a/docs/documentation/auth0/credentialsmanager/isbiometricsessionvalid()/index.html b/docs/documentation/auth0/credentialsmanager/isbiometricsessionvalid()/index.html new file mode 100644 index 000000000..2a1a940a2 --- /dev/null +++ b/docs/documentation/auth0/credentialsmanager/isbiometricsessionvalid()/index.html @@ -0,0 +1 @@ +Documentation
\ No newline at end of file diff --git a/docs/documentation/auth0/credentialsmanager/store(apicredentials:foraudience:forscope:)/index.html b/docs/documentation/auth0/credentialsmanager/store(apicredentials:foraudience:forscope:)/index.html new file mode 100644 index 000000000..2a1a940a2 --- /dev/null +++ b/docs/documentation/auth0/credentialsmanager/store(apicredentials:foraudience:forscope:)/index.html @@ -0,0 +1 @@ +Documentation
\ No newline at end of file diff --git a/docs/documentation/auth0/credentialsmanagererror/message/index.html b/docs/documentation/auth0/credentialsmanagererror/message/index.html new file mode 100644 index 000000000..2a1a940a2 --- /dev/null +++ b/docs/documentation/auth0/credentialsmanagererror/message/index.html @@ -0,0 +1 @@ +Documentation
\ No newline at end of file diff --git a/docs/documentation/auth0/myaccounterror/message/index.html b/docs/documentation/auth0/myaccounterror/message/index.html new file mode 100644 index 000000000..2a1a940a2 --- /dev/null +++ b/docs/documentation/auth0/myaccounterror/message/index.html @@ -0,0 +1 @@ +Documentation
\ No newline at end of file diff --git a/docs/documentation/auth0/myaccounterror/validationerror/detail/index.html b/docs/documentation/auth0/myaccounterror/validationerror/detail/index.html new file mode 100644 index 000000000..2a1a940a2 --- /dev/null +++ b/docs/documentation/auth0/myaccounterror/validationerror/detail/index.html @@ -0,0 +1 @@ +Documentation
\ No newline at end of file diff --git a/docs/documentation/auth0/myaccounterror/validationerror/field/index.html b/docs/documentation/auth0/myaccounterror/validationerror/field/index.html new file mode 100644 index 000000000..2a1a940a2 --- /dev/null +++ b/docs/documentation/auth0/myaccounterror/validationerror/field/index.html @@ -0,0 +1 @@ +Documentation
\ No newline at end of file diff --git a/docs/documentation/auth0/myaccounterror/validationerror/pointer/index.html b/docs/documentation/auth0/myaccounterror/validationerror/pointer/index.html new file mode 100644 index 000000000..2a1a940a2 --- /dev/null +++ b/docs/documentation/auth0/myaccounterror/validationerror/pointer/index.html @@ -0,0 +1 @@ +Documentation
\ No newline at end of file diff --git a/docs/documentation/auth0/myaccounterror/validationerror/source/index.html b/docs/documentation/auth0/myaccounterror/validationerror/source/index.html new file mode 100644 index 000000000..2a1a940a2 --- /dev/null +++ b/docs/documentation/auth0/myaccounterror/validationerror/source/index.html @@ -0,0 +1 @@ +Documentation
\ No newline at end of file diff --git a/docs/documentation/auth0/passkeyauthenticationmethod/aaguid/index.html b/docs/documentation/auth0/passkeyauthenticationmethod/aaguid/index.html new file mode 100644 index 000000000..2a1a940a2 --- /dev/null +++ b/docs/documentation/auth0/passkeyauthenticationmethod/aaguid/index.html @@ -0,0 +1 @@ +Documentation
\ No newline at end of file diff --git a/docs/documentation/auth0/passkeyauthenticationmethod/relyingpartyidentifier/index.html b/docs/documentation/auth0/passkeyauthenticationmethod/relyingpartyidentifier/index.html new file mode 100644 index 000000000..2a1a940a2 --- /dev/null +++ b/docs/documentation/auth0/passkeyauthenticationmethod/relyingpartyidentifier/index.html @@ -0,0 +1 @@ +Documentation
\ No newline at end of file diff --git a/docs/documentation/auth0/requestable/errortype/index.html b/docs/documentation/auth0/requestable/errortype/index.html new file mode 100644 index 000000000..2a1a940a2 --- /dev/null +++ b/docs/documentation/auth0/requestable/errortype/index.html @@ -0,0 +1 @@ +Documentation
\ No newline at end of file diff --git a/docs/documentation/auth0/requestable/index.html b/docs/documentation/auth0/requestable/index.html new file mode 100644 index 000000000..2a1a940a2 --- /dev/null +++ b/docs/documentation/auth0/requestable/index.html @@ -0,0 +1 @@ +Documentation
\ No newline at end of file diff --git a/docs/documentation/auth0/requestable/resulttype/index.html b/docs/documentation/auth0/requestable/resulttype/index.html new file mode 100644 index 000000000..2a1a940a2 --- /dev/null +++ b/docs/documentation/auth0/requestable/resulttype/index.html @@ -0,0 +1 @@ +Documentation
\ No newline at end of file diff --git a/docs/documentation/auth0/requestable/start(_:)/index.html b/docs/documentation/auth0/requestable/start(_:)/index.html new file mode 100644 index 000000000..2a1a940a2 --- /dev/null +++ b/docs/documentation/auth0/requestable/start(_:)/index.html @@ -0,0 +1 @@ +Documentation
\ No newline at end of file diff --git a/docs/documentation/auth0/webautherror/message/index.html b/docs/documentation/auth0/webautherror/message/index.html new file mode 100644 index 000000000..2a1a940a2 --- /dev/null +++ b/docs/documentation/auth0/webautherror/message/index.html @@ -0,0 +1 @@ +Documentation
\ No newline at end of file diff --git a/docs/index/availability.index b/docs/index/availability.index index c31d02f6f..7e73e2c39 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 41fd32011..985cc69ac 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 f11afefd5..ac5b57715 100644 --- a/docs/index/index.json +++ b/docs/index/index.json @@ -1 +1 @@ -{"includedArchiveIdentifiers":["com.auth0.Auth0"],"interfaceLanguages":{"swift":[{"children":[{"title":"Articles","type":"groupMarker"},{"path":"\/documentation\/auth0\/useragents","title":"ASWebAuthenticationSession vs SFSafariViewController (iOS)","type":"article"},{"path":"\/documentation\/auth0\/refreshtokens","title":"Refresh Tokens: Common Errors","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\/isnetworkerror","title":"var isNetworkError: Bool","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-97kwn","title":"var cause: Error?","type":"property"},{"path":"\/documentation\/auth0\/auth0error\/cause-9wuyi","title":"var cause: Error?","type":"property"}],"title":"Auth0Error Implementations","type":"groupMarker"}],"path":"\/documentation\/auth0\/auth0error\/cause","title":"var cause: Error?","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"},{"children":[{"children":[{"path":"\/documentation\/auth0\/authentication\/customtokenexchange(subjecttoken:subjecttokentype:audience:scope:)-10iff","title":"func customTokenExchange(subjectToken: String, subjectTokenType: String, audience: String?, scope: String) -> Request","type":"method"}],"title":"Authentication Implementations","type":"groupMarker"}],"path":"\/documentation\/auth0\/authentication\/customtokenexchange(subjecttoken:subjecttokentype:audience:scope:)","title":"func customTokenExchange(subjectToken: String, subjectTokenType: String, audience: String?, scope: 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:)","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:)","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:)","title":"func login(facebookSessionAccessToken: String, profile: [String : Any], audience: String?, scope: String) -> Request","type":"method"},{"children":[{"children":[{"path":"\/documentation\/auth0\/authentication\/login(passkey:challenge:connection:audience:scope:organization:)-59b3j","title":"func login(passkey: SignupPasskey, challenge: PasskeySignupChallenge, connection: String?, audience: String?, scope: String, organization: String?) -> Request","type":"method"},{"path":"\/documentation\/auth0\/authentication\/login(passkey:challenge:connection:audience:scope:organization:)-4e7pl","title":"func login(passkey: LoginPasskey, challenge: PasskeyLoginChallenge, connection: String?, audience: String?, scope: String, organization: String?) -> Request","type":"method"}],"title":"Authentication Implementations","type":"groupMarker"}],"path":"\/documentation\/auth0\/authentication\/login(passkey:challenge:connection:audience:scope:organization:)-1gm8k","title":"func login(passkey: LoginPasskey, challenge: PasskeyLoginChallenge, connection: String?, audience: String?, scope: String, organization: String?) -> Request","type":"method"},{"children":[{"children":[{"path":"\/documentation\/auth0\/authentication\/login(passkey:challenge:connection:audience:scope:organization:)-59b3j","title":"func login(passkey: SignupPasskey, challenge: PasskeySignupChallenge, connection: String?, audience: String?, scope: String, organization: String?) -> Request","type":"method"},{"path":"\/documentation\/auth0\/authentication\/login(passkey:challenge:connection:audience:scope:organization:)-4e7pl","title":"func login(passkey: LoginPasskey, challenge: PasskeyLoginChallenge, connection: String?, audience: String?, scope: String, organization: String?) -> Request","type":"method"}],"title":"Authentication Implementations","type":"groupMarker"}],"path":"\/documentation\/auth0\/authentication\/login(passkey:challenge:connection:audience:scope:organization:)-340n2","title":"func login(passkey: SignupPasskey, challenge: PasskeySignupChallenge, connection: String?, audience: String?, scope: String, organization: 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:)","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:)","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:)","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:)","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:)","title":"func multifactorChallenge(mfaToken: String, types: [String]?, authenticatorId: String?) -> Request","type":"method"},{"children":[{"children":[{"path":"\/documentation\/auth0\/authentication\/passkeyloginchallenge(connection:organization:)-56e54","title":"func passkeyLoginChallenge(connection: String?, organization: String?) -> Request","type":"method"}],"title":"Authentication Implementations","type":"groupMarker"}],"path":"\/documentation\/auth0\/authentication\/passkeyloginchallenge(connection:organization:)","title":"func passkeyLoginChallenge(connection: String?, organization: String?) -> Request","type":"method"},{"children":[{"children":[{"path":"\/documentation\/auth0\/authentication\/passkeysignupchallenge(email:phonenumber:username:name:connection:organization:)-8jlyt","title":"func passkeySignupChallenge(email: String?, phoneNumber: String?, username: String?, name: String?, connection: String?, organization: String?) -> Request","type":"method"}],"title":"Authentication Implementations","type":"groupMarker"}],"path":"\/documentation\/auth0\/authentication\/passkeysignupchallenge(email:phonenumber:username:name:connection:organization:)","title":"func passkeySignupChallenge(email: String?, phoneNumber: String?, username: String?, name: String?, connection: String?, organization: String?) -> Request","type":"method"},{"children":[{"children":[{"path":"\/documentation\/auth0\/authentication\/renew(withrefreshtoken:audience:scope:)-1orlu","title":"func renew(withRefreshToken: String, audience: String?, scope: String?) -> Request","type":"method"}],"title":"Authentication Implementations","type":"groupMarker"}],"path":"\/documentation\/auth0\/authentication\/renew(withrefreshtoken:audience:scope:)","title":"func renew(withRefreshToken: String, audience: 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:)","title":"func signup(email: String, username: String?, password: String, connection: String, userMetadata: [String : Any]?, rootAttributes: [String : Any]?) -> Request","type":"method"},{"path":"\/documentation\/auth0\/authentication\/ssoexchange(withrefreshtoken:)","title":"func ssoExchange(withRefreshToken: String) -> 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:)","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:)","title":"func startPasswordless(phoneNumber: String, type: PasswordlessType, connection: String) -> Request","type":"method"},{"children":[{"children":[{"path":"\/documentation\/auth0\/authentication\/userinfo(withaccesstoken:tokentype:)-i0qu","title":"func userInfo(withAccessToken: String, tokenType: String) -> Request","type":"method"}],"title":"Authentication Implementations","type":"groupMarker"}],"path":"\/documentation\/auth0\/authentication\/userinfo(withaccesstoken:tokentype:)","title":"func userInfo(withAccessToken: String, tokenType: 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\/loginpasskey\/attachment","title":"var attachment: ASAuthorizationPublicKeyCredentialAttachment","type":"property"},{"path":"\/documentation\/auth0\/loginpasskey\/credentialid","title":"var credentialID: Data","type":"property"},{"path":"\/documentation\/auth0\/loginpasskey\/rawauthenticatordata","title":"var rawAuthenticatorData: Data!","type":"property"},{"path":"\/documentation\/auth0\/loginpasskey\/rawclientdatajson","title":"var rawClientDataJSON: Data","type":"property"},{"path":"\/documentation\/auth0\/loginpasskey\/signature","title":"var signature: Data!","type":"property"},{"path":"\/documentation\/auth0\/loginpasskey\/userid","title":"var userID: Data!","type":"property"}],"path":"\/documentation\/auth0\/loginpasskey","title":"LoginPasskey","type":"protocol"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/myaccount\/authenticationmethods","title":"var authenticationMethods: MyAccountAuthenticationMethods","type":"property"},{"title":"Type Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/myaccount\/apiversion","title":"static var apiVersion: String","type":"property"}],"path":"\/documentation\/auth0\/myaccount","title":"MyAccount","type":"protocol"},{"children":[{"title":"Instance Methods","type":"groupMarker"},{"path":"\/documentation\/auth0\/myaccountauthenticationmethods\/confirmemailenrollment(id:authsession:otpcode:)","title":"func confirmEmailEnrollment(id: String, authSession: String, otpCode: String) -> Request","type":"method"},{"path":"\/documentation\/auth0\/myaccountauthenticationmethods\/confirmphoneenrollment(id:authsession:otpcode:)","title":"func confirmPhoneEnrollment(id: String, authSession: String, otpCode: String) -> Request","type":"method"},{"path":"\/documentation\/auth0\/myaccountauthenticationmethods\/confirmpushnotificationenrollment(id:authsession:)","title":"func confirmPushNotificationEnrollment(id: String, authSession: String) -> Request","type":"method"},{"path":"\/documentation\/auth0\/myaccountauthenticationmethods\/confirmrecoverycodeenrollment(id:authsession:)","title":"func confirmRecoveryCodeEnrollment(id: String, authSession: String) -> Request","type":"method"},{"path":"\/documentation\/auth0\/myaccountauthenticationmethods\/confirmtotpenrollment(id:authsession:otpcode:)","title":"func confirmTOTPEnrollment(id: String, authSession: String, otpCode: String) -> Request","type":"method"},{"path":"\/documentation\/auth0\/myaccountauthenticationmethods\/deleteauthenticationmethod(by:)","title":"func deleteAuthenticationMethod(by: String) -> Request","type":"method"},{"path":"\/documentation\/auth0\/myaccountauthenticationmethods\/enroll(passkey:challenge:)","title":"func enroll(passkey: NewPasskey, challenge: PasskeyEnrollmentChallenge) -> Request","type":"method"},{"path":"\/documentation\/auth0\/myaccountauthenticationmethods\/enrollemail(emailaddress:)","title":"func enrollEmail(emailAddress: String) -> Request","type":"method"},{"children":[{"children":[{"path":"\/documentation\/auth0\/myaccountauthenticationmethods\/enrollphone(phonenumber:preferredauthenticationmethod:)-7jrdw","title":"func enrollPhone(phoneNumber: String, preferredAuthenticationMethod: PreferredAuthenticationMethod?) -> Request","type":"method"}],"title":"MyAccountAuthenticationMethods Implementations","type":"groupMarker"}],"path":"\/documentation\/auth0\/myaccountauthenticationmethods\/enrollphone(phonenumber:preferredauthenticationmethod:)","title":"func enrollPhone(phoneNumber: String, preferredAuthenticationMethod: PreferredAuthenticationMethod?) -> Request","type":"method"},{"path":"\/documentation\/auth0\/myaccountauthenticationmethods\/enrollpushnotification()","title":"func enrollPushNotification() -> Request","type":"method"},{"path":"\/documentation\/auth0\/myaccountauthenticationmethods\/enrollrecoverycode()","title":"func enrollRecoveryCode() -> Request","type":"method"},{"path":"\/documentation\/auth0\/myaccountauthenticationmethods\/enrolltotp()","title":"func enrollTOTP() -> Request","type":"method"},{"path":"\/documentation\/auth0\/myaccountauthenticationmethods\/getauthenticationmethod(by:)","title":"func getAuthenticationMethod(by: String) -> Request","type":"method"},{"path":"\/documentation\/auth0\/myaccountauthenticationmethods\/getauthenticationmethods()","title":"func getAuthenticationMethods() -> Request<[AuthenticationMethod], MyAccountError>","type":"method"},{"path":"\/documentation\/auth0\/myaccountauthenticationmethods\/getfactors()","title":"func getFactors() -> Request<[Factor], MyAccountError>","type":"method"},{"children":[{"children":[{"path":"\/documentation\/auth0\/myaccountauthenticationmethods\/passkeyenrollmentchallenge(useridentityid:connection:)-71dk8","title":"func passkeyEnrollmentChallenge(userIdentityId: String?, connection: String?) -> Request","type":"method"}],"title":"MyAccountAuthenticationMethods Implementations","type":"groupMarker"}],"path":"\/documentation\/auth0\/myaccountauthenticationmethods\/passkeyenrollmentchallenge(useridentityid:connection:)","title":"func passkeyEnrollmentChallenge(userIdentityId: String?, connection: String?) -> Request","type":"method"}],"path":"\/documentation\/auth0\/myaccountauthenticationmethods","title":"MyAccountAuthenticationMethods","type":"protocol"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/myaccountclient\/token","title":"var token: String","type":"property"},{"path":"\/documentation\/auth0\/myaccountclient\/url","title":"var url: URL","type":"property"}],"path":"\/documentation\/auth0\/myaccountclient","title":"MyAccountClient","type":"protocol"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/newpasskey\/attachment","title":"var attachment: ASAuthorizationPublicKeyCredentialAttachment","type":"property"},{"path":"\/documentation\/auth0\/newpasskey\/credentialid","title":"var credentialID: Data","type":"property"},{"path":"\/documentation\/auth0\/newpasskey\/rawattestationobject","title":"var rawAttestationObject: Data?","type":"property"},{"path":"\/documentation\/auth0\/newpasskey\/rawclientdatajson","title":"var rawClientDataJSON: Data","type":"property"}],"path":"\/documentation\/auth0\/newpasskey","title":"NewPasskey","type":"protocol"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/senderconstraining\/dpop","title":"var dpop: DPoP?","type":"property"},{"title":"Instance Methods","type":"groupMarker"},{"path":"\/documentation\/auth0\/senderconstraining\/usedpop(keychainidentifier:)","title":"func useDPoP(keychainIdentifier: String) -> Self","type":"method"}],"path":"\/documentation\/auth0\/senderconstraining","title":"SenderConstraining","type":"protocol"},{"path":"\/documentation\/auth0\/signuppasskey","title":"SignupPasskey","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:)","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:)","title":"func link(String, withUser: String, provider: String, connectionId: String?) -> Request<[ManagementObject], ManagementError>","type":"method"},{"path":"\/documentation\/auth0\/users\/patch(_:attributes:)","title":"func patch(String, attributes: UserPatchAttributes) -> Request","type":"method"},{"path":"\/documentation\/auth0\/users\/patch(_:usermetadata:)","title":"func patch(String, userMetadata: [String : Any]) -> Request","type":"method"},{"path":"\/documentation\/auth0\/users\/unlink(identityid:provider:fromuserid:)","title":"func unlink(identityId: String, provider: String, fromUserId: String) -> Request<[ManagementObject], ManagementError>","type":"method"}],"path":"\/documentation\/auth0\/users","title":"Users","type":"protocol"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/webauth\/clientid","title":"var clientId: String","type":"property"},{"path":"\/documentation\/auth0\/webauth\/telemetry","title":"var telemetry: Telemetry","type":"property"},{"path":"\/documentation\/auth0\/webauth\/url","title":"var url: URL","type":"property"},{"title":"Instance Methods","type":"groupMarker"},{"path":"\/documentation\/auth0\/webauth\/audience(_:)","title":"func audience(String) -> Self","type":"method"},{"path":"\/documentation\/auth0\/webauth\/authorizeurl(_:)","title":"func authorizeURL(URL) -> Self","type":"method"},{"children":[{"children":[{"path":"\/documentation\/auth0\/webauth\/clearsession(federated:)-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:)","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\/headers(_:)","title":"func headers([String : 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\/apicredentials\/init(accesstoken:tokentype:expiresin:scope:)","title":"init(accessToken: String, tokenType: String, expiresIn: Date, scope: String)","type":"init"},{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/apicredentials\/accesstoken","title":"let accessToken: String","type":"property"},{"path":"\/documentation\/auth0\/apicredentials\/description","title":"var description: String","type":"property"},{"path":"\/documentation\/auth0\/apicredentials\/expiresin","title":"let expiresIn: Date","type":"property"},{"path":"\/documentation\/auth0\/apicredentials\/scope","title":"let scope: String","type":"property"},{"path":"\/documentation\/auth0\/apicredentials\/tokentype","title":"let tokenType: String","type":"property"},{"title":"Default Implementations","type":"groupMarker"},{"children":[{"title":"Initializers","type":"groupMarker"},{"path":"\/documentation\/auth0\/apicredentials\/init(from:)","title":"init(from: any Decoder) throws","type":"init"}],"path":"\/documentation\/auth0\/apicredentials\/decodable-implementations","title":"Decodable Implementations","type":"symbol"}],"path":"\/documentation\/auth0\/apicredentials","title":"APICredentials","type":"struct"},{"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\/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\/isdpopnoncerequired","title":"var isDPoPNonceRequired: 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\/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\/cause","title":"var cause: Error?","type":"property"},{"path":"\/documentation\/auth0\/authenticationerror\/isnetworkerror","title":"var isNetworkError: Bool","type":"property"}],"path":"\/documentation\/auth0\/authenticationerror\/auth0apierror-implementations","title":"Auth0APIError Implementations","type":"symbol"},{"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\/authenticationmethod\/init(from:)","title":"init(from: any Decoder) throws","type":"init"},{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/authenticationmethod\/confirmed","title":"let confirmed: Bool?","type":"property"},{"path":"\/documentation\/auth0\/authenticationmethod\/createdat","title":"let createdAt: String","type":"property"},{"path":"\/documentation\/auth0\/authenticationmethod\/credentialbackedup","title":"let credentialBackedUp: Bool?","type":"property"},{"path":"\/documentation\/auth0\/authenticationmethod\/credentialdevicetype","title":"let credentialDeviceType: String?","type":"property"},{"path":"\/documentation\/auth0\/authenticationmethod\/id","title":"let id: String","type":"property"},{"path":"\/documentation\/auth0\/authenticationmethod\/identityuserid","title":"let identityUserId: String?","type":"property"},{"path":"\/documentation\/auth0\/authenticationmethod\/keyid","title":"let keyId: String?","type":"property"},{"path":"\/documentation\/auth0\/authenticationmethod\/lastpasswordreset","title":"let lastPasswordReset: String?","type":"property"},{"path":"\/documentation\/auth0\/authenticationmethod\/name","title":"let name: String?","type":"property"},{"path":"\/documentation\/auth0\/authenticationmethod\/phonenumber","title":"let phoneNumber: String?","type":"property"},{"path":"\/documentation\/auth0\/authenticationmethod\/preferredauthenticationmethod","title":"let preferredAuthenticationMethod: String?","type":"property"},{"path":"\/documentation\/auth0\/authenticationmethod\/publickey","title":"let publicKey: String?","type":"property"},{"path":"\/documentation\/auth0\/authenticationmethod\/transports","title":"let transports: [String]?","type":"property"},{"path":"\/documentation\/auth0\/authenticationmethod\/type","title":"let type: String?","type":"property"},{"path":"\/documentation\/auth0\/authenticationmethod\/usage","title":"let usage: [String]","type":"property"},{"path":"\/documentation\/auth0\/authenticationmethod\/useragent","title":"let userAgent: String?","type":"property"},{"path":"\/documentation\/auth0\/authenticationmethod\/userhandle","title":"let userHandle: String?","type":"property"}],"path":"\/documentation\/auth0\/authenticationmethod","title":"AuthenticationMethod","type":"struct"},{"children":[{"title":"Initializers","type":"groupMarker"},{"path":"\/documentation\/auth0\/authenticationmethods\/init(from:)","title":"init(from: any Decoder) throws","type":"init"},{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/authenticationmethods\/authenticationmethods","title":"let authenticationMethods: [AuthenticationMethod]","type":"property"}],"path":"\/documentation\/auth0\/authenticationmethods","title":"AuthenticationMethods","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\/apicredentials(foraudience:scope:minttl:parameters:headers:)-18htb","title":"func apiCredentials(forAudience: String, scope: String?, minTTL: Int, parameters: [String : Any], headers: [String : String]) -> AnyPublisher","type":"method"},{"path":"\/documentation\/auth0\/credentialsmanager\/apicredentials(foraudience:scope:minttl:parameters:headers:)-8lezm","title":"func apiCredentials(forAudience: String, scope: String?, minTTL: Int, parameters: [String : Any], headers: [String : String]) async throws -> APICredentials","type":"method"},{"path":"\/documentation\/auth0\/credentialsmanager\/apicredentials(foraudience:scope:minttl:parameters:headers:callback:)","title":"func apiCredentials(forAudience: String, scope: String?, minTTL: Int, parameters: [String : Any], headers: [String : String], callback: (CredentialsManagerResult) -> Void)","type":"method"},{"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\/clear(foraudience:)","title":"func clear(forAudience: String) -> 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\/ssocredentials(parameters:headers:)-151ni","title":"func ssoCredentials(parameters: [String : Any], headers: [String : String]) -> AnyPublisher","type":"method"},{"path":"\/documentation\/auth0\/credentialsmanager\/ssocredentials(parameters:headers:)-8vdt4","title":"func ssoCredentials(parameters: [String : Any], headers: [String : String]) async throws -> SSOCredentials","type":"method"},{"path":"\/documentation\/auth0\/credentialsmanager\/ssocredentials(parameters:headers:callback:)","title":"func ssoCredentials(parameters: [String : Any], headers: [String : String], callback: (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\/apiexchangefailed","title":"static let apiExchangeFailed: CredentialsManagerError","type":"property"},{"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\/ssoexchangefailed","title":"static let ssoExchangeFailed: 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":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/dpop\/keychainidentifier","title":"let keychainIdentifier: String","type":"property"},{"title":"Type Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/dpop\/defaultkeychainidentifier","title":"static let defaultKeychainIdentifier: String","type":"property"},{"title":"Type Methods","type":"groupMarker"},{"path":"\/documentation\/auth0\/dpop\/addheaders(to:accesstoken:tokentype:nonce:keychainidentifier:)","title":"static func addHeaders(to: inout URLRequest, accessToken: String, tokenType: String, nonce: String?, keychainIdentifier: String) throws(DPoPError)","type":"method"},{"path":"\/documentation\/auth0\/dpop\/clearkeypair(for:)","title":"static func clearKeypair(for: String) throws(DPoPError)","type":"method"},{"path":"\/documentation\/auth0\/dpop\/isnoncerequired(by:)","title":"static func isNonceRequired(by: HTTPURLResponse) -> Bool","type":"method"}],"path":"\/documentation\/auth0\/dpop","title":"DPoP","type":"struct"},{"children":[{"title":"Operators","type":"groupMarker"},{"path":"\/documentation\/auth0\/dpoperror\/~=(_:_:)-2g6ss","title":"static func ~= (DPoPError, Error) -> Bool","type":"op"},{"path":"\/documentation\/auth0\/dpoperror\/~=(_:_:)-8r7xi","title":"static func ~= (DPoPError, DPoPError) -> Bool","type":"op"},{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/dpoperror\/cause","title":"let cause: Error?","type":"property"},{"path":"\/documentation\/auth0\/dpoperror\/debugdescription","title":"var debugDescription: String","type":"property"},{"title":"Type Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/dpoperror\/cryptokitoperationfailed","title":"static let cryptoKitOperationFailed: DPoPError","type":"property"},{"path":"\/documentation\/auth0\/dpoperror\/keychainoperationfailed","title":"static let keychainOperationFailed: DPoPError","type":"property"},{"path":"\/documentation\/auth0\/dpoperror\/other","title":"static let other: DPoPError","type":"property"},{"path":"\/documentation\/auth0\/dpoperror\/seckeyoperationfailed","title":"static let secKeyOperationFailed: DPoPError","type":"property"},{"path":"\/documentation\/auth0\/dpoperror\/secureenclaveoperationfailed","title":"static let secureEnclaveOperationFailed: DPoPError","type":"property"},{"path":"\/documentation\/auth0\/dpoperror\/unknown","title":"static let unknown: DPoPError","type":"property"},{"title":"Default Implementations","type":"groupMarker"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/dpoperror\/errordescription","title":"var errorDescription: String?","type":"property"},{"path":"\/documentation\/auth0\/dpoperror\/localizeddescription","title":"var localizedDescription: String","type":"property"}],"path":"\/documentation\/auth0\/dpoperror\/auth0error-implementations","title":"Auth0Error Implementations","type":"symbol"},{"children":[{"title":"Operators","type":"groupMarker"},{"path":"\/documentation\/auth0\/dpoperror\/!=(_:_:)","title":"static func != (Self, Self) -> Bool","type":"op"},{"path":"\/documentation\/auth0\/dpoperror\/==(_:_:)","title":"static func == (DPoPError, DPoPError) -> Bool","type":"op"}],"path":"\/documentation\/auth0\/dpoperror\/equatable-implementations","title":"Equatable Implementations","type":"symbol"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/dpoperror\/failurereason","title":"var failureReason: String?","type":"property"},{"path":"\/documentation\/auth0\/dpoperror\/helpanchor","title":"var helpAnchor: String?","type":"property"},{"path":"\/documentation\/auth0\/dpoperror\/recoverysuggestion","title":"var recoverySuggestion: String?","type":"property"}],"path":"\/documentation\/auth0\/dpoperror\/localizederror-implementations","title":"LocalizedError Implementations","type":"symbol"}],"path":"\/documentation\/auth0\/dpoperror","title":"DPoPError","type":"struct"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/emailenrollmentchallenge\/authenticationid","title":"let authenticationId: String","type":"property"},{"path":"\/documentation\/auth0\/emailenrollmentchallenge\/authenticationsession","title":"let authenticationSession: String","type":"property"},{"title":"Default Implementations","type":"groupMarker"},{"children":[{"title":"Initializers","type":"groupMarker"},{"path":"\/documentation\/auth0\/emailenrollmentchallenge\/init(from:)","title":"init(from: Decoder) throws","type":"init"}],"path":"\/documentation\/auth0\/emailenrollmentchallenge\/decodable-implementations","title":"Decodable Implementations","type":"symbol"}],"path":"\/documentation\/auth0\/emailenrollmentchallenge","title":"EmailEnrollmentChallenge","type":"struct"},{"children":[{"title":"Initializers","type":"groupMarker"},{"path":"\/documentation\/auth0\/factor\/init(from:)","title":"init(from: any Decoder) throws","type":"init"},{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/factor\/type","title":"let type: String","type":"property"},{"path":"\/documentation\/auth0\/factor\/usage","title":"let usage: [String]?","type":"property"}],"path":"\/documentation\/auth0\/factor","title":"Factor","type":"struct"},{"children":[{"title":"Initializers","type":"groupMarker"},{"path":"\/documentation\/auth0\/factors\/init(from:)","title":"init(from: any Decoder) throws","type":"init"},{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/factors\/factors","title":"let factors: [Factor]","type":"property"}],"path":"\/documentation\/auth0\/factors","title":"Factors","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\/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\/cause","title":"var cause: Error?","type":"property"},{"path":"\/documentation\/auth0\/managementerror\/isnetworkerror","title":"var isNetworkError: Bool","type":"property"}],"path":"\/documentation\/auth0\/managementerror\/auth0apierror-implementations","title":"Auth0APIError Implementations","type":"symbol"},{"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":"Structures","type":"groupMarker"},{"children":[{"title":"Default Implementations","type":"groupMarker"},{"children":[{"title":"Operators","type":"groupMarker"},{"path":"\/documentation\/auth0\/myaccounterror\/validationerror\/!=(_:_:)","title":"static func != (Self, Self) -> Bool","type":"op"}],"path":"\/documentation\/auth0\/myaccounterror\/validationerror\/equatable-implementations","title":"Equatable Implementations","type":"symbol"}],"path":"\/documentation\/auth0\/myaccounterror\/validationerror","title":"MyAccountError.ValidationError","type":"struct"},{"title":"Initializers","type":"groupMarker"},{"path":"\/documentation\/auth0\/myaccounterror\/init(info:statuscode:)","title":"init(info: [String : Any], statusCode: Int)","type":"init"},{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/myaccounterror\/code","title":"let code: String","type":"property"},{"path":"\/documentation\/auth0\/myaccounterror\/debugdescription","title":"var debugDescription: String","type":"property"},{"path":"\/documentation\/auth0\/myaccounterror\/detail","title":"let detail: String","type":"property"},{"path":"\/documentation\/auth0\/myaccounterror\/info","title":"let info: [String : Any]","type":"property"},{"path":"\/documentation\/auth0\/myaccounterror\/statuscode","title":"let statusCode: Int","type":"property"},{"path":"\/documentation\/auth0\/myaccounterror\/title","title":"let title: String","type":"property"},{"path":"\/documentation\/auth0\/myaccounterror\/validationerrors","title":"let validationErrors: [ValidationError]?","type":"property"},{"title":"Default Implementations","type":"groupMarker"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/myaccounterror\/cause","title":"var cause: Error?","type":"property"},{"path":"\/documentation\/auth0\/myaccounterror\/isnetworkerror","title":"var isNetworkError: Bool","type":"property"}],"path":"\/documentation\/auth0\/myaccounterror\/auth0apierror-implementations","title":"Auth0APIError Implementations","type":"symbol"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/myaccounterror\/errordescription","title":"var errorDescription: String?","type":"property"},{"path":"\/documentation\/auth0\/myaccounterror\/localizeddescription","title":"var localizedDescription: String","type":"property"}],"path":"\/documentation\/auth0\/myaccounterror\/auth0error-implementations","title":"Auth0Error Implementations","type":"symbol"},{"children":[{"title":"Operators","type":"groupMarker"},{"path":"\/documentation\/auth0\/myaccounterror\/!=(_:_:)","title":"static func != (Self, Self) -> Bool","type":"op"},{"path":"\/documentation\/auth0\/myaccounterror\/==(_:_:)","title":"static func == (MyAccountError, MyAccountError) -> Bool","type":"op"}],"path":"\/documentation\/auth0\/myaccounterror\/equatable-implementations","title":"Equatable Implementations","type":"symbol"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/myaccounterror\/failurereason","title":"var failureReason: String?","type":"property"},{"path":"\/documentation\/auth0\/myaccounterror\/helpanchor","title":"var helpAnchor: String?","type":"property"},{"path":"\/documentation\/auth0\/myaccounterror\/recoverysuggestion","title":"var recoverySuggestion: String?","type":"property"}],"path":"\/documentation\/auth0\/myaccounterror\/localizederror-implementations","title":"LocalizedError Implementations","type":"symbol"}],"path":"\/documentation\/auth0\/myaccounterror","title":"MyAccountError","type":"struct"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/passkeyauthenticationmethod\/createdat","title":"let createdAt: Date","type":"property"},{"path":"\/documentation\/auth0\/passkeyauthenticationmethod\/credential","title":"let credential: PasskeyCredential","type":"property"},{"path":"\/documentation\/auth0\/passkeyauthenticationmethod\/id","title":"let id: String","type":"property"},{"path":"\/documentation\/auth0\/passkeyauthenticationmethod\/type","title":"let type: String","type":"property"},{"path":"\/documentation\/auth0\/passkeyauthenticationmethod\/useragent","title":"let userAgent: String?","type":"property"},{"path":"\/documentation\/auth0\/passkeyauthenticationmethod\/useridentityid","title":"let userIdentityId: String","type":"property"},{"title":"Default Implementations","type":"groupMarker"},{"children":[{"title":"Initializers","type":"groupMarker"},{"path":"\/documentation\/auth0\/passkeyauthenticationmethod\/init(from:)","title":"init(from: Decoder) throws","type":"init"}],"path":"\/documentation\/auth0\/passkeyauthenticationmethod\/decodable-implementations","title":"Decodable Implementations","type":"symbol"},{"children":[{"title":"Operators","type":"groupMarker"},{"path":"\/documentation\/auth0\/passkeyauthenticationmethod\/!=(_:_:)","title":"static func != (Self, Self) -> Bool","type":"op"}],"path":"\/documentation\/auth0\/passkeyauthenticationmethod\/equatable-implementations","title":"Equatable Implementations","type":"symbol"}],"path":"\/documentation\/auth0\/passkeyauthenticationmethod","title":"PasskeyAuthenticationMethod","type":"struct"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/passkeycredential\/devicetype","title":"let deviceType: PasskeyDeviceType","type":"property"},{"path":"\/documentation\/auth0\/passkeycredential\/id","title":"let id: String","type":"property"},{"path":"\/documentation\/auth0\/passkeycredential\/isbackedup","title":"let isBackedUp: Bool","type":"property"},{"path":"\/documentation\/auth0\/passkeycredential\/publickey","title":"let publicKey: Data","type":"property"},{"path":"\/documentation\/auth0\/passkeycredential\/userhandle","title":"let userHandle: Data","type":"property"},{"title":"Default Implementations","type":"groupMarker"},{"children":[{"title":"Initializers","type":"groupMarker"},{"path":"\/documentation\/auth0\/passkeycredential\/init(from:)","title":"init(from: Decoder) throws","type":"init"}],"path":"\/documentation\/auth0\/passkeycredential\/decodable-implementations","title":"Decodable Implementations","type":"symbol"},{"children":[{"title":"Operators","type":"groupMarker"},{"path":"\/documentation\/auth0\/passkeycredential\/!=(_:_:)","title":"static func != (Self, Self) -> Bool","type":"op"}],"path":"\/documentation\/auth0\/passkeycredential\/equatable-implementations","title":"Equatable Implementations","type":"symbol"}],"path":"\/documentation\/auth0\/passkeycredential","title":"PasskeyCredential","type":"struct"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/passkeyenrollmentchallenge\/authenticationmethodid","title":"let authenticationMethodId: String","type":"property"},{"path":"\/documentation\/auth0\/passkeyenrollmentchallenge\/authenticationsession","title":"let authenticationSession: String","type":"property"},{"path":"\/documentation\/auth0\/passkeyenrollmentchallenge\/challengedata","title":"let challengeData: Data","type":"property"},{"path":"\/documentation\/auth0\/passkeyenrollmentchallenge\/relyingpartyid","title":"let relyingPartyId: String","type":"property"},{"path":"\/documentation\/auth0\/passkeyenrollmentchallenge\/userid","title":"let userId: Data","type":"property"},{"path":"\/documentation\/auth0\/passkeyenrollmentchallenge\/username","title":"let userName: String","type":"property"},{"title":"Default Implementations","type":"groupMarker"},{"children":[{"title":"Initializers","type":"groupMarker"},{"path":"\/documentation\/auth0\/passkeyenrollmentchallenge\/init(from:)","title":"init(from: Decoder) throws","type":"init"}],"path":"\/documentation\/auth0\/passkeyenrollmentchallenge\/decodable-implementations","title":"Decodable Implementations","type":"symbol"}],"path":"\/documentation\/auth0\/passkeyenrollmentchallenge","title":"PasskeyEnrollmentChallenge","type":"struct"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/passkeyloginchallenge\/authenticationsession","title":"let authenticationSession: String","type":"property"},{"path":"\/documentation\/auth0\/passkeyloginchallenge\/challengedata","title":"let challengeData: Data","type":"property"},{"path":"\/documentation\/auth0\/passkeyloginchallenge\/relyingpartyid","title":"let relyingPartyId: String","type":"property"},{"title":"Default Implementations","type":"groupMarker"},{"children":[{"title":"Initializers","type":"groupMarker"},{"path":"\/documentation\/auth0\/passkeyloginchallenge\/init(from:)","title":"init(from: Decoder) throws","type":"init"}],"path":"\/documentation\/auth0\/passkeyloginchallenge\/decodable-implementations","title":"Decodable Implementations","type":"symbol"}],"path":"\/documentation\/auth0\/passkeyloginchallenge","title":"PasskeyLoginChallenge","type":"struct"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/passkeysignupchallenge\/authenticationsession","title":"let authenticationSession: String","type":"property"},{"path":"\/documentation\/auth0\/passkeysignupchallenge\/challengedata","title":"let challengeData: Data","type":"property"},{"path":"\/documentation\/auth0\/passkeysignupchallenge\/relyingpartyid","title":"let relyingPartyId: String","type":"property"},{"path":"\/documentation\/auth0\/passkeysignupchallenge\/userid","title":"let userId: Data","type":"property"},{"path":"\/documentation\/auth0\/passkeysignupchallenge\/username","title":"let userName: String","type":"property"},{"title":"Default Implementations","type":"groupMarker"},{"children":[{"title":"Initializers","type":"groupMarker"},{"path":"\/documentation\/auth0\/passkeysignupchallenge\/init(from:)","title":"init(from: Decoder) throws","type":"init"}],"path":"\/documentation\/auth0\/passkeysignupchallenge\/decodable-implementations","title":"Decodable Implementations","type":"symbol"}],"path":"\/documentation\/auth0\/passkeysignupchallenge","title":"PasskeySignupChallenge","type":"struct"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/phoneenrollmentchallenge\/authenticationid","title":"let authenticationId: String","type":"property"},{"path":"\/documentation\/auth0\/phoneenrollmentchallenge\/authenticationsession","title":"let authenticationSession: String","type":"property"},{"title":"Default Implementations","type":"groupMarker"},{"children":[{"title":"Initializers","type":"groupMarker"},{"path":"\/documentation\/auth0\/phoneenrollmentchallenge\/init(from:)","title":"init(from: Decoder) throws","type":"init"}],"path":"\/documentation\/auth0\/phoneenrollmentchallenge\/decodable-implementations","title":"Decodable Implementations","type":"symbol"}],"path":"\/documentation\/auth0\/phoneenrollmentchallenge","title":"PhoneEnrollmentChallenge","type":"struct"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/pushenrollmentchallenge\/authenticationid","title":"let authenticationId: String","type":"property"},{"path":"\/documentation\/auth0\/pushenrollmentchallenge\/authenticationsession","title":"let authenticationSession: String","type":"property"},{"path":"\/documentation\/auth0\/pushenrollmentchallenge\/authenticatormanualinputcode","title":"let authenticatorManualInputCode: String?","type":"property"},{"path":"\/documentation\/auth0\/pushenrollmentchallenge\/authenticatorqrcodeuri","title":"let authenticatorQRCodeURI: String","type":"property"},{"title":"Default Implementations","type":"groupMarker"},{"children":[{"title":"Initializers","type":"groupMarker"},{"path":"\/documentation\/auth0\/pushenrollmentchallenge\/init(from:)","title":"init(from: Decoder) throws","type":"init"}],"path":"\/documentation\/auth0\/pushenrollmentchallenge\/decodable-implementations","title":"Decodable Implementations","type":"symbol"}],"path":"\/documentation\/auth0\/pushenrollmentchallenge","title":"PushEnrollmentChallenge","type":"struct"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/recoverycodeenrollmentchallenge\/authenticationid","title":"let authenticationId: String","type":"property"},{"path":"\/documentation\/auth0\/recoverycodeenrollmentchallenge\/authenticationsession","title":"let authenticationSession: String","type":"property"},{"path":"\/documentation\/auth0\/recoverycodeenrollmentchallenge\/recoverycode","title":"let recoveryCode: String","type":"property"},{"title":"Default Implementations","type":"groupMarker"},{"children":[{"title":"Initializers","type":"groupMarker"},{"path":"\/documentation\/auth0\/recoverycodeenrollmentchallenge\/init(from:)","title":"init(from: Decoder) throws","type":"init"}],"path":"\/documentation\/auth0\/recoverycodeenrollmentchallenge\/decodable-implementations","title":"Decodable Implementations","type":"symbol"}],"path":"\/documentation\/auth0\/recoverycodeenrollmentchallenge","title":"RecoveryCodeEnrollmentChallenge","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\/ssocredentials\/init(sessiontransfertoken:issuedtokentype:expiresin:idtoken:refreshtoken:)","title":"init(sessionTransferToken: String, issuedTokenType: String, expiresIn: Date, idToken: String, refreshToken: String?)","type":"init"},{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/ssocredentials\/description","title":"var description: String","type":"property"},{"path":"\/documentation\/auth0\/ssocredentials\/expiresin","title":"let expiresIn: Date","type":"property"},{"path":"\/documentation\/auth0\/ssocredentials\/idtoken","title":"let idToken: String","type":"property"},{"path":"\/documentation\/auth0\/ssocredentials\/issuedtokentype","title":"let issuedTokenType: String","type":"property"},{"path":"\/documentation\/auth0\/ssocredentials\/refreshtoken","title":"let refreshToken: String?","type":"property"},{"path":"\/documentation\/auth0\/ssocredentials\/sessiontransfertoken","title":"let sessionTransferToken: String","type":"property"},{"title":"Default Implementations","type":"groupMarker"},{"children":[{"title":"Initializers","type":"groupMarker"},{"path":"\/documentation\/auth0\/ssocredentials\/init(from:)","title":"init(from: Decoder) throws","type":"init"}],"path":"\/documentation\/auth0\/ssocredentials\/decodable-implementations","title":"Decodable Implementations","type":"symbol"},{"children":[{"title":"Instance Methods","type":"groupMarker"},{"path":"\/documentation\/auth0\/ssocredentials\/encode(to:)","title":"func encode(to: Encoder) throws","type":"method"}],"path":"\/documentation\/auth0\/ssocredentials\/encodable-implementations","title":"Encodable Implementations","type":"symbol"}],"path":"\/documentation\/auth0\/ssocredentials","title":"SSOCredentials","type":"struct"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/totpenrollmentchallenge\/authenticationid","title":"let authenticationId: String","type":"property"},{"path":"\/documentation\/auth0\/totpenrollmentchallenge\/authenticationsession","title":"let authenticationSession: String","type":"property"},{"path":"\/documentation\/auth0\/totpenrollmentchallenge\/authenticatormanualinputcode","title":"let authenticatorManualInputCode: String?","type":"property"},{"path":"\/documentation\/auth0\/totpenrollmentchallenge\/authenticatorqrcodeuri","title":"let authenticatorQRCodeURI: String","type":"property"},{"title":"Default Implementations","type":"groupMarker"},{"children":[{"title":"Initializers","type":"groupMarker"},{"path":"\/documentation\/auth0\/totpenrollmentchallenge\/init(from:)","title":"init(from: Decoder) throws","type":"init"}],"path":"\/documentation\/auth0\/totpenrollmentchallenge\/decodable-implementations","title":"Decodable Implementations","type":"symbol"}],"path":"\/documentation\/auth0\/totpenrollmentchallenge","title":"TOTPEnrollmentChallenge","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":"Initializers","type":"groupMarker"},{"path":"\/documentation\/auth0\/userinfo\/init(json:)","title":"init?(json: [String : Any])","type":"init"},{"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"}],"path":"\/documentation\/auth0\/userinfo","title":"UserInfo","type":"struct"},{"children":[{"title":"Operators","type":"groupMarker"},{"path":"\/documentation\/auth0\/webautherror\/~=(_:_:)-3690","title":"static func ~= (WebAuthError, WebAuthError) -> Bool","type":"op"},{"path":"\/documentation\/auth0\/webautherror\/~=(_:_:)-6ibkd","title":"static func ~= (WebAuthError, Error) -> Bool","type":"op"},{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/webautherror\/cause","title":"let cause: Error?","type":"property"},{"path":"\/documentation\/auth0\/webautherror\/debugdescription","title":"var debugDescription: String","type":"property"},{"title":"Type Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/webautherror\/idtokenvalidationfailed","title":"static let idTokenValidationFailed: WebAuthError","type":"property"},{"path":"\/documentation\/auth0\/webautherror\/invalidinvitationurl","title":"static let invalidInvitationURL: WebAuthError","type":"property"},{"path":"\/documentation\/auth0\/webautherror\/noauthorizationcode","title":"static let noAuthorizationCode: WebAuthError","type":"property"},{"path":"\/documentation\/auth0\/webautherror\/nobundleidentifier","title":"static let noBundleIdentifier: WebAuthError","type":"property"},{"path":"\/documentation\/auth0\/webautherror\/other","title":"static let other: WebAuthError","type":"property"},{"path":"\/documentation\/auth0\/webautherror\/pkcenotallowed","title":"static let pkceNotAllowed: WebAuthError","type":"property"},{"path":"\/documentation\/auth0\/webautherror\/transactionactivealready","title":"static let transactionActiveAlready: WebAuthError","type":"property"},{"path":"\/documentation\/auth0\/webautherror\/unknown","title":"static let unknown: WebAuthError","type":"property"},{"path":"\/documentation\/auth0\/webautherror\/usercancelled","title":"static let userCancelled: WebAuthError","type":"property"},{"title":"Default Implementations","type":"groupMarker"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/webautherror\/errordescription","title":"var errorDescription: String?","type":"property"},{"path":"\/documentation\/auth0\/webautherror\/localizeddescription","title":"var localizedDescription: String","type":"property"}],"path":"\/documentation\/auth0\/webautherror\/auth0error-implementations","title":"Auth0Error Implementations","type":"symbol"},{"children":[{"title":"Operators","type":"groupMarker"},{"path":"\/documentation\/auth0\/webautherror\/!=(_:_:)","title":"static func != (Self, Self) -> Bool","type":"op"},{"path":"\/documentation\/auth0\/webautherror\/==(_:_:)","title":"static func == (WebAuthError, WebAuthError) -> Bool","type":"op"}],"path":"\/documentation\/auth0\/webautherror\/equatable-implementations","title":"Equatable Implementations","type":"symbol"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/webautherror\/failurereason","title":"var failureReason: String?","type":"property"},{"path":"\/documentation\/auth0\/webautherror\/helpanchor","title":"var helpAnchor: String?","type":"property"},{"path":"\/documentation\/auth0\/webautherror\/recoverysuggestion","title":"var recoverySuggestion: String?","type":"property"}],"path":"\/documentation\/auth0\/webautherror\/localizederror-implementations","title":"LocalizedError Implementations","type":"symbol"}],"path":"\/documentation\/auth0\/webautherror","title":"WebAuthError","type":"struct"},{"children":[{"title":"Type Methods","type":"groupMarker"},{"path":"\/documentation\/auth0\/webauthentication\/cancel()","title":"static func cancel()","type":"method"},{"path":"\/documentation\/auth0\/webauthentication\/resume(with:)","title":"static func resume(with: URL) -> Bool","type":"method"},{"path":"\/documentation\/auth0\/webauthentication\/safariprovider(style:)","title":"static func safariProvider(style: UIModalPresentationStyle) -> WebAuthProvider","type":"method"},{"path":"\/documentation\/auth0\/webauthentication\/webviewprovider(style:)","title":"static func webViewProvider(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\/myaccount(token:domain:session:)","title":"func myAccount(token: String, domain: String, session: URLSession) -> MyAccount","type":"func"},{"path":"\/documentation\/auth0\/myaccount(token:session:bundle:)","title":"func myAccount(token: String, session: URLSession, bundle: Bundle) -> MyAccount","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\/myaccountresult","title":"MyAccountResult","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\/passkeydevicetype\/multidevice","title":"case multiDevice","type":"case"},{"path":"\/documentation\/auth0\/passkeydevicetype\/singledevice","title":"case singleDevice","type":"case"},{"title":"Initializers","type":"groupMarker"},{"path":"\/documentation\/auth0\/passkeydevicetype\/init(rawvalue:)","title":"init?(rawValue: String)","type":"init"},{"title":"Default Implementations","type":"groupMarker"},{"children":[{"title":"Operators","type":"groupMarker"},{"path":"\/documentation\/auth0\/passkeydevicetype\/!=(_:_:)","title":"static func != (Self, Self) -> Bool","type":"op"}],"path":"\/documentation\/auth0\/passkeydevicetype\/equatable-implementations","title":"Equatable Implementations","type":"symbol"},{"children":[{"title":"Initializers","type":"groupMarker"},{"path":"\/documentation\/auth0\/passkeydevicetype\/init(from:)","title":"init(from: any Decoder) throws","type":"init"},{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/passkeydevicetype\/hashvalue","title":"var hashValue: Int","type":"property"},{"title":"Instance Methods","type":"groupMarker"},{"path":"\/documentation\/auth0\/passkeydevicetype\/hash(into:)","title":"func hash(into: inout Hasher)","type":"method"}],"path":"\/documentation\/auth0\/passkeydevicetype\/rawrepresentable-implementations","title":"RawRepresentable Implementations","type":"symbol"}],"path":"\/documentation\/auth0\/passkeydevicetype","title":"PasskeyDeviceType","type":"enum"},{"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"},{"children":[{"title":"Enumeration Cases","type":"groupMarker"},{"path":"\/documentation\/auth0\/preferredauthenticationmethod\/sms","title":"case sms","type":"case"},{"path":"\/documentation\/auth0\/preferredauthenticationmethod\/voice","title":"case voice","type":"case"},{"title":"Initializers","type":"groupMarker"},{"path":"\/documentation\/auth0\/preferredauthenticationmethod\/init(rawvalue:)","title":"init?(rawValue: String)","type":"init"},{"title":"Default Implementations","type":"groupMarker"},{"children":[{"title":"Operators","type":"groupMarker"},{"path":"\/documentation\/auth0\/preferredauthenticationmethod\/!=(_:_:)","title":"static func != (Self, Self) -> Bool","type":"op"}],"path":"\/documentation\/auth0\/preferredauthenticationmethod\/equatable-implementations","title":"Equatable Implementations","type":"symbol"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/preferredauthenticationmethod\/hashvalue","title":"var hashValue: Int","type":"property"},{"title":"Instance Methods","type":"groupMarker"},{"path":"\/documentation\/auth0\/preferredauthenticationmethod\/hash(into:)","title":"func hash(into: inout Hasher)","type":"method"}],"path":"\/documentation\/auth0\/preferredauthenticationmethod\/rawrepresentable-implementations","title":"RawRepresentable Implementations","type":"symbol"}],"path":"\/documentation\/auth0\/preferredauthenticationmethod","title":"PreferredAuthenticationMethod","type":"enum"},{"title":"Extended Modules","type":"groupMarker"},{"children":[{"title":"Extended Enumerations","type":"groupMarker"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/authenticationservices\/asauthorizationpublickeycredentialattachment\/stringvalue","title":"var stringValue: String?","type":"property"}],"path":"\/documentation\/auth0\/authenticationservices\/asauthorizationpublickeycredentialattachment","title":"ASAuthorizationPublicKeyCredentialAttachment","type":"extension"}],"path":"\/documentation\/auth0\/authenticationservices","title":"AuthenticationServices","type":"extension"},{"children":[{"title":"Extended Types","type":"groupMarker"},{"children":[{"title":"Extended Types","type":"groupMarker"},{"children":[{"title":"Extended Structures","type":"groupMarker"},{"children":[{"title":"Default Implementations","type":"groupMarker"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/cryptokit\/p256\/signing\/privatekey\/description","title":"var description: String","type":"property"}],"path":"\/documentation\/auth0\/cryptokit\/p256\/signing\/privatekey\/customstringconvertible-implementations","title":"CustomStringConvertible Implementations","type":"symbol"}],"path":"\/documentation\/auth0\/cryptokit\/p256\/signing\/privatekey","title":"P256.Signing.PrivateKey","type":"extension"}],"path":"\/documentation\/auth0\/cryptokit\/p256\/signing","title":"P256.Signing","type":"extension"}],"path":"\/documentation\/auth0\/cryptokit\/p256","title":"P256","type":"extension"},{"children":[{"title":"Extended Types","type":"groupMarker"},{"children":[{"title":"Extended Types","type":"groupMarker"},{"children":[{"title":"Extended Structures","type":"groupMarker"},{"children":[{"title":"Default Implementations","type":"groupMarker"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/cryptokit\/secureenclave\/p256\/signing\/privatekey\/description","title":"var description: String","type":"property"}],"path":"\/documentation\/auth0\/cryptokit\/secureenclave\/p256\/signing\/privatekey\/customstringconvertible-implementations","title":"CustomStringConvertible Implementations","type":"symbol"}],"path":"\/documentation\/auth0\/cryptokit\/secureenclave\/p256\/signing\/privatekey","title":"SecureEnclave.P256.Signing.PrivateKey","type":"extension"}],"path":"\/documentation\/auth0\/cryptokit\/secureenclave\/p256\/signing","title":"SecureEnclave.P256.Signing","type":"extension"}],"path":"\/documentation\/auth0\/cryptokit\/secureenclave\/p256","title":"SecureEnclave.P256","type":"extension"}],"path":"\/documentation\/auth0\/cryptokit\/secureenclave","title":"SecureEnclave","type":"extension"}],"path":"\/documentation\/auth0\/cryptokit","title":"CryptoKit","type":"extension"},{"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":2}} \ No newline at end of file +{"includedArchiveIdentifiers":["com.auth0.Auth0"],"interfaceLanguages":{"swift":[{"children":[{"title":"Articles","type":"groupMarker"},{"path":"\/documentation\/auth0\/useragents","title":"ASWebAuthenticationSession vs SFSafariViewController (iOS)","type":"article"},{"path":"\/documentation\/auth0\/refreshtokens","title":"Refresh Tokens: Common Errors","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\/isnetworkerror","title":"var isNetworkError: Bool","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"},{"path":"\/documentation\/auth0\/auth0error\/cause-97kwn","title":"var cause: Error?","type":"property"}],"title":"Auth0Error Implementations","type":"groupMarker"}],"path":"\/documentation\/auth0\/auth0error\/cause","title":"var cause: Error?","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"},{"children":[{"children":[{"path":"\/documentation\/auth0\/authentication\/customtokenexchange(subjecttoken:subjecttokentype:audience:scope:organization:)-5dzwp","title":"func customTokenExchange(subjectToken: String, subjectTokenType: String, audience: String?, scope: String, organization: String?) -> Request","type":"method"}],"title":"Authentication Implementations","type":"groupMarker"}],"path":"\/documentation\/auth0\/authentication\/customtokenexchange(subjecttoken:subjecttokentype:audience:scope:organization:)","title":"func customTokenExchange(subjectToken: String, subjectTokenType: String, audience: String?, scope: String, organization: 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:)","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:)","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:)","title":"func login(facebookSessionAccessToken: String, profile: [String : Any], audience: String?, scope: String) -> Request","type":"method"},{"children":[{"children":[{"path":"\/documentation\/auth0\/authentication\/login(passkey:challenge:connection:audience:scope:organization:)-4e7pl","title":"func login(passkey: LoginPasskey, challenge: PasskeyLoginChallenge, connection: String?, audience: String?, scope: String, organization: String?) -> Request","type":"method"},{"path":"\/documentation\/auth0\/authentication\/login(passkey:challenge:connection:audience:scope:organization:)-59b3j","title":"func login(passkey: SignupPasskey, challenge: PasskeySignupChallenge, connection: String?, audience: String?, scope: String, organization: String?) -> Request","type":"method"}],"title":"Authentication Implementations","type":"groupMarker"}],"path":"\/documentation\/auth0\/authentication\/login(passkey:challenge:connection:audience:scope:organization:)-1gm8k","title":"func login(passkey: LoginPasskey, challenge: PasskeyLoginChallenge, connection: String?, audience: String?, scope: String, organization: String?) -> Request","type":"method"},{"children":[{"children":[{"path":"\/documentation\/auth0\/authentication\/login(passkey:challenge:connection:audience:scope:organization:)-4e7pl","title":"func login(passkey: LoginPasskey, challenge: PasskeyLoginChallenge, connection: String?, audience: String?, scope: String, organization: String?) -> Request","type":"method"},{"path":"\/documentation\/auth0\/authentication\/login(passkey:challenge:connection:audience:scope:organization:)-59b3j","title":"func login(passkey: SignupPasskey, challenge: PasskeySignupChallenge, connection: String?, audience: String?, scope: String, organization: String?) -> Request","type":"method"}],"title":"Authentication Implementations","type":"groupMarker"}],"path":"\/documentation\/auth0\/authentication\/login(passkey:challenge:connection:audience:scope:organization:)-340n2","title":"func login(passkey: SignupPasskey, challenge: PasskeySignupChallenge, connection: String?, audience: String?, scope: String, organization: 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:)","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:)","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:)","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:)","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:)","title":"func multifactorChallenge(mfaToken: String, types: [String]?, authenticatorId: String?) -> Request","type":"method"},{"children":[{"children":[{"path":"\/documentation\/auth0\/authentication\/passkeyloginchallenge(connection:organization:)-56e54","title":"func passkeyLoginChallenge(connection: String?, organization: String?) -> Request","type":"method"}],"title":"Authentication Implementations","type":"groupMarker"}],"path":"\/documentation\/auth0\/authentication\/passkeyloginchallenge(connection:organization:)","title":"func passkeyLoginChallenge(connection: String?, organization: String?) -> Request","type":"method"},{"children":[{"children":[{"path":"\/documentation\/auth0\/authentication\/passkeysignupchallenge(email:phonenumber:username:name:connection:organization:)-8jlyt","title":"func passkeySignupChallenge(email: String?, phoneNumber: String?, username: String?, name: String?, connection: String?, organization: String?) -> Request","type":"method"}],"title":"Authentication Implementations","type":"groupMarker"}],"path":"\/documentation\/auth0\/authentication\/passkeysignupchallenge(email:phonenumber:username:name:connection:organization:)","title":"func passkeySignupChallenge(email: String?, phoneNumber: String?, username: String?, name: String?, connection: String?, organization: String?) -> Request","type":"method"},{"children":[{"children":[{"path":"\/documentation\/auth0\/authentication\/renew(withrefreshtoken:audience:scope:)-1orlu","title":"func renew(withRefreshToken: String, audience: String?, scope: String?) -> Request","type":"method"}],"title":"Authentication Implementations","type":"groupMarker"}],"path":"\/documentation\/auth0\/authentication\/renew(withrefreshtoken:audience:scope:)","title":"func renew(withRefreshToken: String, audience: 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:)","title":"func signup(email: String, username: String?, password: String, connection: String, userMetadata: [String : Any]?, rootAttributes: [String : Any]?) -> Request","type":"method"},{"path":"\/documentation\/auth0\/authentication\/ssoexchange(withrefreshtoken:)","title":"func ssoExchange(withRefreshToken: String) -> 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:)","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:)","title":"func startPasswordless(phoneNumber: String, type: PasswordlessType, connection: String) -> Request","type":"method"},{"children":[{"children":[{"path":"\/documentation\/auth0\/authentication\/userinfo(withaccesstoken:tokentype:)-i0qu","title":"func userInfo(withAccessToken: String, tokenType: String) -> Request","type":"method"}],"title":"Authentication Implementations","type":"groupMarker"}],"path":"\/documentation\/auth0\/authentication\/userinfo(withaccesstoken:tokentype:)","title":"func userInfo(withAccessToken: String, tokenType: 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\/loginpasskey\/attachment","title":"var attachment: ASAuthorizationPublicKeyCredentialAttachment","type":"property"},{"path":"\/documentation\/auth0\/loginpasskey\/credentialid","title":"var credentialID: Data","type":"property"},{"path":"\/documentation\/auth0\/loginpasskey\/rawauthenticatordata","title":"var rawAuthenticatorData: Data!","type":"property"},{"path":"\/documentation\/auth0\/loginpasskey\/rawclientdatajson","title":"var rawClientDataJSON: Data","type":"property"},{"path":"\/documentation\/auth0\/loginpasskey\/signature","title":"var signature: Data!","type":"property"},{"path":"\/documentation\/auth0\/loginpasskey\/userid","title":"var userID: Data!","type":"property"}],"path":"\/documentation\/auth0\/loginpasskey","title":"LoginPasskey","type":"protocol"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/myaccount\/authenticationmethods","title":"var authenticationMethods: MyAccountAuthenticationMethods","type":"property"},{"title":"Type Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/myaccount\/apiversion","title":"static var apiVersion: String","type":"property"}],"path":"\/documentation\/auth0\/myaccount","title":"MyAccount","type":"protocol"},{"children":[{"title":"Instance Methods","type":"groupMarker"},{"path":"\/documentation\/auth0\/myaccountauthenticationmethods\/confirmemailenrollment(id:authsession:otpcode:)","title":"func confirmEmailEnrollment(id: String, authSession: String, otpCode: String) -> Request","type":"method"},{"path":"\/documentation\/auth0\/myaccountauthenticationmethods\/confirmphoneenrollment(id:authsession:otpcode:)","title":"func confirmPhoneEnrollment(id: String, authSession: String, otpCode: String) -> Request","type":"method"},{"path":"\/documentation\/auth0\/myaccountauthenticationmethods\/confirmpushnotificationenrollment(id:authsession:)","title":"func confirmPushNotificationEnrollment(id: String, authSession: String) -> Request","type":"method"},{"path":"\/documentation\/auth0\/myaccountauthenticationmethods\/confirmrecoverycodeenrollment(id:authsession:)","title":"func confirmRecoveryCodeEnrollment(id: String, authSession: String) -> Request","type":"method"},{"path":"\/documentation\/auth0\/myaccountauthenticationmethods\/confirmtotpenrollment(id:authsession:otpcode:)","title":"func confirmTOTPEnrollment(id: String, authSession: String, otpCode: String) -> Request","type":"method"},{"path":"\/documentation\/auth0\/myaccountauthenticationmethods\/deleteauthenticationmethod(by:)","title":"func deleteAuthenticationMethod(by: String) -> Request","type":"method"},{"path":"\/documentation\/auth0\/myaccountauthenticationmethods\/enroll(passkey:challenge:)","title":"func enroll(passkey: NewPasskey, challenge: PasskeyEnrollmentChallenge) -> Request","type":"method"},{"path":"\/documentation\/auth0\/myaccountauthenticationmethods\/enrollemail(emailaddress:)","title":"func enrollEmail(emailAddress: String) -> Request","type":"method"},{"children":[{"children":[{"path":"\/documentation\/auth0\/myaccountauthenticationmethods\/enrollphone(phonenumber:preferredauthenticationmethod:)-7jrdw","title":"func enrollPhone(phoneNumber: String, preferredAuthenticationMethod: PreferredAuthenticationMethod?) -> Request","type":"method"}],"title":"MyAccountAuthenticationMethods Implementations","type":"groupMarker"}],"path":"\/documentation\/auth0\/myaccountauthenticationmethods\/enrollphone(phonenumber:preferredauthenticationmethod:)","title":"func enrollPhone(phoneNumber: String, preferredAuthenticationMethod: PreferredAuthenticationMethod?) -> Request","type":"method"},{"path":"\/documentation\/auth0\/myaccountauthenticationmethods\/enrollpushnotification()","title":"func enrollPushNotification() -> Request","type":"method"},{"path":"\/documentation\/auth0\/myaccountauthenticationmethods\/enrollrecoverycode()","title":"func enrollRecoveryCode() -> Request","type":"method"},{"path":"\/documentation\/auth0\/myaccountauthenticationmethods\/enrolltotp()","title":"func enrollTOTP() -> Request","type":"method"},{"path":"\/documentation\/auth0\/myaccountauthenticationmethods\/getauthenticationmethod(by:)","title":"func getAuthenticationMethod(by: String) -> Request","type":"method"},{"path":"\/documentation\/auth0\/myaccountauthenticationmethods\/getauthenticationmethods()","title":"func getAuthenticationMethods() -> Request<[AuthenticationMethod], MyAccountError>","type":"method"},{"path":"\/documentation\/auth0\/myaccountauthenticationmethods\/getfactors()","title":"func getFactors() -> Request<[Factor], MyAccountError>","type":"method"},{"children":[{"children":[{"path":"\/documentation\/auth0\/myaccountauthenticationmethods\/passkeyenrollmentchallenge(useridentityid:connection:)-71dk8","title":"func passkeyEnrollmentChallenge(userIdentityId: String?, connection: String?) -> Request","type":"method"}],"title":"MyAccountAuthenticationMethods Implementations","type":"groupMarker"}],"path":"\/documentation\/auth0\/myaccountauthenticationmethods\/passkeyenrollmentchallenge(useridentityid:connection:)","title":"func passkeyEnrollmentChallenge(userIdentityId: String?, connection: String?) -> Request","type":"method"}],"path":"\/documentation\/auth0\/myaccountauthenticationmethods","title":"MyAccountAuthenticationMethods","type":"protocol"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/myaccountclient\/token","title":"var token: String","type":"property"},{"path":"\/documentation\/auth0\/myaccountclient\/url","title":"var url: URL","type":"property"}],"path":"\/documentation\/auth0\/myaccountclient","title":"MyAccountClient","type":"protocol"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/newpasskey\/attachment","title":"var attachment: ASAuthorizationPublicKeyCredentialAttachment","type":"property"},{"path":"\/documentation\/auth0\/newpasskey\/credentialid","title":"var credentialID: Data","type":"property"},{"path":"\/documentation\/auth0\/newpasskey\/rawattestationobject","title":"var rawAttestationObject: Data?","type":"property"},{"path":"\/documentation\/auth0\/newpasskey\/rawclientdatajson","title":"var rawClientDataJSON: Data","type":"property"}],"path":"\/documentation\/auth0\/newpasskey","title":"NewPasskey","type":"protocol"},{"children":[{"title":"Associated Types","type":"groupMarker"},{"path":"\/documentation\/auth0\/requestable\/errortype","title":"ErrorType","type":"associatedtype"},{"path":"\/documentation\/auth0\/requestable\/resulttype","title":"ResultType","type":"associatedtype"},{"title":"Instance Methods","type":"groupMarker"},{"path":"\/documentation\/auth0\/requestable\/start(_:)","title":"func start((Result) -> Void)","type":"method"}],"path":"\/documentation\/auth0\/requestable","title":"Requestable","type":"protocol"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/senderconstraining\/dpop","title":"var dpop: DPoP?","type":"property"},{"title":"Instance Methods","type":"groupMarker"},{"path":"\/documentation\/auth0\/senderconstraining\/usedpop(keychainidentifier:)","title":"func useDPoP(keychainIdentifier: String) -> Self","type":"method"}],"path":"\/documentation\/auth0\/senderconstraining","title":"SenderConstraining","type":"protocol"},{"path":"\/documentation\/auth0\/signuppasskey","title":"SignupPasskey","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:)","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:)","title":"func link(String, withUser: String, provider: String, connectionId: String?) -> Request<[ManagementObject], ManagementError>","type":"method"},{"path":"\/documentation\/auth0\/users\/patch(_:attributes:)","title":"func patch(String, attributes: UserPatchAttributes) -> Request","type":"method"},{"path":"\/documentation\/auth0\/users\/patch(_:usermetadata:)","title":"func patch(String, userMetadata: [String : Any]) -> Request","type":"method"},{"path":"\/documentation\/auth0\/users\/unlink(identityid:provider:fromuserid:)","title":"func unlink(identityId: String, provider: String, fromUserId: String) -> Request<[ManagementObject], ManagementError>","type":"method"}],"path":"\/documentation\/auth0\/users","title":"Users","type":"protocol"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/webauth\/clientid","title":"var clientId: String","type":"property"},{"path":"\/documentation\/auth0\/webauth\/telemetry","title":"var telemetry: Telemetry","type":"property"},{"path":"\/documentation\/auth0\/webauth\/url","title":"var url: URL","type":"property"},{"title":"Instance Methods","type":"groupMarker"},{"path":"\/documentation\/auth0\/webauth\/audience(_:)","title":"func audience(String) -> Self","type":"method"},{"path":"\/documentation\/auth0\/webauth\/authorizeurl(_:)","title":"func authorizeURL(URL) -> Self","type":"method"},{"children":[{"children":[{"path":"\/documentation\/auth0\/webauth\/clearsession(federated:)-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:)","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\/headers(_:)","title":"func headers([String : 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\/apicredentials\/init(accesstoken:tokentype:expiresin:scope:)","title":"init(accessToken: String, tokenType: String, expiresIn: Date, scope: String)","type":"init"},{"path":"\/documentation\/auth0\/apicredentials\/init(from:)-5sa91","title":"init(from: Credentials)","type":"init"},{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/apicredentials\/accesstoken","title":"let accessToken: String","type":"property"},{"path":"\/documentation\/auth0\/apicredentials\/description","title":"var description: String","type":"property"},{"path":"\/documentation\/auth0\/apicredentials\/expiresin","title":"let expiresIn: Date","type":"property"},{"path":"\/documentation\/auth0\/apicredentials\/scope","title":"let scope: String","type":"property"},{"path":"\/documentation\/auth0\/apicredentials\/tokentype","title":"let tokenType: String","type":"property"},{"title":"Default Implementations","type":"groupMarker"},{"children":[{"title":"Initializers","type":"groupMarker"},{"path":"\/documentation\/auth0\/apicredentials\/init(from:)-8e5ds","title":"init(from: any Decoder) throws","type":"init"}],"path":"\/documentation\/auth0\/apicredentials\/decodable-implementations","title":"Decodable Implementations","type":"symbol"}],"path":"\/documentation\/auth0\/apicredentials","title":"APICredentials","type":"struct"},{"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\/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\/isdpopnoncerequired","title":"var isDPoPNonceRequired: 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\/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\/message","title":"var message: String","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\/cause","title":"var cause: Error?","type":"property"},{"path":"\/documentation\/auth0\/authenticationerror\/isnetworkerror","title":"var isNetworkError: Bool","type":"property"}],"path":"\/documentation\/auth0\/authenticationerror\/auth0apierror-implementations","title":"Auth0APIError Implementations","type":"symbol"},{"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\/authenticationmethod\/init(from:)","title":"init(from: any Decoder) throws","type":"init"},{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/authenticationmethod\/confirmed","title":"let confirmed: Bool?","type":"property"},{"path":"\/documentation\/auth0\/authenticationmethod\/createdat","title":"let createdAt: String","type":"property"},{"path":"\/documentation\/auth0\/authenticationmethod\/credentialbackedup","title":"let credentialBackedUp: Bool?","type":"property"},{"path":"\/documentation\/auth0\/authenticationmethod\/credentialdevicetype","title":"let credentialDeviceType: String?","type":"property"},{"path":"\/documentation\/auth0\/authenticationmethod\/id","title":"let id: String","type":"property"},{"path":"\/documentation\/auth0\/authenticationmethod\/identityuserid","title":"let identityUserId: String?","type":"property"},{"path":"\/documentation\/auth0\/authenticationmethod\/keyid","title":"let keyId: String?","type":"property"},{"path":"\/documentation\/auth0\/authenticationmethod\/lastpasswordreset","title":"let lastPasswordReset: String?","type":"property"},{"path":"\/documentation\/auth0\/authenticationmethod\/name","title":"let name: String?","type":"property"},{"path":"\/documentation\/auth0\/authenticationmethod\/phonenumber","title":"let phoneNumber: String?","type":"property"},{"path":"\/documentation\/auth0\/authenticationmethod\/preferredauthenticationmethod","title":"let preferredAuthenticationMethod: String?","type":"property"},{"path":"\/documentation\/auth0\/authenticationmethod\/publickey","title":"let publicKey: String?","type":"property"},{"path":"\/documentation\/auth0\/authenticationmethod\/transports","title":"let transports: [String]?","type":"property"},{"path":"\/documentation\/auth0\/authenticationmethod\/type","title":"let type: String?","type":"property"},{"path":"\/documentation\/auth0\/authenticationmethod\/usage","title":"let usage: [String]","type":"property"},{"path":"\/documentation\/auth0\/authenticationmethod\/useragent","title":"let userAgent: String?","type":"property"},{"path":"\/documentation\/auth0\/authenticationmethod\/userhandle","title":"let userHandle: String?","type":"property"}],"path":"\/documentation\/auth0\/authenticationmethod","title":"AuthenticationMethod","type":"struct"},{"children":[{"title":"Initializers","type":"groupMarker"},{"path":"\/documentation\/auth0\/authenticationmethods\/init(from:)","title":"init(from: any Decoder) throws","type":"init"},{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/authenticationmethods\/authenticationmethods","title":"let authenticationMethods: [AuthenticationMethod]","type":"property"}],"path":"\/documentation\/auth0\/authenticationmethods","title":"AuthenticationMethods","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\/apicredentials(foraudience:scope:minttl:parameters:headers:)-18htb","title":"func apiCredentials(forAudience: String, scope: String?, minTTL: Int, parameters: [String : Any], headers: [String : String]) -> AnyPublisher","type":"method"},{"path":"\/documentation\/auth0\/credentialsmanager\/apicredentials(foraudience:scope:minttl:parameters:headers:)-8lezm","title":"func apiCredentials(forAudience: String, scope: String?, minTTL: Int, parameters: [String : Any], headers: [String : String]) async throws -> APICredentials","type":"method"},{"path":"\/documentation\/auth0\/credentialsmanager\/apicredentials(foraudience:scope:minttl:parameters:headers:callback:)","title":"func apiCredentials(forAudience: String, scope: String?, minTTL: Int, parameters: [String : Any], headers: [String : String], callback: (CredentialsManagerResult) -> Void)","type":"method"},{"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\/clear(foraudience:scope:)","title":"func clear(forAudience: String, scope: String?) -> Bool","type":"method"},{"path":"\/documentation\/auth0\/credentialsmanager\/clearbiometricsession()","title":"func clearBiometricSession()","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:policy:)","title":"func enableBiometrics(withTitle: String, cancelTitle: String?, fallbackTitle: String?, evaluationPolicy: LAPolicy, policy: BiometricPolicy)","type":"method"},{"path":"\/documentation\/auth0\/credentialsmanager\/hasvalid(minttl:)","title":"func hasValid(minTTL: Int) -> Bool","type":"method"},{"path":"\/documentation\/auth0\/credentialsmanager\/isbiometricsessionvalid()","title":"func isBiometricSessionValid() -> 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\/ssocredentials(parameters:headers:)-151ni","title":"func ssoCredentials(parameters: [String : Any], headers: [String : String]) -> AnyPublisher","type":"method"},{"path":"\/documentation\/auth0\/credentialsmanager\/ssocredentials(parameters:headers:)-8vdt4","title":"func ssoCredentials(parameters: [String : Any], headers: [String : String]) async throws -> SSOCredentials","type":"method"},{"path":"\/documentation\/auth0\/credentialsmanager\/ssocredentials(parameters:headers:callback:)","title":"func ssoCredentials(parameters: [String : Any], headers: [String : String], callback: (CredentialsManagerResult) -> Void)","type":"method"},{"path":"\/documentation\/auth0\/credentialsmanager\/store(apicredentials:foraudience:forscope:)","title":"func store(apiCredentials: APICredentials, forAudience: String, forScope: String?) -> Bool","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"},{"path":"\/documentation\/auth0\/credentialsmanagererror\/message","title":"var message: String","type":"property"},{"title":"Type Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/credentialsmanagererror\/apiexchangefailed","title":"static let apiExchangeFailed: CredentialsManagerError","type":"property"},{"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\/ssoexchangefailed","title":"static let ssoExchangeFailed: 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":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/dpop\/keychainidentifier","title":"let keychainIdentifier: String","type":"property"},{"title":"Type Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/dpop\/defaultkeychainidentifier","title":"static let defaultKeychainIdentifier: String","type":"property"},{"title":"Type Methods","type":"groupMarker"},{"path":"\/documentation\/auth0\/dpop\/addheaders(to:accesstoken:tokentype:nonce:keychainidentifier:)","title":"static func addHeaders(to: inout URLRequest, accessToken: String, tokenType: String, nonce: String?, keychainIdentifier: String) throws(DPoPError)","type":"method"},{"path":"\/documentation\/auth0\/dpop\/clearkeypair(for:)","title":"static func clearKeypair(for: String) throws(DPoPError)","type":"method"},{"path":"\/documentation\/auth0\/dpop\/isnoncerequired(by:)","title":"static func isNonceRequired(by: HTTPURLResponse) -> Bool","type":"method"}],"path":"\/documentation\/auth0\/dpop","title":"DPoP","type":"struct"},{"children":[{"title":"Operators","type":"groupMarker"},{"path":"\/documentation\/auth0\/dpoperror\/~=(_:_:)-2g6ss","title":"static func ~= (DPoPError, Error) -> Bool","type":"op"},{"path":"\/documentation\/auth0\/dpoperror\/~=(_:_:)-8r7xi","title":"static func ~= (DPoPError, DPoPError) -> Bool","type":"op"},{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/dpoperror\/cause","title":"let cause: Error?","type":"property"},{"path":"\/documentation\/auth0\/dpoperror\/debugdescription","title":"var debugDescription: String","type":"property"},{"title":"Type Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/dpoperror\/cryptokitoperationfailed","title":"static let cryptoKitOperationFailed: DPoPError","type":"property"},{"path":"\/documentation\/auth0\/dpoperror\/keychainoperationfailed","title":"static let keychainOperationFailed: DPoPError","type":"property"},{"path":"\/documentation\/auth0\/dpoperror\/other","title":"static let other: DPoPError","type":"property"},{"path":"\/documentation\/auth0\/dpoperror\/seckeyoperationfailed","title":"static let secKeyOperationFailed: DPoPError","type":"property"},{"path":"\/documentation\/auth0\/dpoperror\/secureenclaveoperationfailed","title":"static let secureEnclaveOperationFailed: DPoPError","type":"property"},{"path":"\/documentation\/auth0\/dpoperror\/unknown","title":"static let unknown: DPoPError","type":"property"},{"title":"Default Implementations","type":"groupMarker"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/dpoperror\/errordescription","title":"var errorDescription: String?","type":"property"},{"path":"\/documentation\/auth0\/dpoperror\/localizeddescription","title":"var localizedDescription: String","type":"property"}],"path":"\/documentation\/auth0\/dpoperror\/auth0error-implementations","title":"Auth0Error Implementations","type":"symbol"},{"children":[{"title":"Operators","type":"groupMarker"},{"path":"\/documentation\/auth0\/dpoperror\/!=(_:_:)","title":"static func != (Self, Self) -> Bool","type":"op"},{"path":"\/documentation\/auth0\/dpoperror\/==(_:_:)","title":"static func == (DPoPError, DPoPError) -> Bool","type":"op"}],"path":"\/documentation\/auth0\/dpoperror\/equatable-implementations","title":"Equatable Implementations","type":"symbol"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/dpoperror\/failurereason","title":"var failureReason: String?","type":"property"},{"path":"\/documentation\/auth0\/dpoperror\/helpanchor","title":"var helpAnchor: String?","type":"property"},{"path":"\/documentation\/auth0\/dpoperror\/recoverysuggestion","title":"var recoverySuggestion: String?","type":"property"}],"path":"\/documentation\/auth0\/dpoperror\/localizederror-implementations","title":"LocalizedError Implementations","type":"symbol"}],"path":"\/documentation\/auth0\/dpoperror","title":"DPoPError","type":"struct"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/emailenrollmentchallenge\/authenticationid","title":"let authenticationId: String","type":"property"},{"path":"\/documentation\/auth0\/emailenrollmentchallenge\/authenticationsession","title":"let authenticationSession: String","type":"property"},{"title":"Default Implementations","type":"groupMarker"},{"children":[{"title":"Initializers","type":"groupMarker"},{"path":"\/documentation\/auth0\/emailenrollmentchallenge\/init(from:)","title":"init(from: Decoder) throws","type":"init"}],"path":"\/documentation\/auth0\/emailenrollmentchallenge\/decodable-implementations","title":"Decodable Implementations","type":"symbol"}],"path":"\/documentation\/auth0\/emailenrollmentchallenge","title":"EmailEnrollmentChallenge","type":"struct"},{"children":[{"title":"Initializers","type":"groupMarker"},{"path":"\/documentation\/auth0\/factor\/init(from:)","title":"init(from: any Decoder) throws","type":"init"},{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/factor\/type","title":"let type: String","type":"property"},{"path":"\/documentation\/auth0\/factor\/usage","title":"let usage: [String]?","type":"property"}],"path":"\/documentation\/auth0\/factor","title":"Factor","type":"struct"},{"children":[{"title":"Initializers","type":"groupMarker"},{"path":"\/documentation\/auth0\/factors\/init(from:)","title":"init(from: any Decoder) throws","type":"init"},{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/factors\/factors","title":"let factors: [Factor]","type":"property"}],"path":"\/documentation\/auth0\/factors","title":"Factors","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\/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\/cause","title":"var cause: Error?","type":"property"},{"path":"\/documentation\/auth0\/managementerror\/isnetworkerror","title":"var isNetworkError: Bool","type":"property"}],"path":"\/documentation\/auth0\/managementerror\/auth0apierror-implementations","title":"Auth0APIError Implementations","type":"symbol"},{"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":"Structures","type":"groupMarker"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/myaccounterror\/validationerror\/detail","title":"let detail: String","type":"property"},{"path":"\/documentation\/auth0\/myaccounterror\/validationerror\/field","title":"let field: String?","type":"property"},{"path":"\/documentation\/auth0\/myaccounterror\/validationerror\/pointer","title":"let pointer: String?","type":"property"},{"path":"\/documentation\/auth0\/myaccounterror\/validationerror\/source","title":"let source: String?","type":"property"},{"title":"Default Implementations","type":"groupMarker"},{"children":[{"title":"Operators","type":"groupMarker"},{"path":"\/documentation\/auth0\/myaccounterror\/validationerror\/!=(_:_:)","title":"static func != (Self, Self) -> Bool","type":"op"}],"path":"\/documentation\/auth0\/myaccounterror\/validationerror\/equatable-implementations","title":"Equatable Implementations","type":"symbol"}],"path":"\/documentation\/auth0\/myaccounterror\/validationerror","title":"MyAccountError.ValidationError","type":"struct"},{"title":"Initializers","type":"groupMarker"},{"path":"\/documentation\/auth0\/myaccounterror\/init(info:statuscode:)","title":"init(info: [String : Any], statusCode: Int)","type":"init"},{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/myaccounterror\/code","title":"let code: String","type":"property"},{"path":"\/documentation\/auth0\/myaccounterror\/debugdescription","title":"var debugDescription: String","type":"property"},{"path":"\/documentation\/auth0\/myaccounterror\/detail","title":"let detail: String","type":"property"},{"path":"\/documentation\/auth0\/myaccounterror\/info","title":"let info: [String : Any]","type":"property"},{"path":"\/documentation\/auth0\/myaccounterror\/message","title":"var message: String","type":"property"},{"path":"\/documentation\/auth0\/myaccounterror\/statuscode","title":"let statusCode: Int","type":"property"},{"path":"\/documentation\/auth0\/myaccounterror\/title","title":"let title: String","type":"property"},{"path":"\/documentation\/auth0\/myaccounterror\/validationerrors","title":"let validationErrors: [ValidationError]?","type":"property"},{"title":"Default Implementations","type":"groupMarker"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/myaccounterror\/cause","title":"var cause: Error?","type":"property"},{"path":"\/documentation\/auth0\/myaccounterror\/isnetworkerror","title":"var isNetworkError: Bool","type":"property"}],"path":"\/documentation\/auth0\/myaccounterror\/auth0apierror-implementations","title":"Auth0APIError Implementations","type":"symbol"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/myaccounterror\/errordescription","title":"var errorDescription: String?","type":"property"},{"path":"\/documentation\/auth0\/myaccounterror\/localizeddescription","title":"var localizedDescription: String","type":"property"}],"path":"\/documentation\/auth0\/myaccounterror\/auth0error-implementations","title":"Auth0Error Implementations","type":"symbol"},{"children":[{"title":"Operators","type":"groupMarker"},{"path":"\/documentation\/auth0\/myaccounterror\/!=(_:_:)","title":"static func != (Self, Self) -> Bool","type":"op"},{"path":"\/documentation\/auth0\/myaccounterror\/==(_:_:)","title":"static func == (MyAccountError, MyAccountError) -> Bool","type":"op"}],"path":"\/documentation\/auth0\/myaccounterror\/equatable-implementations","title":"Equatable Implementations","type":"symbol"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/myaccounterror\/failurereason","title":"var failureReason: String?","type":"property"},{"path":"\/documentation\/auth0\/myaccounterror\/helpanchor","title":"var helpAnchor: String?","type":"property"},{"path":"\/documentation\/auth0\/myaccounterror\/recoverysuggestion","title":"var recoverySuggestion: String?","type":"property"}],"path":"\/documentation\/auth0\/myaccounterror\/localizederror-implementations","title":"LocalizedError Implementations","type":"symbol"}],"path":"\/documentation\/auth0\/myaccounterror","title":"MyAccountError","type":"struct"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/passkeyauthenticationmethod\/aaguid","title":"let aaguid: String","type":"property"},{"path":"\/documentation\/auth0\/passkeyauthenticationmethod\/createdat","title":"let createdAt: Date","type":"property"},{"path":"\/documentation\/auth0\/passkeyauthenticationmethod\/credential","title":"let credential: PasskeyCredential","type":"property"},{"path":"\/documentation\/auth0\/passkeyauthenticationmethod\/id","title":"let id: String","type":"property"},{"path":"\/documentation\/auth0\/passkeyauthenticationmethod\/relyingpartyidentifier","title":"let relyingPartyIdentifier: String","type":"property"},{"path":"\/documentation\/auth0\/passkeyauthenticationmethod\/type","title":"let type: String","type":"property"},{"path":"\/documentation\/auth0\/passkeyauthenticationmethod\/useragent","title":"let userAgent: String?","type":"property"},{"path":"\/documentation\/auth0\/passkeyauthenticationmethod\/useridentityid","title":"let userIdentityId: String","type":"property"},{"title":"Default Implementations","type":"groupMarker"},{"children":[{"title":"Initializers","type":"groupMarker"},{"path":"\/documentation\/auth0\/passkeyauthenticationmethod\/init(from:)","title":"init(from: Decoder) throws","type":"init"}],"path":"\/documentation\/auth0\/passkeyauthenticationmethod\/decodable-implementations","title":"Decodable Implementations","type":"symbol"},{"children":[{"title":"Operators","type":"groupMarker"},{"path":"\/documentation\/auth0\/passkeyauthenticationmethod\/!=(_:_:)","title":"static func != (Self, Self) -> Bool","type":"op"}],"path":"\/documentation\/auth0\/passkeyauthenticationmethod\/equatable-implementations","title":"Equatable Implementations","type":"symbol"}],"path":"\/documentation\/auth0\/passkeyauthenticationmethod","title":"PasskeyAuthenticationMethod","type":"struct"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/passkeycredential\/devicetype","title":"let deviceType: PasskeyDeviceType","type":"property"},{"path":"\/documentation\/auth0\/passkeycredential\/id","title":"let id: String","type":"property"},{"path":"\/documentation\/auth0\/passkeycredential\/isbackedup","title":"let isBackedUp: Bool","type":"property"},{"path":"\/documentation\/auth0\/passkeycredential\/publickey","title":"let publicKey: Data","type":"property"},{"path":"\/documentation\/auth0\/passkeycredential\/userhandle","title":"let userHandle: Data","type":"property"},{"title":"Default Implementations","type":"groupMarker"},{"children":[{"title":"Initializers","type":"groupMarker"},{"path":"\/documentation\/auth0\/passkeycredential\/init(from:)","title":"init(from: Decoder) throws","type":"init"}],"path":"\/documentation\/auth0\/passkeycredential\/decodable-implementations","title":"Decodable Implementations","type":"symbol"},{"children":[{"title":"Operators","type":"groupMarker"},{"path":"\/documentation\/auth0\/passkeycredential\/!=(_:_:)","title":"static func != (Self, Self) -> Bool","type":"op"}],"path":"\/documentation\/auth0\/passkeycredential\/equatable-implementations","title":"Equatable Implementations","type":"symbol"}],"path":"\/documentation\/auth0\/passkeycredential","title":"PasskeyCredential","type":"struct"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/passkeyenrollmentchallenge\/authenticationmethodid","title":"let authenticationMethodId: String","type":"property"},{"path":"\/documentation\/auth0\/passkeyenrollmentchallenge\/authenticationsession","title":"let authenticationSession: String","type":"property"},{"path":"\/documentation\/auth0\/passkeyenrollmentchallenge\/challengedata","title":"let challengeData: Data","type":"property"},{"path":"\/documentation\/auth0\/passkeyenrollmentchallenge\/relyingpartyid","title":"let relyingPartyId: String","type":"property"},{"path":"\/documentation\/auth0\/passkeyenrollmentchallenge\/userid","title":"let userId: Data","type":"property"},{"path":"\/documentation\/auth0\/passkeyenrollmentchallenge\/username","title":"let userName: String","type":"property"},{"title":"Default Implementations","type":"groupMarker"},{"children":[{"title":"Initializers","type":"groupMarker"},{"path":"\/documentation\/auth0\/passkeyenrollmentchallenge\/init(from:)","title":"init(from: Decoder) throws","type":"init"}],"path":"\/documentation\/auth0\/passkeyenrollmentchallenge\/decodable-implementations","title":"Decodable Implementations","type":"symbol"}],"path":"\/documentation\/auth0\/passkeyenrollmentchallenge","title":"PasskeyEnrollmentChallenge","type":"struct"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/passkeyloginchallenge\/authenticationsession","title":"let authenticationSession: String","type":"property"},{"path":"\/documentation\/auth0\/passkeyloginchallenge\/challengedata","title":"let challengeData: Data","type":"property"},{"path":"\/documentation\/auth0\/passkeyloginchallenge\/relyingpartyid","title":"let relyingPartyId: String","type":"property"},{"title":"Default Implementations","type":"groupMarker"},{"children":[{"title":"Initializers","type":"groupMarker"},{"path":"\/documentation\/auth0\/passkeyloginchallenge\/init(from:)","title":"init(from: Decoder) throws","type":"init"}],"path":"\/documentation\/auth0\/passkeyloginchallenge\/decodable-implementations","title":"Decodable Implementations","type":"symbol"}],"path":"\/documentation\/auth0\/passkeyloginchallenge","title":"PasskeyLoginChallenge","type":"struct"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/passkeysignupchallenge\/authenticationsession","title":"let authenticationSession: String","type":"property"},{"path":"\/documentation\/auth0\/passkeysignupchallenge\/challengedata","title":"let challengeData: Data","type":"property"},{"path":"\/documentation\/auth0\/passkeysignupchallenge\/relyingpartyid","title":"let relyingPartyId: String","type":"property"},{"path":"\/documentation\/auth0\/passkeysignupchallenge\/userid","title":"let userId: Data","type":"property"},{"path":"\/documentation\/auth0\/passkeysignupchallenge\/username","title":"let userName: String","type":"property"},{"title":"Default Implementations","type":"groupMarker"},{"children":[{"title":"Initializers","type":"groupMarker"},{"path":"\/documentation\/auth0\/passkeysignupchallenge\/init(from:)","title":"init(from: Decoder) throws","type":"init"}],"path":"\/documentation\/auth0\/passkeysignupchallenge\/decodable-implementations","title":"Decodable Implementations","type":"symbol"}],"path":"\/documentation\/auth0\/passkeysignupchallenge","title":"PasskeySignupChallenge","type":"struct"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/phoneenrollmentchallenge\/authenticationid","title":"let authenticationId: String","type":"property"},{"path":"\/documentation\/auth0\/phoneenrollmentchallenge\/authenticationsession","title":"let authenticationSession: String","type":"property"},{"title":"Default Implementations","type":"groupMarker"},{"children":[{"title":"Initializers","type":"groupMarker"},{"path":"\/documentation\/auth0\/phoneenrollmentchallenge\/init(from:)","title":"init(from: Decoder) throws","type":"init"}],"path":"\/documentation\/auth0\/phoneenrollmentchallenge\/decodable-implementations","title":"Decodable Implementations","type":"symbol"}],"path":"\/documentation\/auth0\/phoneenrollmentchallenge","title":"PhoneEnrollmentChallenge","type":"struct"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/pushenrollmentchallenge\/authenticationid","title":"let authenticationId: String","type":"property"},{"path":"\/documentation\/auth0\/pushenrollmentchallenge\/authenticationsession","title":"let authenticationSession: String","type":"property"},{"path":"\/documentation\/auth0\/pushenrollmentchallenge\/authenticatormanualinputcode","title":"let authenticatorManualInputCode: String?","type":"property"},{"path":"\/documentation\/auth0\/pushenrollmentchallenge\/authenticatorqrcodeuri","title":"let authenticatorQRCodeURI: String","type":"property"},{"title":"Default Implementations","type":"groupMarker"},{"children":[{"title":"Initializers","type":"groupMarker"},{"path":"\/documentation\/auth0\/pushenrollmentchallenge\/init(from:)","title":"init(from: Decoder) throws","type":"init"}],"path":"\/documentation\/auth0\/pushenrollmentchallenge\/decodable-implementations","title":"Decodable Implementations","type":"symbol"}],"path":"\/documentation\/auth0\/pushenrollmentchallenge","title":"PushEnrollmentChallenge","type":"struct"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/recoverycodeenrollmentchallenge\/authenticationid","title":"let authenticationId: String","type":"property"},{"path":"\/documentation\/auth0\/recoverycodeenrollmentchallenge\/authenticationsession","title":"let authenticationSession: String","type":"property"},{"path":"\/documentation\/auth0\/recoverycodeenrollmentchallenge\/recoverycode","title":"let recoveryCode: String","type":"property"},{"title":"Default Implementations","type":"groupMarker"},{"children":[{"title":"Initializers","type":"groupMarker"},{"path":"\/documentation\/auth0\/recoverycodeenrollmentchallenge\/init(from:)","title":"init(from: Decoder) throws","type":"init"}],"path":"\/documentation\/auth0\/recoverycodeenrollmentchallenge\/decodable-implementations","title":"Decodable Implementations","type":"symbol"}],"path":"\/documentation\/auth0\/recoverycodeenrollmentchallenge","title":"RecoveryCodeEnrollmentChallenge","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\/ssocredentials\/init(sessiontransfertoken:issuedtokentype:expiresin:idtoken:refreshtoken:)","title":"init(sessionTransferToken: String, issuedTokenType: String, expiresIn: Date, idToken: String, refreshToken: String?)","type":"init"},{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/ssocredentials\/description","title":"var description: String","type":"property"},{"path":"\/documentation\/auth0\/ssocredentials\/expiresin","title":"let expiresIn: Date","type":"property"},{"path":"\/documentation\/auth0\/ssocredentials\/idtoken","title":"let idToken: String","type":"property"},{"path":"\/documentation\/auth0\/ssocredentials\/issuedtokentype","title":"let issuedTokenType: String","type":"property"},{"path":"\/documentation\/auth0\/ssocredentials\/refreshtoken","title":"let refreshToken: String?","type":"property"},{"path":"\/documentation\/auth0\/ssocredentials\/sessiontransfertoken","title":"let sessionTransferToken: String","type":"property"},{"title":"Default Implementations","type":"groupMarker"},{"children":[{"title":"Initializers","type":"groupMarker"},{"path":"\/documentation\/auth0\/ssocredentials\/init(from:)","title":"init(from: Decoder) throws","type":"init"}],"path":"\/documentation\/auth0\/ssocredentials\/decodable-implementations","title":"Decodable Implementations","type":"symbol"},{"children":[{"title":"Instance Methods","type":"groupMarker"},{"path":"\/documentation\/auth0\/ssocredentials\/encode(to:)","title":"func encode(to: Encoder) throws","type":"method"}],"path":"\/documentation\/auth0\/ssocredentials\/encodable-implementations","title":"Encodable Implementations","type":"symbol"}],"path":"\/documentation\/auth0\/ssocredentials","title":"SSOCredentials","type":"struct"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/totpenrollmentchallenge\/authenticationid","title":"let authenticationId: String","type":"property"},{"path":"\/documentation\/auth0\/totpenrollmentchallenge\/authenticationsession","title":"let authenticationSession: String","type":"property"},{"path":"\/documentation\/auth0\/totpenrollmentchallenge\/authenticatormanualinputcode","title":"let authenticatorManualInputCode: String?","type":"property"},{"path":"\/documentation\/auth0\/totpenrollmentchallenge\/authenticatorqrcodeuri","title":"let authenticatorQRCodeURI: String","type":"property"},{"title":"Default Implementations","type":"groupMarker"},{"children":[{"title":"Initializers","type":"groupMarker"},{"path":"\/documentation\/auth0\/totpenrollmentchallenge\/init(from:)","title":"init(from: Decoder) throws","type":"init"}],"path":"\/documentation\/auth0\/totpenrollmentchallenge\/decodable-implementations","title":"Decodable Implementations","type":"symbol"}],"path":"\/documentation\/auth0\/totpenrollmentchallenge","title":"TOTPEnrollmentChallenge","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":"Initializers","type":"groupMarker"},{"path":"\/documentation\/auth0\/userinfo\/init(json:)","title":"init?(json: [String : Any])","type":"init"},{"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"}],"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"},{"path":"\/documentation\/auth0\/webautherror\/message","title":"var message: String","type":"property"},{"title":"Type Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/webautherror\/idtokenvalidationfailed","title":"static let idTokenValidationFailed: WebAuthError","type":"property"},{"path":"\/documentation\/auth0\/webautherror\/invalidinvitationurl","title":"static let invalidInvitationURL: WebAuthError","type":"property"},{"path":"\/documentation\/auth0\/webautherror\/noauthorizationcode","title":"static let noAuthorizationCode: WebAuthError","type":"property"},{"path":"\/documentation\/auth0\/webautherror\/nobundleidentifier","title":"static let noBundleIdentifier: WebAuthError","type":"property"},{"path":"\/documentation\/auth0\/webautherror\/other","title":"static let other: WebAuthError","type":"property"},{"path":"\/documentation\/auth0\/webautherror\/pkcenotallowed","title":"static let pkceNotAllowed: WebAuthError","type":"property"},{"path":"\/documentation\/auth0\/webautherror\/transactionactivealready","title":"static let transactionActiveAlready: WebAuthError","type":"property"},{"path":"\/documentation\/auth0\/webautherror\/unknown","title":"static let unknown: WebAuthError","type":"property"},{"path":"\/documentation\/auth0\/webautherror\/usercancelled","title":"static let userCancelled: WebAuthError","type":"property"},{"title":"Default Implementations","type":"groupMarker"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/webautherror\/errordescription","title":"var errorDescription: String?","type":"property"},{"path":"\/documentation\/auth0\/webautherror\/localizeddescription","title":"var localizedDescription: String","type":"property"}],"path":"\/documentation\/auth0\/webautherror\/auth0error-implementations","title":"Auth0Error Implementations","type":"symbol"},{"children":[{"title":"Operators","type":"groupMarker"},{"path":"\/documentation\/auth0\/webautherror\/!=(_:_:)","title":"static func != (Self, Self) -> Bool","type":"op"},{"path":"\/documentation\/auth0\/webautherror\/==(_:_:)","title":"static func == (WebAuthError, WebAuthError) -> Bool","type":"op"}],"path":"\/documentation\/auth0\/webautherror\/equatable-implementations","title":"Equatable Implementations","type":"symbol"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/webautherror\/failurereason","title":"var failureReason: String?","type":"property"},{"path":"\/documentation\/auth0\/webautherror\/helpanchor","title":"var helpAnchor: String?","type":"property"},{"path":"\/documentation\/auth0\/webautherror\/recoverysuggestion","title":"var recoverySuggestion: String?","type":"property"}],"path":"\/documentation\/auth0\/webautherror\/localizederror-implementations","title":"LocalizedError Implementations","type":"symbol"}],"path":"\/documentation\/auth0\/webautherror","title":"WebAuthError","type":"struct"},{"children":[{"title":"Type Methods","type":"groupMarker"},{"path":"\/documentation\/auth0\/webauthentication\/cancel()","title":"static func cancel()","type":"method"},{"path":"\/documentation\/auth0\/webauthentication\/resume(with:)","title":"static func resume(with: URL) -> Bool","type":"method"},{"path":"\/documentation\/auth0\/webauthentication\/safariprovider(style:)","title":"static func safariProvider(style: UIModalPresentationStyle) -> WebAuthProvider","type":"method"},{"path":"\/documentation\/auth0\/webauthentication\/webviewprovider(style:)","title":"static func webViewProvider(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\/myaccount(token:domain:session:)","title":"func myAccount(token: String, domain: String, session: URLSession) -> MyAccount","type":"func"},{"path":"\/documentation\/auth0\/myaccount(token:session:bundle:)","title":"func myAccount(token: String, session: URLSession, bundle: Bundle) -> MyAccount","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\/myaccountresult","title":"MyAccountResult","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\/biometricpolicy\/always","title":"case always","type":"case"},{"path":"\/documentation\/auth0\/biometricpolicy\/applifecycle(timeoutinseconds:)","title":"case appLifecycle(timeoutInSeconds: Int)","type":"case"},{"path":"\/documentation\/auth0\/biometricpolicy\/default","title":"case `default`","type":"case"},{"path":"\/documentation\/auth0\/biometricpolicy\/session(timeoutinseconds:)","title":"case session(timeoutInSeconds: Int)","type":"case"}],"path":"\/documentation\/auth0\/biometricpolicy","title":"BiometricPolicy","type":"enum"},{"children":[{"title":"Enumeration Cases","type":"groupMarker"},{"path":"\/documentation\/auth0\/passkeydevicetype\/multidevice","title":"case multiDevice","type":"case"},{"path":"\/documentation\/auth0\/passkeydevicetype\/singledevice","title":"case singleDevice","type":"case"},{"title":"Initializers","type":"groupMarker"},{"path":"\/documentation\/auth0\/passkeydevicetype\/init(rawvalue:)","title":"init?(rawValue: String)","type":"init"},{"title":"Default Implementations","type":"groupMarker"},{"children":[{"title":"Operators","type":"groupMarker"},{"path":"\/documentation\/auth0\/passkeydevicetype\/!=(_:_:)","title":"static func != (Self, Self) -> Bool","type":"op"}],"path":"\/documentation\/auth0\/passkeydevicetype\/equatable-implementations","title":"Equatable Implementations","type":"symbol"},{"children":[{"title":"Initializers","type":"groupMarker"},{"path":"\/documentation\/auth0\/passkeydevicetype\/init(from:)","title":"init(from: any Decoder) throws","type":"init"},{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/passkeydevicetype\/hashvalue","title":"var hashValue: Int","type":"property"},{"title":"Instance Methods","type":"groupMarker"},{"path":"\/documentation\/auth0\/passkeydevicetype\/hash(into:)","title":"func hash(into: inout Hasher)","type":"method"}],"path":"\/documentation\/auth0\/passkeydevicetype\/rawrepresentable-implementations","title":"RawRepresentable Implementations","type":"symbol"}],"path":"\/documentation\/auth0\/passkeydevicetype","title":"PasskeyDeviceType","type":"enum"},{"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"},{"children":[{"title":"Enumeration Cases","type":"groupMarker"},{"path":"\/documentation\/auth0\/preferredauthenticationmethod\/sms","title":"case sms","type":"case"},{"path":"\/documentation\/auth0\/preferredauthenticationmethod\/voice","title":"case voice","type":"case"},{"title":"Initializers","type":"groupMarker"},{"path":"\/documentation\/auth0\/preferredauthenticationmethod\/init(rawvalue:)","title":"init?(rawValue: String)","type":"init"},{"title":"Default Implementations","type":"groupMarker"},{"children":[{"title":"Operators","type":"groupMarker"},{"path":"\/documentation\/auth0\/preferredauthenticationmethod\/!=(_:_:)","title":"static func != (Self, Self) -> Bool","type":"op"}],"path":"\/documentation\/auth0\/preferredauthenticationmethod\/equatable-implementations","title":"Equatable Implementations","type":"symbol"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/preferredauthenticationmethod\/hashvalue","title":"var hashValue: Int","type":"property"},{"title":"Instance Methods","type":"groupMarker"},{"path":"\/documentation\/auth0\/preferredauthenticationmethod\/hash(into:)","title":"func hash(into: inout Hasher)","type":"method"}],"path":"\/documentation\/auth0\/preferredauthenticationmethod\/rawrepresentable-implementations","title":"RawRepresentable Implementations","type":"symbol"}],"path":"\/documentation\/auth0\/preferredauthenticationmethod","title":"PreferredAuthenticationMethod","type":"enum"},{"title":"Extended Modules","type":"groupMarker"},{"children":[{"title":"Extended Enumerations","type":"groupMarker"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/authenticationservices\/asauthorizationpublickeycredentialattachment\/stringvalue","title":"var stringValue: String?","type":"property"}],"path":"\/documentation\/auth0\/authenticationservices\/asauthorizationpublickeycredentialattachment","title":"ASAuthorizationPublicKeyCredentialAttachment","type":"extension"}],"path":"\/documentation\/auth0\/authenticationservices","title":"AuthenticationServices","type":"extension"},{"children":[{"title":"Extended Types","type":"groupMarker"},{"children":[{"title":"Extended Types","type":"groupMarker"},{"children":[{"title":"Extended Structures","type":"groupMarker"},{"children":[{"title":"Default Implementations","type":"groupMarker"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/cryptokit\/p256\/signing\/privatekey\/description","title":"var description: String","type":"property"}],"path":"\/documentation\/auth0\/cryptokit\/p256\/signing\/privatekey\/customstringconvertible-implementations","title":"CustomStringConvertible Implementations","type":"symbol"}],"path":"\/documentation\/auth0\/cryptokit\/p256\/signing\/privatekey","title":"P256.Signing.PrivateKey","type":"extension"}],"path":"\/documentation\/auth0\/cryptokit\/p256\/signing","title":"P256.Signing","type":"extension"}],"path":"\/documentation\/auth0\/cryptokit\/p256","title":"P256","type":"extension"},{"children":[{"title":"Extended Types","type":"groupMarker"},{"children":[{"title":"Extended Types","type":"groupMarker"},{"children":[{"title":"Extended Structures","type":"groupMarker"},{"children":[{"title":"Default Implementations","type":"groupMarker"},{"children":[{"title":"Instance Properties","type":"groupMarker"},{"path":"\/documentation\/auth0\/cryptokit\/secureenclave\/p256\/signing\/privatekey\/description","title":"var description: String","type":"property"}],"path":"\/documentation\/auth0\/cryptokit\/secureenclave\/p256\/signing\/privatekey\/customstringconvertible-implementations","title":"CustomStringConvertible Implementations","type":"symbol"}],"path":"\/documentation\/auth0\/cryptokit\/secureenclave\/p256\/signing\/privatekey","title":"SecureEnclave.P256.Signing.PrivateKey","type":"extension"}],"path":"\/documentation\/auth0\/cryptokit\/secureenclave\/p256\/signing","title":"SecureEnclave.P256.Signing","type":"extension"}],"path":"\/documentation\/auth0\/cryptokit\/secureenclave\/p256","title":"SecureEnclave.P256","type":"extension"}],"path":"\/documentation\/auth0\/cryptokit\/secureenclave","title":"SecureEnclave","type":"extension"}],"path":"\/documentation\/auth0\/cryptokit","title":"CryptoKit","type":"extension"},{"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":2}} \ No newline at end of file diff --git a/docs/index/navigator.index b/docs/index/navigator.index index d98cbc1e6..d67f74831 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 13cc71e97..e875ca7d9 100644 --- a/docs/metadata.json +++ b/docs/metadata.json @@ -1 +1 @@ -{"bundleID":"com.auth0.Auth0","schemaVersion":{"minor":1,"major":0,"patch":0},"bundleDisplayName":"Auth0"} \ No newline at end of file +{"bundleID":"com.auth0.Auth0","schemaVersion":{"major":0,"minor":1,"patch":0},"bundleDisplayName":"Auth0"} \ No newline at end of file